#include <parallelfor.h>

Detailed Description

This class contains of several methods that implement a for loop which is distributing the work load on multiple threads. You can choose between static or dynamic distribution and optionally specify objects to initialize and finalize per worker thread data.

Classes
class	BaseContext

struct	BreakCondition

class	BreakContext

struct	DefaultGranularity

class	Dummy

struct	DynamicContext

class	DynamicJob

struct	ForAlignedContext

struct	ForAlignedContext< FORCONTEXT, INDEXTYPE, Dummy, Dummy >

struct	ForState

struct	Granularity

class	InvokeSelector

struct	MinimumGranularity

class	NoBreakContext

class	NoContext

class	NoContextSelector

class	NoContextWithResult

class	NoContextWithResultSelector

class	ParallelForJob

class	SingleThreadedFinalize

class	SingleThreadedFinalize< WORKER, false >

struct	StaticContext

class	StaticJob

struct	ThreadingDisabled

Static Public Member Functions
template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static auto	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0) -> decltype(obj(to))

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static auto	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0) -> decltype(obj(to))

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, const Granularity &granularity=Granularity(), JobQueueInterface queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type	Static (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Static (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, const Granularity &granularity=Granularity(), JobQueueInterface *queue=JOBQUEUE_CURRENT, Int deprecatedThrCnt=0)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static auto	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT) -> decltype(obj(to))

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobStatusInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobStatusInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Dynamic (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, JobInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static auto	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, Int threadCnt, const Int minChunkSize=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT) -> decltype(obj(to))

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, Int threadCnt, const Int minChunkSize=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobInterface observeForCancellation, Int threadCnt, const Int minChunkSize=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP >
static MAXON_ATTRIBUTE_NO_INLINE Result< void >	Static (FROMTYPE from, INDEXTYPE to, const LOOP &obj, JobStatusInterface observeForCancellation, Int threadCnt, const Int granularity=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type	Static (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, Int threadCnt, const Int minChunkSize=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

template<typename CONTEXT , PARALLELFORFLAGS FLAGS, typename FROMTYPE , typename INDEXTYPE , typename LOOP , typename INIT , typename FINALIZE >
static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType	Static (FROMTYPE from, INDEXTYPE to, const INIT &init, const LOOP &obj, const FINALIZE &finalize, Int threadCnt, const Int minChunkSize=PARALLELFOR_DEFAULTGRANULARITY, JobQueueInterface *queue=JOBQUEUE_CURRENT)

Static Private Member Functions
template<typename INDEXTYPE >
static INDEXTYPE	CalculateStaticChunkSize (UInt cnt, Int &threadCnt, Int minChunkSize)

Member Function Documentation

◆ Dynamic() [1/20]

static auto Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)		-> decltype(obj(to))

static

Runs a parallelized for (i = from; i < to; i++) loop using dynamic distribution.

ParallelFor::Dynamic(from, to,
  [](Int i)
  {
    // ... do something ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	granularity	The number of iterations after which a thread shares work with idle threads (1 means best distribution at the cost of higher synchronization, PARALLELFOR_DEFAULTGRANULARITY is the default).
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE) used for the loop.

Returns: Depending on the type of #LOOP either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Dynamic() [2/20]

static Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Dynamic() [3/20]

static Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Dynamic() [4/20]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using dynamic distribution.

ParallelFor::Dynamic<ParallelFor::BreakContext>(from, to,
  [&shouldWeBreak](Int i, ParallelFor::BreakContext& context)
  {
    // ... example for a break condition ...
    if (shouldWeBreak)
    {
      // tell ParallelFor that it should cancel the loop and return from the closure
      context.Break();
      return;
    }
    // ... do something ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	granularity	The number of iterations after which a thread shares work with idle threads (1 means best distribution at the cost of higher synchronization, PARALLELFOR_DEFAULTGRANULARITY is the default).
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE, CONTEXT&) used for the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Dynamic() [5/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Dynamic() [6/20]

static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using dynamic distribution. The init method is called concurrently per worker thread whereas the finalize method is called synchronously (no concurrency) after the loop has finished.

struct MyContext : public ParallelFor::BaseContext
{
  // your thread local data ...
};
ParallelFor::Dynamic<MyContext>(from, to,
  [](MyContext& context)
  {
    // ... init thread local data ...
  },
  [](Int i, MyContext& context)
  {
    // ... computation in the loop body ...
  },
  [](MyContext& context)
  {
    // ... finalize thread local data ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	init	Lambda being called before the loop starts (threaded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	finalize	Lambda being called after the loop has finished (synchronous)
[in]	granularity	The number of iterations after which a thread shares work with idle threads (1 means best distribution at the cost of higher synchronization, PARALLELFOR_DEFAULTGRANULARITY is the default).
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext for thread local data storage.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE, CONTEXT&) used for the loop.
INIT	A class containing an operator ()(CONTEXT&) for per-thread initialization before the loop.
FINALIZE	A class containing an operator ()(CONTEXT&) for per-thread cleanup after the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Dynamic() [7/20]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using dynamic distribution. The FLAGS template parameter can be used to specify if the init or finalize closure are called serialized or threaded.

struct MyContext : public ParallelFor::BaseContext
{
  // your thread local data ...
};
ParallelFor::Dynamic<MyContext, PARALLELFORFLAGS::INITTHREADED_FINALIZESYNC>(from, to,
  [](MyContext& context)
  {
    // ... init thread local data ...
  },
  [](Int i, MyContext& context)
  {
    // ... computation in the loop body ...
  },
  [](MyContext& context)
  {
    // ... finalize thread local data ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	init	Lambda being called before the loop starts (threaded by default)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	finalize	Lambda being called after the loop has finished (synchronous by default)
[in]	granularity	The number of iterations after which a thread shares work with idle threads (1 means best distribution at the cost of higher synchronization, PARALLELFOR_DEFAULTGRANULARITY is the default).
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext for thread local data storage.
FLAGS	Flags that specify whether init or finalize will be called threaded or synchronously.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE, CONTEXT&) used for the loop.
INIT	A class containing an operator ()(CONTEXT&) for per-thread initialization before the loop.
FINALIZE	A class containing an operator ()(CONTEXT&) for per-thread cleanup after the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Dynamic() [8/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Template Parameters

CONTEXT A class derived from ParallelFor::BreakContext for thread local data storage.

◆ Dynamic() [9/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Dynamic() [10/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Static() [1/14]

static auto Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)		-> decltype(obj(to))

static

Runs a parallelized for (i = from; i < to; i++) loop using static distribution.

ParallelFor::Static(from, to,
  [](Int i)
  {
    // ... do something ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	granularity	Minimum number of loops that one thread should handle (default is PARALLELFOR_DEFAULTGRANULARITY)
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE) used for the loop.

Returns: Depending on the type of #LOOP either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Static() [2/14]

static Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Static() [3/14]

static Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Static() [4/14]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using static distribution.

ParallelFor::Static<ParallelFor::BreakContext>(from, to,
  [&shouldWeBreak](Int i, ParallelFor::BreakContext& context)
  {
    // ... example for a break condition ...
    if (shouldWeBreak)
    {
      // tell ParallelFor that it should cancel the loop and return from the closure
      context.Break();
      return;
    }
    // ... do something ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	granularity	Minimum number of loops that one thread should handle (default is PARALLELFOR_DEFAULTGRANULARITY)
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE) used for the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Static() [5/14]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

◆ Static() [6/14]

static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using static distribution. The init method is called concurrently per worker thread whereas the finalize method is called synchronously (no concurrency) after the loop has finished.

struct MyContext : public ParallelFor::BaseContext
{
  // your thread local data ...
};
ParallelFor::Static<MyContext>(from, to,
  [](MyContext& context)
  {
    // ... init thread local data ...
  },
  [](Int i, MyContext& context)
  {
    // ... computation in the loop body ...
  },
  [](MyContext& context)
  {
    // ... finalize thread local data ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	init	Lambda being called before the loop starts (threaded)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	finalize	Lambda being called after the loop has finished (synchronously)
[in]	granularity	Minimum number of loops that one thread should handle (default is PARALLELFOR_DEFAULTGRANULARITY)
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext for thread local data storage.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE, CONTEXT&) used for the loop.
INIT	A class containing an operator ()(CONTEXT&) for per-thread initialization before the loop.
FINALIZE	A class containing an operator ()(CONTEXT&) for per-thread cleanup after the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Static() [7/14]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		const Granularity &	granularity = `Granularity()`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`,
		Int	deprecatedThrCnt = `0`
	)

static

Runs a parallelized for (i = from; i < to; i++) loop using static distribution. The FLAGS template parameter can be used to specify if the init or finalize closure are called serialized or threaded.

struct MyContext : public ParallelFor::BaseContext
{
  // your thread local data ...
};
ParallelFor::Dynamic<MyContext, PARALLELFORFLAGS::INITTHREADED_FINALIZESYNC>(from, to,
  [](MyContext& context)
  {
    // ... init thread local data ...
  },
  [](Int i, MyContext& context)
  {
    // ... computation in the loop body ...
  },
  [](MyContext& context)
  {
    // ... finalize thread local data ...
  });

Parameters

[in]	from	Start index.
[in]	to	End index (excluded)
[in]	init	Lambda being called before the loop starts (threaded by default)
[in]	obj	Lambda or object with operator (), object will be referenced.
[in]	finalize	Lambda being called after the loop has finished (synchronously by default)
[in]	granularity	Minimum number of loops that one thread should handle (default is PARALLELFOR_DEFAULTGRANULARITY)
[in]	queue	Optional queue that the parallel for is executed within.
[in]	deprecatedThrCnt	Don't use and tweak granularity instead (you might have to set it to 1 if you want one iteration per worker thread)!

Template Parameters

CONTEXT	A class derived from ParallelFor::BaseContext for thread local data storage.
FLAGS	Flags that specify whether init or finalize will be called threaded or synchronously.
FROMTYPE	An integral type used for the from variable, might be different than INDEXTYPE but is not allowed to have a bigger range.
INDEXTYPE	An integral type used for the index of the loop.
LOOP	A class containing an operator ()(INDEXTYPE, CONTEXT&) used for the loop.
INIT	A class containing an operator ()(CONTEXT&) for per-thread initialization before the loop.
FINALIZE	A class containing an operator ()(CONTEXT&) for per-thread cleanup after the loop.

Returns: Depending on the type of #LOOP and #CONTEXT either void or Result<void> (OK on success. Will only return an error if your loop object returns one). Any errors will be returned as an AggregatedError which you can iterate to check for individual errors.

◆ Dynamic() [11/20]

static auto Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)		-> decltype(obj(to))

static

◆ Dynamic() [12/20]

static Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [13/20]

static Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [14/20]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [15/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [16/20]

static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [17/20]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [18/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [19/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Dynamic() [20/20]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Dynamic	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		JobInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [8/14]

static auto Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		Int	threadCnt,
		const Int	minChunkSize = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)		-> decltype(obj(to))

static

◆ Static() [9/14]

static Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	minChunkSize = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [10/14]

static Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	minChunkSize = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [11/14]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [12/14]

static MAXON_ATTRIBUTE_NO_INLINE Result<void> Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const LOOP &	obj,
		JobStatusInterface *	observeForCancellation,
		Int	threadCnt,
		const Int	granularity = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [13/14]

static std::enable_if<!STD_IS_REPLACEMENT(convertible, typename std::remove_reference< LOOP >::type, maxon::ParallelFor::Granularity), typename CONTEXT::ResultValueType >::type Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		Int	threadCnt,
		const Int	minChunkSize = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ Static() [14/14]

static MAXON_ATTRIBUTE_NO_INLINE CONTEXT::ResultValueType Static	(	FROMTYPE	from,
		INDEXTYPE	to,
		const INIT &	init,
		const LOOP &	obj,
		const FINALIZE &	finalize,
		Int	threadCnt,
		const Int	minChunkSize = `PARALLELFOR_DEFAULTGRANULARITY`,
		JobQueueInterface *	queue = `JOBQUEUE_CURRENT`
	)

static

◆ CalculateStaticChunkSize()

static INDEXTYPE CalculateStaticChunkSize	(	UInt	cnt,
		Int &	threadCnt,
		Int	minChunkSize
	)

staticprivate

Computes chunk size for static distribution. If only one thread is used, the index is signed and the range of the loop requires an unsigned counter the return value will overflow, but the loops that assign the chunks to the jobs take care of this.

Parameters

[in]	cnt	Number of iterations.
[in,out]	threadCnt	Number of threads to use.
[in]	minChunkSize	Minimum chunk size.

Template Parameters

INDEXTYPE An integral type used for the index of the loop.

Returns: Size of a chunk.

Detailed Description

Classes

Static Public Member Functions

Static Private Member Functions

Member Function Documentation

◆ Dynamic() [1/20]

◆ Dynamic() [2/20]

◆ Dynamic() [3/20]

◆ Dynamic() [4/20]

◆ Dynamic() [5/20]

◆ Dynamic() [6/20]

◆ Dynamic() [7/20]

◆ Dynamic() [8/20]

◆ Dynamic() [9/20]

◆ Dynamic() [10/20]

◆ Static() [1/14]

◆ Static() [2/14]

◆ Static() [3/14]

◆ Static() [4/14]

◆ Static() [5/14]

◆ Static() [6/14]

◆ Static() [7/14]

◆ Dynamic() [11/20]

◆ Dynamic() [12/20]

◆ Dynamic() [13/20]

◆ Dynamic() [14/20]

◆ Dynamic() [15/20]

◆ Dynamic() [16/20]

◆ Dynamic() [17/20]

◆ Dynamic() [18/20]

◆ Dynamic() [19/20]

◆ Dynamic() [20/20]

◆ Static() [8/14]

◆ Static() [9/14]

◆ Static() [10/14]

◆ Static() [11/14]

◆ Static() [12/14]

◆ Static() [13/14]

◆ Static() [14/14]

◆ CalculateStaticChunkSize()