STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::detail::terminator_initializer< FactoryTag > Struct Template Reference

Responsible for initializing the termination detection object that the PARAGRAPH's executor employs to determine when the local computation for the PARAGRAPH is completed.Partial specialization of this class provides a mechanism to customize the termination detection algorithm of a given PARAGRAPH. More...

Public Member Functions

template<typename SVS >
void operator() (task_graph &tg, SVS &, boost::optional< terminator_t > &t) const
 Signature function operator that creates a termination detection object in the paragraph constructor. More...
 

Public Types

using is_default = void
 
using terminator_t = terminator< std::pair< int, bool >, termination_reduce >
 The type of the terminator object. By default, uses terminator, defined in the runtime.
 

Detailed Description

template<typename FactoryTag>
struct stapl::detail::terminator_initializer< FactoryTag >

Responsible for initializing the termination detection object that the PARAGRAPH's executor employs to determine when the local computation for the PARAGRAPH is completed.

Partial specialization of this class provides a mechanism to customize the termination detection algorithm of a given PARAGRAPH.

Template Parameters
FactoryThe factory type of the associated PARAGRAPH. Unused in the class definition, but allows class specialization based on this type.

Member Function Documentation

◆ operator()()

template<typename FactoryTag >
template<typename SVS >
void stapl::detail::terminator_initializer< FactoryTag >::operator() ( task_graph tg,
SVS &  ,
boost::optional< terminator_t > &  t 
) const

Signature function operator that creates a termination detection object in the paragraph constructor.

Parameters
tgThe associated PARAGRAPH instance.
svsThe post data coarsening input views of the PARAGRAPH.
tUninitialized terminator stored in paragraph. Initialized in this call as desired.

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