Template Numerical Library version\ main:eacc201d
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
TNL::Algorithms::ParallelFor2D< Device > Struct Template Reference

Parallel for loop for two dimensional domain of indices. More...

#include <TNL/Algorithms/ParallelFor.h>

Static Public Member Functions

template<typename Index , typename Function , typename... FunctionArgs>
static void exec (Index startX, Index startY, Index endX, Index endY, Function f, FunctionArgs... args)
 Static method for the execution of the loop. More...
 
template<typename Index , typename Function , typename... FunctionArgs>
static void exec (Index startX, Index startY, Index endX, Index endY, typename Device::LaunchConfiguration launch_config, Function f, FunctionArgs... args)
 Overload with custom launch configuration (which is ignored for TNL::Devices::Sequential).
 

Detailed Description

template<typename Device = Devices::Sequential>
struct TNL::Algorithms::ParallelFor2D< Device >

Parallel for loop for two dimensional domain of indices.

Template Parameters
Devicespecifies the device where the for-loop will be executed. It can be TNL::Devices::Host, TNL::Devices::Cuda or TNL::Devices::Sequential.

Member Function Documentation

◆ exec()

template<typename Device = Devices::Sequential>
template<typename Index , typename Function , typename... FunctionArgs>
static void TNL::Algorithms::ParallelFor2D< Device >::exec ( Index  startX,
Index  startY,
Index  endX,
Index  endY,
Function  f,
FunctionArgs...  args 
)
inlinestatic

Static method for the execution of the loop.

Template Parameters
Indexis the type of the loop indices.
Functionis the type of the functor to be called in each iteration (it is usually deduced from the argument used in the function call).
FunctionArgsis a variadic pack of types for additional parameters that are forwarded to the functor in every iteration.
Parameters
startXthe for-loop iterates over index domain [startX,endX) x [startY,endY).
startYthe for-loop iterates over index domain [startX,endX) x [startY,endY).
endXthe for-loop iterates over index domain [startX,endX) x [startY,endY).
endYthe for-loop iterates over index domain [startX,endX) x [startY,endY).
fis the function to be called in each iteration
argsare additional parameters to be passed to the function f.

The function f is called for each iteration as

f( i, j, args... )

where the first parameter is changing more often than the second one.

Example
#include <iostream>
#include <TNL/Containers/Vector.h>
#include <TNL/Algorithms/ParallelFor.h>
using namespace TNL;
using namespace TNL::Containers;
using namespace TNL::Algorithms;
template< typename Device >
void initMeshFunction( const int xSize,
const int ySize,
const double& c )
{
auto view = v.getView();
auto init = [=] __cuda_callable__ ( int i, int j ) mutable
{
view[ j * xSize + i ] = c;
};
ParallelFor2D< Device >::exec( 0, 0, xSize, ySize, init );
}
int main( int argc, char* argv[] )
{
/***
* Define dimensions of 2D mesh function.
*/
const int xSize( 10 ), ySize( 10 );
const int size = xSize * ySize;
/***
* Firstly, test the mesh function initiation on CPU.
*/
initMeshFunction( xSize, ySize, host_v, 1.0 );
/***
* And then also on GPU.
*/
#ifdef HAVE_CUDA
initMeshFunction( xSize, ySize, cuda_v, 1.0 );
#endif
return EXIT_SUCCESS;
}
#define __cuda_callable__
Definition: CudaCallable.h:22
Vector extends Array with algebraic operations.
Definition: Vector.h:40
ViewType getView(IndexType begin=0, IndexType end=0)
Returns a modifiable view of the vector.
Definition: Vector.hpp:29
Namespace for fundamental TNL algorithms.
Definition: AtomicOperations.h:14
Namespace for TNL containers.
Definition: Array.h:21
The main TNL namespace.
Definition: AtomicOperations.h:13
static void exec(Index startX, Index startY, Index endX, Index endY, Function f, FunctionArgs... args)
Static method for the execution of the loop.
Definition: ParallelFor.h:130
Output

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