VTK
9.0.20210409

A set of parallel (multithreaded) utility functions. More...
#include <vtkSMPTools.h>
Static Public Member Functions  
template<typename Functor >  
static void  For (vtkIdType first, vtkIdType last, vtkIdType grain, Functor &f) 
Execute a for operation in parallel. More...  
template<typename Functor >  
static void  For (vtkIdType first, vtkIdType last, vtkIdType grain, Functor const &f) 
Execute a for operation in parallel. More...  
template<typename Functor >  
static void  For (vtkIdType first, vtkIdType last, Functor &f) 
Execute a for operation in parallel. More...  
template<typename Functor >  
static void  For (vtkIdType first, vtkIdType last, Functor const &f) 
Execute a for operation in parallel. More...  
static const char *  GetBackend () 
Get the backend in use. More...  
static void  Initialize (int numThreads=0) 
Initialize the underlying libraries for execution. More...  
static int  GetEstimatedNumberOfThreads () 
Get the estimated number of threads being used by the backend. More...  
template<typename InputIt , typename OutputIt , typename Functor >  
static void  Transform (InputIt inBegin, InputIt inEnd, OutputIt outBegin, Functor transform) 
A convenience method for transforming data. More...  
template<typename Iterator , typename T >  
static void  Fill (Iterator begin, Iterator end, const T &value) 
A convenience method for filling data. More...  
template<typename RandomAccessIterator >  
static void  Sort (RandomAccessIterator begin, RandomAccessIterator end) 
A convenience method for sorting data. More...  
template<typename RandomAccessIterator , typename Compare >  
static void  Sort (RandomAccessIterator begin, RandomAccessIterator end, Compare comp) 
A convenience method for sorting data. More...  
A set of parallel (multithreaded) utility functions.
vtkSMPTools provides a set of utility functions that can be used to parallelize parts of VTK code using multiple threads. There are several backend implementations of parallel functionality (currently Sequential, TBB and XKaapi) that actual execution is delegated to.
Definition at line 153 of file vtkSMPTools.h.

inlinestatic 
Execute a for operation in parallel.
First and last define the range over which to operate (which is defined by the operator). The operation executed is defined by operator() of the functor object. The grain gives the parallel engine a hint about the coarseness over which to parallelize the function (as defined by lastfirst of each execution of operator() ).
Definition at line 167 of file vtkSMPTools.h.

inlinestatic 
Execute a for operation in parallel.
First and last define the range over which to operate (which is defined by the operator). The operation executed is defined by operator() of the functor object. The grain gives the parallel engine a hint about the coarseness over which to parallelize the function (as defined by lastfirst of each execution of operator() ).
Definition at line 185 of file vtkSMPTools.h.

inlinestatic 
Execute a for operation in parallel.
First and last define the range over which to operate (which is defined by the operator). The operation executed is defined by operator() of the functor object. The grain gives the parallel engine a hint about the coarseness over which to parallelize the function (as defined by lastfirst of each execution of operator() ). Uses a default value for the grain.
Definition at line 202 of file vtkSMPTools.h.

inlinestatic 
Execute a for operation in parallel.
First and last define the range over which to operate (which is defined by the operator). The operation executed is defined by operator() of the functor object. The grain gives the parallel engine a hint about the coarseness over which to parallelize the function (as defined by lastfirst of each execution of operator() ). Uses a default value for the grain.
Definition at line 217 of file vtkSMPTools.h.

static 
Get the backend in use.

static 
Initialize the underlying libraries for execution.
This is not required as it is automatically called before the first execution of any parallel code. However, it can be used to control the maximum number of threads used. Make sure to call it before the parallel operation.

static 
Get the estimated number of threads being used by the backend.
This should be used as just an estimate since the number of threads may vary dynamically and a particular task may not be executed on all the available threads.

inlinestatic 
A convenience method for transforming data.
It is a drop in replacement for std::transform(), it does a binary operation on the input ranges. The data array must have the same length. The performed transformation is defined by operator() of the functor object.
Usage example with vtkDataArray:
Please visit vtkDataArrayRange.h documentation for more information and optimisation.
Definition at line 260 of file vtkSMPTools.h.

inlinestatic 
A convenience method for filling data.
It is a drop in replacement for std::fill(), it assign the given value to the element in ranges.
Usage example with vtkDataArray:
Please visit vtkDataArrayRange.h documentation for more information and optimisation.
Definition at line 280 of file vtkSMPTools.h.

inlinestatic 
A convenience method for sorting data.
It is a drop in replacement for std::sort(). Under the hood different methods are used. For example, tbb::parallel_sort is used in TBB.
Definition at line 291 of file vtkSMPTools.h.

inlinestatic 
A convenience method for sorting data.
It is a drop in replacement for std::sort(). Under the hood different methods are used. For example, tbb::parallel_sort is used in TBB. This version of Sort() takes a comparison class.
Definition at line 303 of file vtkSMPTools.h.