VPIParallelForConfig Struct Reference

#include <vpi/Types.h>

Collaboration diagram for VPIParallelForConfig:

Data Fields
int	maxThreads
	The maximum number of threads used by the parallel_for implementation code. More...
VPIParallelForCallback	callback
	A pointer to the parallel_for implementation. More...
void *	userData
	A user defined opaque pointer passed to callback function unaltered.

Detailed Description

Stores the ParallelFor configuration.

Definition at line 96 of file Types.h.

Field Documentation

callback

VPIParallelForCallback VPIParallelForConfig::callback

A pointer to the parallel_for implementation.

If null is passed the context will fallback to the default internal parallel_for implementation. parallel_for implementation is required to be thread-safe. Internal API implementation might call this function from different threads at the same time.

Definition at line 111 of file Types.h.

maxThreads

int VPIParallelForConfig::maxThreads

The maximum number of threads used by the parallel_for implementation code.

Has to be larger than 0. Setting the number to N means that the parallel for implementation will call task functors with task id between 0 and N-1. Calling task functors with thread id outside of this range is not legal and will result in undefined behavior.

Definition at line 104 of file Types.h.

---

The documentation for this struct was generated from the following file:

• vpi/Types.h