PARAGRAPH

The PARAGRAPH is the dependence graph representation of programs in STAPL. More...

Collaboration diagram for PARAGRAPH:

Classes
struct	stapl::detail::cross_tg_notifier
	Function object that delays the execution of a PARAGRAPH, pending notification from predecessor PARAGRAPHs who compute values that the successor receives as view inputs.Allows initialization of PARAGRAPH (and perhaps some task initialization to proceed concurrently with predecessor PARAGRAPH execution. More...
class	stapl::factory_wf
	Concept base class used by factory workfunctions to denote that they are factory classes. More...
class	stapl::incremental_wf
	Concept base class used by factory workfunctions to denote that they may not complete their work of creating tasks during a single invocation of the function operator and hence must be queried to check for required reinvocation. More...
struct	stapl::result_of::make_paragraph< Scheduler, Factory, Views >
	Metafunction which reflects return type of a make_paragraph call. More...
struct	stapl::detail::scoped_drain_call
	Use RAII to conditionally invoke a executor drain after the body of paragraph::operator(). More...
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. More...
class	stapl::paragraph_impl::paragraph< Scheduler, Factory, Views >
	The PARAGRAPH is the dependence graph representation of programs in STAPL. It's generally not advised for users to instantiate it directly, but rather use stapl::make_paragraph. More...
struct	stapl::coarsened_wf< WF >
	Wrapper class around workfunction that a factory can detect, signaling that workfunction is designed to work on coarsened view data. More...
struct	stapl::tg_initializer
	Allows the PARAGRAPH infrastructure to detect if an PARAGRAPH initialization is currently in progress. Aids in reference counting of cross PARAGRAPH data consumption when in non blocking execution mode. More...
struct	stapl::paragraph_impl::setup_edge_flow_func< NotifierPtr >
	Creates the notifiers necessary to flow the result of a non-explicitly dependent task (i.e., those specified via consume) so it is available for the task being added on this location. More...
class	stapl::paragraph_impl::task_graph
	Contains all functionality of the PARAGRAPH that isn't dependent on the Scheduler or View types. More...
class	stapl::proxy< paragraph< Scheduler, Factory, Views... >, Accessor >
	proxy specialization for PARAGRAPH type signature. More...
class	stapl::task_factory_base
	Intermediate class of the task factory hierarchy that provides the edge_mf_type for all factories that derive from it. More...
struct	stapl::paragraph_impl::proxy_holder< lazy_edge_reference< T > >
	Specialization for instances of proxy backed by the edge_accessor.Hold a copy of the value and the corresponding task identifier directly. More...
struct	stapl::paragraph_impl::migration_packer< View >
	Given an edge value type T, this metafunction returns the type serialized during task migration. More...
struct	stapl::paragraph_impl::migration_packer< lazy_edge_reference< T > >
	Specialization for instances of proxy backed by the edge_accessor with default filtering (i.e., no filtering). Wrap these proxies in proxy_holder. More...
struct	stapl::paragraph_impl::migration_unpacker< View >
	Given an edge value type T, this metafunction returns the unpacked type of the egde, post task migration. More...
struct	stapl::paragraph_impl::compute_tid_mapper_type< Factory, NumViews, Sequence, b >
	Extracts the key mapper type from the Factory class if it is defined. More...
struct	stapl::paragraph_impl::compute_df_edge_type< T >
	Temporary metafunction used in task_graph::processed() to extract proxies from proxy_holders they were wrapped in for serialization. More...
struct	stapl::paragraph_impl::is_deferred< T, Q >
	Default metafunction used in the identification of deferred evaluation views and accessors in input_edge_available_func. More...
struct	stapl::paragraph_impl::count_df_preds_func
	Functor used to identify deferred evaluation views and accessors in the specification of a task. More...
class	stapl::detail::ephemeral_pg< Task >
	Conditional base class of task_graph_impl used for PARAGRAPHs that destroy themselves incrementally as they execute. More...
class	stapl::detail::persistent_pg< Task >
	Conditional base class of task_graph_impl that maintains all tasks and edges persistent in memory after one execution so that it can be reused. More...
class	stapl::detail::task_graph_base
	Intermediate class in PARAGRAPH class hierarchy responsible for handling registration of the instantiaion with the runtime.In addition to object registration this class is responsible for removing get_location_id() from the public interface of the task_graph. More...
class	stapl::paragraph_impl::task_graph_impl< Scheduler >
	Contains functionality of the PARAGRAPH that is dependent on the the type of scheduler used in the executor processing the PARAGRAPH, though not the Views of the PARAGRAPH.PARAGRAPH persistence is enabled by a typedef reflected by the scheduler. task_graph_impl derives from persistent_pg or ephemeral_pg depending on whether the typedef is reflected by the scheduler or not. More...

Modules
	Edge Container
	Paragraph View Operations
	Paragraph Task Classes
	Paragraph View and Supporting Code
	Paragraph Result View and Supporting Code
	Paragraph Utility Files

Functions
template<typename Scheduler , typename Factory , typename... Views>
result_of::make_paragraph< Scheduler, Factory, Views... >::type	stapl::make_paragraph (Factory const &factory, Views const &... views)
	Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang. More...
template<typename Factory , typename Scheduler , typename... Views>
result_of::make_paragraph< Scheduler, Factory, Views... >::type	stapl::make_paragraph (Factory const &factory, Scheduler const &scheduler, Views const &... views)
	Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang. More...
template<typename Factory , typename... Views>
result_of::make_paragraph< default_scheduler, Factory, Views... >::type	stapl::make_paragraph (Factory const &factory, Views const &... views)
	Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang. and no scheduler specified. Uses default scheduler. More...
template<typename WF >
coarsened_wf< WF >	stapl::is_coarse_wf (WF const &wf)
	Function that returns coarsened_wf wrapper class around the specified workfunction. More...
int	stapl::paragraph_impl::termination_value (task_graph const &)
	Return the termination detection value for this location as report by task_graph::termination_value. More...

Detailed Description

The PARAGRAPH is the dependence graph representation of programs in STAPL.

Function Documentation

make_paragraph() [1/3]

template<typename Scheduler , typename Factory , typename... Views>

result_of::make_paragraph<Scheduler, Factory, Views...>::type stapl::make_paragraph	(	Factory const &	factory,
		Views const &...	views
	)

Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang.

Template Parameters

Scheduler

PARAGRAPH scheduler type. Explicitly provided by function caller.

Parameters

factory	Task factory to populate PARAGRAPH.
views	variadic number of views to pass to PARAGRAPH.

Returns

proxy to construct PARAGRAPH

make_paragraph() [2/3]

template<typename Factory , typename Scheduler , typename... Views>

result_of::make_paragraph<Scheduler, Factory, Views...>::type stapl::make_paragraph	(	Factory const &	factory,
		Scheduler const &	scheduler,
		Views const &...	views
	)

Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang.

Parameters

factory	Task factory to populate PARAGRAPH.
scheduler	Scheduler used in execution of PARAGRAPH tasks
views	variadic number of views to pass to PARAGRAPH.

Returns

proxy to construct PARAGRAPH

make_paragraph() [3/3]

template<typename Factory , typename... Views>

result_of::make_paragraph<default_scheduler, Factory, Views...>::type stapl::make_paragraph	(	Factory const &	factory,
		Views const &...	views
	)

Signature of make_paragraph used when PARAGRAPH creation is collective and should be spawned on all locations in current gang. and no scheduler specified. Uses default scheduler.

Parameters

factory	Task factory to populate PARAGRAPH.
views	variadic number of viws to pass to PARAGRAPH.

Returns

proxy to construct PARAGRAPH

is_coarse_wf()

template<typename WF >

coarsened_wf<WF> stapl::is_coarse_wf

(

WF const &

wf

)

Function that returns coarsened_wf wrapper class around the specified workfunction.

Parameters

wf	The user's coarse grain workfunction.

See also

coarsened_wf

map_func

termination_value()

int stapl::paragraph_impl::termination_value

(

task_graph const &

)

Return the termination detection value for this location as report by task_graph::termination_value.

See also

task_graph::termination_value