STAPL: Executable Skeletons Internal

Collaboration diagram for Executable Skeletons Internal:

Functions
template<typename MapOp , typename ... V>
void	stapl::map_func_impl::map_func (skeletons::tags::with_coarsened_wf, MapOp const &map_op, V &&... views)
	Construct and execute a PARAGRAPH that will perform a fine-grained map operation, applying the fine-grain work function to the elements of the views provided. More...

template<typename MapOp , typename ... V>
void	stapl::map_func_impl::map_func (skeletons::tags::no_coarsening, MapOp const &map_op, V &&... views)
	Construct and execute a PARAGRAPH that will perform a fine-grained map operation, applying the fine-grain work function to the element of the views provided. More...

template<typename T , typename C , typename S , typename ... V>
T	stapl::map_reduce_helper::map_reduce_impl (S const &skeleton, V &&... v)
	The core implementation of map_reduce. More...

template<typename T , typename C , typename S , typename Scheduler , typename ... V>
std::enable_if<!is_view< Scheduler >::value, T >::type	stapl::map_reduce_helper::map_reduce_impl (S const &skeleton, Scheduler const &scheduler, V &&... v)
	The core implementation of map_reduce. More...

template<typename Tag , typename MapOp , typename ReduceOp , typename ... V>
std::enable_if< std::is_same< Tag, stapl::use_default >::value, typename stapl::result_of::map_reduce< Tag, MapOp, ReduceOp, V... >::type >::type	stapl::map_reduce_helper::map_reduce (Tag, MapOp const &map_op, ReduceOp const &reduce_op, V const &... v)
	Applies map-reduce on a set of inputs by coarsening the map-reduce skeleton and the inputs. This is the most commonly used version of map-reduce in STAPL. More...

template<typename CoarseTag , typename ExecutionTag , typename MapOp , typename ReduceOp , typename... V>
stapl::result_of::map_reduce< CoarseTag, MapOp, ReduceOp, V... >::type	stapl::map_reduce_helper::map_reduce (skeletons::tags::coarse< CoarseTag, ExecutionTag >, MapOp const &map_op, ReduceOp const &reduce_op, V const &... v)
	Applies map-reduce on a set of inputs by coarsening the map-reduce skeleton according to the `CoarseTag` and `ExecutionTag` specified. More...

template<typename Tag , typename MapOp , typename ReduceOp , typename ... V>
std::enable_if< std::is_same< Tag, skeletons::tags::no_coarsening >::value, typename stapl::result_of::map_reduce< Tag, MapOp, ReduceOp, V... >::type >::type	stapl::map_reduce_helper::map_reduce (Tag, MapOp const &map_op, ReduceOp const &reduce_op, V &&... v)
	Applies map-reduce on a set of inputs without coarsening the map-reduce skeleton and the inputs. More...

template<typename T , typename C , typename S , typename View >
std::decay< View >::type::value_type	stapl::reduce_helpers::reduce (S const &skeleton, View &&view)
	Reduces the value of elements in a given view by applying `BinaryOp` given an algorithm executor and the skeleton to be used. More...

template<typename View , typename BinaryOp >
std::decay< View >::type::value_type	stapl::reduce_helpers::reduce (stapl::use_default, View &&view, BinaryOp const &binop)
	Reduces the value of elements in a given view by applying `BinaryOp`. More...

template<typename View , typename BinaryOp >
std::decay< View >::type::value_type	stapl::reduce_helpers::reduce (skeletons::tags::no_coarsening, View &&view, BinaryOp const &binop)
	This specialization is used when no coarsening is intended. More...

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >
void	stapl::scan_helpers::scan (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan< Tag, skeletons::tags::inclusive >, CoarseTag)
	Computes the inclusive scan of the elements of the input view and stores the result in the output view. More...

template<typename View0 , typename View1 , typename Binop , typename Tag >
void	stapl::scan_helpers::scan (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan< Tag, skeletons::tags::inclusive >, skeletons::tags::no_coarsening)
	A non-coarsened inclusive scan skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening. More...

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >
void	stapl::scan_helpers::scan (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan< Tag, skeletons::tags::exclusive >, CoarseTag)
	Computes the exclusive scan of the elements of the input view and stores the result in the output view. More...

template<typename View0 , typename View1 , typename Binop , typename Tag , typename ExecutionTag >
void	stapl::scan_helpers::scan (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan< Tag, skeletons::tags::exclusive >, skeletons::tags::coarse< skeletons::tags::naive, ExecutionTag >)
	Computes the exclusive scan of the elements of the input view and stores the result in the output view. More...

template<typename View0 , typename View1 , typename Binop , typename Tag >
void	stapl::scan_helpers::scan (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan< Tag, skeletons::tags::exclusive >, skeletons::tags::no_coarsening)
	A non-coarsened exclusive scan skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening. More...

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >
std::decay< View0 >::type::value_type	stapl::scan_reduce_helpers::scan_reduce (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan_reduce< Tag, skeletons::tags::inclusive >, CoarseTag)
	Computes the inclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it. More...

template<typename View0 , typename View1 , typename Binop , typename Tag >
std::decay< View0 >::type::value_type	stapl::scan_reduce_helpers::scan_reduce (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan_reduce< Tag, skeletons::tags::inclusive >, skeletons::tags::no_coarsening)
	Computes the inclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it. More...

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >
std::decay< View0 >::type::value_type	stapl::scan_reduce_helpers::scan_reduce (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan_reduce< Tag, skeletons::tags::exclusive >, CoarseTag)
	Computes the exclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it. More...

template<typename View0 , typename View1 , typename Binop , typename Tag >
std::decay< View0 >::type::value_type	stapl::scan_reduce_helpers::scan_reduce (View0 &&view0, View1 &&view1, Binop binop, skeletons::tags::scan_reduce< Tag, skeletons::tags::exclusive >, skeletons::tags::no_coarsening)
	A non-coarsened exclusive scan_reduce skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening. More...

Detailed Description

The executable skeletons are used across STAPL, primarily in algorithms (e.g., map_func, reduce, scan, etc.). With the knowledge of the input, the executable skeletons transform skeletons in order to improve performance. An example of transformation is the coarsening of the map skeleton based on the size of the input views.

Implementations.

Function Documentation

◆ map_func() [1/2]

template<typename MapOp , typename ... V>

void stapl::map_func_impl::map_func	(	skeletons::tags::with_coarsened_wf	,
		MapOp const &	map_op,
		V &&...	views
	)

Construct and execute a PARAGRAPH that will perform a fine-grained map operation, applying the fine-grain work function to the elements of the views provided.

Parameters

map_op	Fine-grain map work function.
view	One or more views to process with the map work function.

◆ map_func() [2/2]

template<typename MapOp , typename ... V>

void stapl::map_func_impl::map_func	(	skeletons::tags::no_coarsening	,
		MapOp const &	map_op,
		V &&...	views
	)

Construct and execute a PARAGRAPH that will perform a fine-grained map operation, applying the fine-grain work function to the element of the views provided.

Parameters

map_op	Fine-grain map work function.
views	One or more views to process with the map work function.

◆ map_reduce_impl() [1/2]

template<typename T , typename C , typename S , typename ... V>

T stapl::map_reduce_helper::map_reduce_impl	(	S const &	skeleton,
		V &&...	v
	)

The core implementation of map_reduce.

Given the executor and the coarsened skeleton it creates the auxiliary static_array to populate the final result of map-reduce into it.

Template Parameters

T	result type of the reduction operation
C	data coarsening method used

Parameters

skeleton	The skeleton containing the coarsened map and reduce operations to be applied to the input views.
v	the inputs

◆ map_reduce_impl() [2/2]

template<typename T , typename C , typename S , typename Scheduler , typename ... V>

std::enable_if<!is_view<Scheduler>::value, T>::type stapl::map_reduce_helper::map_reduce_impl	(	S const &	skeleton,
		Scheduler const &	scheduler,
		V &&...	v
	)

The core implementation of map_reduce.

Given the coarsened skeleton and a scheduler to use for its execution create the executor and invoke it with a tuple of the input views.

Template Parameters

T	result type of the reduction operation
C	data coarsening method used

Parameters

skeleton	The skeleton containing the coarsened map and reduce operations to be applied to the input views.
scheduler	The scheduler to use in the execution of the skeleton.
v	the inputs

◆ map_reduce() [1/3]

template<typename Tag , typename MapOp , typename ReduceOp , typename ... V>

std::enable_if< std::is_same<Tag, stapl::use_default>::value, typename stapl::result_of::map_reduce<Tag, MapOp, ReduceOp, V...>::type>::type stapl::map_reduce_helper::map_reduce	(	Tag	,
		MapOp const &	map_op,
		ReduceOp const &	reduce_op,
		V const &...	v
	)

Applies map-reduce on a set of inputs by coarsening the map-reduce skeleton and the inputs. This is the most commonly used version of map-reduce in STAPL.

Template Parameters

Tag	use_default specifies that both data and skeleton need to be coarsened

Parameters

map_op	the operation to be applied in the first step on the given input(s)
reduce_op	the operation to be applied on the results of the the first map phase
v	the inputs

◆ map_reduce() [2/3]

template<typename CoarseTag , typename ExecutionTag , typename MapOp , typename ReduceOp , typename... V>

stapl::result_of::map_reduce<CoarseTag, MapOp, ReduceOp, V...>::type stapl::map_reduce_helper::map_reduce	(	skeletons::tags::coarse< CoarseTag, ExecutionTag >	,
		MapOp const &	map_op,
		ReduceOp const &	reduce_op,
		V const &...	v
	)

Applies map-reduce on a set of inputs by coarsening the map-reduce skeleton according to the CoarseTag and ExecutionTag specified.

Parameters

CoarseTag	the type of coarsening
ExecutionTag	the type of execution for the specified coarsening
map_op	the operation to be applied in the first step on the given input(s)
reduce_op	the operation to be applied on the results of the the first map phase
v	the inputs

◆ map_reduce() [3/3]

template<typename Tag , typename MapOp , typename ReduceOp , typename ... V>

std::enable_if< std::is_same<Tag, skeletons::tags::no_coarsening>::value, typename stapl::result_of::map_reduce<Tag, MapOp, ReduceOp, V...>::type>::type stapl::map_reduce_helper::map_reduce	(	Tag	,
		MapOp const &	map_op,
		ReduceOp const &	reduce_op,
		V &&...	v
	)

Applies map-reduce on a set of inputs without coarsening the map-reduce skeleton and the inputs.

Template Parameters

Tag	no_coarsening specifies that neither data nor skeleton need to be coarsened

Parameters

map_op	the operation to be applied in the first step on the given input(s)
reduce_op	the operation to be applied on the results of the the first map phase
v	the inputs

◆ reduce() [1/3]

template<typename T , typename C , typename S , typename View >

std::decay<View>::type::value_type stapl::reduce_helpers::reduce	(	S const &	skeleton,
		View &&	view
	)

Reduces the value of elements in a given view by applying BinaryOp given an algorithm executor and the skeleton to be used.

Template Parameters

T	result type of the reduction
C	data coarsening method to be used

Parameters

skeleton	the reduction skeleton to be used
view	the input view
binop	the operation used to reduce the values

Returns: returns the reduction value on each location

◆ reduce() [2/3]

template<typename View , typename BinaryOp >

std::decay<View>::type::value_type stapl::reduce_helpers::reduce	(	stapl::use_default	,
		View &&	view,
		BinaryOp const &	binop
	)

Reduces the value of elements in a given view by applying BinaryOp.

Parameters

view	the input view
binop	the operation used to reduce the values

Returns: returns the reduction value on each location

◆ reduce() [3/3]

template<typename View , typename BinaryOp >

std::decay<View>::type::value_type stapl::reduce_helpers::reduce	(	skeletons::tags::no_coarsening	,
		View &&	view,
		BinaryOp const &	binop
	)

This specialization is used when no coarsening is intended.

Parameters

view	the input view
binop	the operation used to reduce the values

Returns: returns the reduction value on each location

◆ scan() [1/5]

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >

void stapl::scan_helpers::scan	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan< Tag, skeletons::tags::inclusive >	,
		CoarseTag
	)

Computes the inclusive scan of the elements of the input view and stores the result in the output view.

In an inclusive scan, each element in the result view is the result of successive application of binop on all the elements before it, including itself.

The type of the inclusive scan to be used can be specified by Tag

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.
tag	determines the type of inclusive scan to be used

Template Parameters

CoarseTag specializes the coarsened scan

◆ scan() [2/5]

template<typename View0 , typename View1 , typename Binop , typename Tag >

void stapl::scan_helpers::scan	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan< Tag, skeletons::tags::inclusive >	,
		skeletons::tags::no_coarsening
	)

A non-coarsened inclusive scan skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening.

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.
tag	determines the type of inclusive scan to be used

See also: exclusive_scan

◆ scan() [3/5]

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >

void stapl::scan_helpers::scan	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan< Tag, skeletons::tags::exclusive >	,
		CoarseTag
	)

Computes the exclusive scan of the elements of the input view and stores the result in the output view.

In an exclusive scan, each element in the result view is the result of successive application of binop on all the elements before it, not including itself.

The type of the exclusive scan to be used can be specified by Tag

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.
tag	determines the type of exclusive scan to be used

Template Parameters

CoarseTag specializes the coarsened scan

◆ scan() [4/5]

template<typename View0 , typename View1 , typename Binop , typename Tag , typename ExecutionTag >

void stapl::scan_helpers::scan	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan< Tag, skeletons::tags::exclusive >	,
		skeletons::tags::coarse< skeletons::tags::naive, ExecutionTag >
	)

Computes the exclusive scan of the elements of the input view and stores the result in the output view.

In an exclusive scan, each element in the result view is the result of successive application of binop on all the elements before it, not including itself.

Note: The naive coarsened exclusive scan is not an in-place algorithm. The result of computation should be copied to the output explicitly using the sink skeleton.

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.

◆ scan() [5/5]

template<typename View0 , typename View1 , typename Binop , typename Tag >

void stapl::scan_helpers::scan	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan< Tag, skeletons::tags::exclusive >	,
		skeletons::tags::no_coarsening
	)

A non-coarsened exclusive scan skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening.

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.
tag	determines the type of scan to be used

See also: exclusive_scan

◆ scan_reduce() [1/4]

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >

std::decay<View0>::type::value_type stapl::scan_reduce_helpers::scan_reduce	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan_reduce< Tag, skeletons::tags::inclusive >	,
		CoarseTag
	)

Computes the inclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it.

In an inclusive scan, each element in the result view is the result of successive application of binop on all the elements before it, including itself.

The type of the inclusive scan to be used can be specified by Tag

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan and reduce operation.
tag	determines the type of inclusive scan to be used

Template Parameters

CoarseTag specializes the coarsened scan

Returns: the result of reduce skeleton

◆ scan_reduce() [2/4]

template<typename View0 , typename View1 , typename Binop , typename Tag >

std::decay<View0>::type::value_type stapl::scan_reduce_helpers::scan_reduce	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan_reduce< Tag, skeletons::tags::inclusive >	,
		skeletons::tags::no_coarsening
	)

Computes the inclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it.

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan and reduce operation.
tag	determines the type of inclusive scan to be used

See also: inclusive_scan

Returns: the result of reduce skeleton

◆ scan_reduce() [3/4]

template<typename View0 , typename View1 , typename Binop , typename Tag , typename CoarseTag >

std::decay<View0>::type::value_type stapl::scan_reduce_helpers::scan_reduce	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan_reduce< Tag, skeletons::tags::exclusive >	,
		CoarseTag
	)

Computes the exclusive scan of the elements of the input view and stores the result in the output view. Also computes the reduce value of input elements and returns it.

In an exclusive scan, each element in the result view is the result of successive application of binop on all the elements before it, not including itself.

The type of the exclusive scan to be used can be specified by Tag

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan and reduce operation.
tag	determines the type of exclusive scan to be used

Template Parameters

CoarseTag specializes the coarsened scan

Returns: the result of reduce skeleton

◆ scan_reduce() [4/4]

template<typename View0 , typename View1 , typename Binop , typename Tag >

std::decay<View0>::type::value_type stapl::scan_reduce_helpers::scan_reduce	(	View0 &&	view0,
		View1 &&	view1,
		Binop	binop,
		skeletons::tags::scan_reduce< Tag, skeletons::tags::exclusive >	,
		skeletons::tags::no_coarsening
	)

A non-coarsened exclusive scan_reduce skips the coarsening process and is faster for the cases that the number of elements per location are too small to benefit from coarsening.

Parameters

view0	A one-dimensional view over the input elements that are of a numeric type.
view1	A one-dimensional view over the elements where the result of the scan will be written.
binop	The binary functor that will be used to compute the result of scan operation.
tag	determines the type of scan to be used

Returns: the result of reduce skeleton

See also: reduce; exclusive_scan

Functions

Detailed Description

Function Documentation

◆ map_func() [1/2]

◆ map_func() [2/2]

◆ map_reduce_impl() [1/2]

◆ map_reduce_impl() [2/2]

◆ map_reduce() [1/3]

◆ map_reduce() [2/3]

◆ map_reduce() [3/3]

◆ reduce() [1/3]

◆ reduce() [2/3]

◆ reduce() [3/3]

◆ scan() [1/5]

◆ scan() [2/5]

◆ scan() [3/5]

◆ scan() [4/5]

◆ scan() [5/5]

◆ scan_reduce() [1/4]

◆ scan_reduce() [2/4]

◆ scan_reduce() [3/4]

◆ scan_reduce() [4/4]