Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ParallelFor1DLoopInfo Class Reference

Characteristics of a multi-thread 1D loop. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/concurrency/arccore/concurrency/ParallelFor.h>

Collaboration diagram for Arcane::ParallelFor1DLoopInfo:

Public Types

using ThatClass = ParallelFor1DLoopInfo

Public Member Functions

 ParallelFor1DLoopInfo (Int32 begin, Int32 size, IRangeFunctor *functor)
 ParallelFor1DLoopInfo (Int32 begin, Int32 size, IRangeFunctor *functor, const ForLoopRunInfo &run_info)
 ParallelFor1DLoopInfo (Int32 begin, Int32 size, Int32 block_size, IRangeFunctor *functor)
Int32 beginIndex () const
Int32 size () const
IRangeFunctor * functor () const
ForLoopRunInfo & runInfo ()
const ForLoopRunInfo & runInfo () const

Private Attributes

ForLoopRunInfo m_run_info
Int32 m_begin = 0
Int32 m_size = 0
IRangeFunctor * m_functor = nullptr

Detailed Description

Characteristics of a multi-thread 1D loop.

This class allows specifying the options of a loop to be parallelized in multi-thread mode.

Definition at line 34 of file ParallelFor.h.

Member Typedef Documentation

◆ ThatClass

using Arcane::ParallelFor1DLoopInfo::ThatClass = ParallelFor1DLoopInfo

Definition at line 38 of file ParallelFor.h.

Constructor & Destructor Documentation

◆ ParallelFor1DLoopInfo() [1/3]

Arcane::ParallelFor1DLoopInfo::ParallelFor1DLoopInfo ( Int32 begin,
Int32 size,
IRangeFunctor * functor )
inline

Definition at line 42 of file ParallelFor.h.

◆ ParallelFor1DLoopInfo() [2/3]

Arcane::ParallelFor1DLoopInfo::ParallelFor1DLoopInfo ( Int32 begin,
Int32 size,
IRangeFunctor * functor,
const ForLoopRunInfo & run_info )
inline

Definition at line 47 of file ParallelFor.h.

◆ ParallelFor1DLoopInfo() [3/3]

Arcane::ParallelFor1DLoopInfo::ParallelFor1DLoopInfo ( Int32 begin,
Int32 size,
Int32 block_size,
IRangeFunctor * functor )
inline

Definition at line 53 of file ParallelFor.h.

Member Function Documentation

◆ beginIndex()

Int32 Arcane::ParallelFor1DLoopInfo::beginIndex ( ) const
inline

Definition at line 65 of file ParallelFor.h.

◆ functor()

IRangeFunctor * Arcane::ParallelFor1DLoopInfo::functor ( ) const
inline

Definition at line 67 of file ParallelFor.h.

◆ runInfo() [1/2]

ForLoopRunInfo & Arcane::ParallelFor1DLoopInfo::runInfo ( )
inline

Definition at line 68 of file ParallelFor.h.

◆ runInfo() [2/2]

const ForLoopRunInfo & Arcane::ParallelFor1DLoopInfo::runInfo ( ) const
inline

Definition at line 69 of file ParallelFor.h.

◆ size()

Int32 Arcane::ParallelFor1DLoopInfo::size ( ) const
inline

Definition at line 66 of file ParallelFor.h.

Member Data Documentation

◆ m_begin

Int32 Arcane::ParallelFor1DLoopInfo::m_begin = 0
private

Definition at line 74 of file ParallelFor.h.

◆ m_functor

IRangeFunctor* Arcane::ParallelFor1DLoopInfo::m_functor = nullptr
private

Definition at line 76 of file ParallelFor.h.

◆ m_run_info

ForLoopRunInfo Arcane::ParallelFor1DLoopInfo::m_run_info
private

Definition at line 73 of file ParallelFor.h.

◆ m_size

Int32 Arcane::ParallelFor1DLoopInfo::m_size = 0
private

Definition at line 75 of file ParallelFor.h.

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