agi.foundation.infrastructure.threading

Interface ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter>

Type Parameters:

TParameter - The type of an instance that is passed to the body of the loop.

Enclosing class:

ThreadedCalculation.BodyCallbackWithProgress<TParameter>

@FunctionalInterface
public static interface ThreadedCalculation.BodyCallbackWithProgress.Function<TParameter>

A functional interface for the containing delegate type.

Method Summary

Modifier and Type	Method and Description
void	invoke(TParameter parameter, int i, ITrackCalculationProgress tracker) A delegate representing the body of a multithreaded 'for' loop, where each iteration of the loop intends to provide detailed information about its progress.

Method Detail

invoke

void invoke(TParameter parameter,
            int i,
            @Nullable
            ITrackCalculationProgress tracker)

A delegate representing the body of a multithreaded 'for' loop, where each iteration of the loop intends to provide detailed information about its progress. This is useful when the parallel loop has too few iterations to accurately compute progress as the number of completed iterations divided by the total number of iterations. The execution of the callback will see a ThreadingPolicy with only one thread unless it is explicitly set inside the callback.

Parameters:

parameter - A parameter that is passed to the body of the loop. If this instance implements IThreadAware and IsThreadSafe (get) returns false, a copy of the parameter is made for each thread using CopyForAnotherThread.

i - The index to evaluate.

tracker - The object to which progress is reported and that is able to cancel this operation before it is complete, or null.