Sequential execution policy. More...

#include <sequential_execution.h>

Public Member Functions
constexpr	sequential_execution () noexcept=default
	Default constructor. More...

constexpr void	set_concurrency_degree (int) const noexcept
	Set number of grppi threads. More...

constexpr int	concurrency_degree () const noexcept
	Get number of grppi threads. More...

constexpr void	enable_ordering () const noexcept
	Enable ordering. More...

constexpr void	disable_ordering () const noexcept
	Disable ordering. More...

constexpr bool	is_ordered () const noexcept
	Is execution ordered. More...

template<typename ... InputIterators, typename OutputIterator , typename Transformer >
constexpr void	map (std::tuple< InputIterators... > firsts, OutputIterator first_out, std::size_t sequence_size, Transformer &&transform_op) const
	Applies a transformation to multiple sequences leaving the result in another sequence. More...

template<typename InputIterator , typename Identity , typename Combiner >
constexpr auto	reduce (InputIterator first, std::size_t sequence_size, Identity &&identity, Combiner &&combine_op) const
	Applies a reduction to a sequence of data items. More...

template<typename ... InputIterators, typename Identity , typename Transformer , typename Combiner >
constexpr auto	map_reduce (std::tuple< InputIterators... > firsts, std::size_t sequence_size, Identity &&identity, Transformer &&transform_op, Combiner &&combine_op) const
	Applies a map/reduce operation to a sequence of data items. More...

template<typename ... InputIterators, typename OutputIterator , typename StencilTransformer , typename Neighbourhood >
constexpr void	stencil (std::tuple< InputIterators... > firsts, OutputIterator first_out, std::size_t sequence_size, StencilTransformer &&transform_op, Neighbourhood &&neighbour_op) const
	Applies a stencil to multiple sequences leaving the result in another sequence. More...

template<typename Input , typename Divider , typename Solver , typename Combiner >
auto	divide_conquer (Input &&input, Divider &&divide_op, Solver &&solve_op, Combiner &&combine_op) const
	Invoke md_divide-conquer. More...

template<typename Input , typename Divider , typename Predicate , typename Solver , typename Combiner >
auto	divide_conquer (Input &&input, Divider &&divide_op, Predicate &&predicate_op, Solver &&solve_op, Combiner &&combine_op) const
	Invoke md_divide-conquer. More...

template<typename Generator , typename ... Transformers>
void	pipeline (Generator &&generate_op, Transformers &&... transform_op) const
	Invoke Pipeline pattern. More...

template<typename InputType , typename Transformer , typename OutputType >
void	pipeline (mpmc_queue< InputType > &input_queue, Transformer &&transform_op, mpmc_queue< OutputType > &output_queue) const
	Invoke Pipeline pattern coming from another context that uses mpmc_queues as communication channels. More...

template<typename Item , typename Transformer , typename Predicate , template< typename T, typename P > class Iteration, typename ... OtherTransformers, requires_iteration< Iteration< Transformer, Predicate >> , requires_pipeline< Transformer > >
void	do_pipeline (Item &&, Iteration< Transformer, Predicate > &&, OtherTransformers &&...) const

Detailed Description

Sequential execution policy.

Constructor & Destructor Documentation

◆ sequential_execution()

constexpr grppi::sequential_execution::sequential_execution ( )

constexprdefaultnoexcept

Default constructor.

Member Function Documentation

◆ concurrency_degree()

constexpr int grppi::sequential_execution::concurrency_degree ( ) const

inlineconstexprnoexcept

Get number of grppi threads.

Note: Getting concurrency degree is always 1 for sequential execution.

◆ disable_ordering()

constexpr void grppi::sequential_execution::disable_ordering ( ) const

inlineconstexprnoexcept

Disable ordering.

Note: Disabling ordering of sequential execution is always ignored.

◆ divide_conquer() [1/2]

template<typename Input , typename Divider , typename Predicate , typename Solver , typename Combiner >

auto grppi::sequential_execution::divide_conquer	(	Input &&	input,
		Divider &&	divide_op,
		Predicate &&	predicate_op,
		Solver &&	solve_op,
		Combiner &&	combine_op
	)		const

Invoke md_divide-conquer.

Template Parameters

Input	Type used for the input problem.
Divider	Callable type for the divider operation.
Predicate	Callable type for the stop condition predicate.
Solver	Callable type for the solver operation.
Combiner	Callable type for the combiner operation.

Parameters

ex	Sequential execution policy object.
input	Input problem to be solved.
divider_op	Divider operation.
predicate_op	Predicate operation.
solver_op	Solver operation.
combine_op	Combiner operation.

◆ divide_conquer() [2/2]

template<typename Input , typename Divider , typename Solver , typename Combiner >

auto grppi::sequential_execution::divide_conquer	(	Input &&	input,
		Divider &&	divide_op,
		Solver &&	solve_op,
		Combiner &&	combine_op
	)		const

Invoke md_divide-conquer.

Template Parameters

Input	Type used for the input problem.
Divider	Callable type for the divider operation.
Solver	Callable type for the solver operation.
Combiner	Callable type for the combiner operation.

Parameters

ex	Sequential execution policy object.
input	Input problem to be solved.
divider_op	Divider operation.
solver_op	Solver operation.
combine_op	Combiner operation.

◆ do_pipeline()

template<typename Item , typename Transformer , typename Predicate , template< typename T, typename P > class Iteration, typename ... OtherTransformers, requires_iteration< Iteration< Transformer, Predicate >> , requires_pipeline< Transformer > >

void grppi::sequential_execution::do_pipeline	(	Item &&	,
		Iteration< Transformer, Predicate > &&	,
		OtherTransformers &&	...
	)		const

◆ enable_ordering()

constexpr void grppi::sequential_execution::enable_ordering ( ) const

inlineconstexprnoexcept

Enable ordering.

Note: Enabling ordering of sequential execution is always ignored.

◆ is_ordered()

constexpr bool grppi::sequential_execution::is_ordered ( ) const

inlineconstexprnoexcept

Is execution ordered.

Note: Sequential execution is always ordered.

◆ map()

template<typename ... InputIterators, typename OutputIterator , typename Transformer >

constexpr void grppi::sequential_execution::map	(	std::tuple< InputIterators... >	firsts,
		OutputIterator	first_out,
		std::size_t	sequence_size,
		Transformer &&	transform_op
	)		const

constexpr

Applies a transformation to multiple sequences leaving the result in another sequence.

Template Parameters

InputIterators	Iterator types for input sequences.
OutputIterator	Iterator type for the output sequence.
Transformer	Callable object type for the transformation.

Parameters

firsts	Tuple of iterators to input sequences.
first_out	Iterator to the output sequence.
sequence_size	Size of the input sequences.
transform_op	Transformation callable object.

Precondition: For every I iterators in the range [get<I>(firsts), next(get<I>(firsts),sequence_size)) are valid.; Iterators in the range [first_out, next(first_out,sequence_size)] are valid.

◆ map_reduce()

template<typename ... InputIterators, typename Identity , typename Transformer , typename Combiner >

constexpr auto grppi::sequential_execution::map_reduce	(	std::tuple< InputIterators... >	firsts,
		std::size_t	sequence_size,
		Identity &&	identity,
		Transformer &&	transform_op,
		Combiner &&	combine_op
	)		const

constexpr

Applies a map/reduce operation to a sequence of data items.

Template Parameters

InputIterator	Iterator type for the input sequence.
Identity	Type for the identity value.
Transformer	Callable object type for the transformation.
Combiner	Callable object type for the combination.

Parameters

first	Iterator to the first element of the sequence.
sequence_size	Size of the input sequence.
identity	Identity value for the reduction.
transform_op	Transformation callable object.
combine_op	Combination callable object.

Precondition: Iterators in the range [first,last) are valid.

Returns: The map/reduce result.

◆ pipeline() [1/2]

template<typename Generator , typename ... Transformers>

void grppi::sequential_execution::pipeline	(	Generator &&	generate_op,
		Transformers &&...	transform_op
	)		const

Invoke Pipeline pattern.

Template Parameters

Generator	Callable type for the generator operation.
Transformers	Callable types for the transformers in the pipeline.

Parameters

generate_op	Generator operation.
transform_ops	Transformer operations.

◆ pipeline() [2/2]

template<typename InputType , typename Transformer , typename OutputType >

void grppi::sequential_execution::pipeline	(	mpmc_queue< InputType > &	input_queue,
		Transformer &&	transform_op,
		mpmc_queue< OutputType > &	output_queue
	)		const

inline

Invoke Pipeline pattern coming from another context that uses mpmc_queues as communication channels.

Template Parameters

InputType	Type of the input stream.
Transformers	Callable types for the transformers in the pipeline.
InputType	Type of the output stream.

Parameters

input_queue	Input stream communicator.
transform_ops	Transformer operations.
output_queue	Input stream communicator.

◆ reduce()

template<typename InputIterator , typename Identity , typename Combiner >

constexpr auto grppi::sequential_execution::reduce	(	InputIterator	first,
		std::size_t	sequence_size,
		Identity &&	identity,
		Combiner &&	combine_op
	)		const

constexpr

Applies a reduction to a sequence of data items.

Template Parameters

InputIterator	Iterator type for the input sequence.
Identity	Type for the identity value.
Combiner	Callable object type for the combination.

Parameters

first	Iterator to the first element of the sequence.
sequence_size	Size of the input sequence.
last	Iterator to one past the end of the sequence.
identity	Identity value for the reduction.
combine_op	Combination callable object.

Precondition: Iterators in the range [first,last) are valid.

Returns: The reduction result

◆ set_concurrency_degree()

constexpr void grppi::sequential_execution::set_concurrency_degree ( int ) const

inlineconstexprnoexcept

Set number of grppi threads.

Note: Setting concurrency degree is ignored for sequential execution.

◆ stencil()

template<typename ... InputIterators, typename OutputIterator , typename StencilTransformer , typename Neighbourhood >

constexpr void grppi::sequential_execution::stencil	(	std::tuple< InputIterators... >	firsts,
		OutputIterator	first_out,
		std::size_t	sequence_size,
		StencilTransformer &&	transform_op,
		Neighbourhood &&	neighbour_op
	)		const

constexpr

Applies a stencil to multiple sequences leaving the result in another sequence.

Template Parameters

InputIterators	Iterator types for input sequences.
OutputIterator	Iterator type for the output sequence.
StencilTransformer	Callable object type for the stencil transformation.
Neighbourhood	Callable object for generating neighbourhoods.

Parameters

firsts	Tuple of iterators to input sequences.
first_out	Iterator to the output sequence.
sequence_size	Size of the input sequences.
transform_op	Stencil transformation callable object.
neighbour_op	Neighbourhood callable object.

Precondition: For every I iterators in the range [get<I>(firsts), next(get<I>(firsts),sequence_size)) are valid.; Iterators in the range [first_out, next(first_out,sequence_size)] are valid.

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

sequential_execution.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ sequential_execution()

Member Function Documentation

◆ concurrency_degree()

◆ disable_ordering()

◆ divide_conquer() [1/2]

◆ divide_conquer() [2/2]

◆ do_pipeline()

◆ enable_ordering()

◆ is_ordered()

◆ map()

◆ map_reduce()

◆ pipeline() [1/2]

◆ pipeline() [2/2]

◆ reduce()

◆ set_concurrency_degree()

◆ stencil()