OpenMP parallel execution policy. More...

#include <parallel_execution_omp.h>

Public Member Functions
	parallel_execution_omp () noexcept
	Default construct an OpenMP parallel execution policy. More...

	parallel_execution_omp (int concurrency_degree, bool order=true) noexcept
	Set num_threads to _threads in order to run in parallel. More...

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

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

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

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

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

void	set_queue_attributes (int size, queue_mode mode) noexcept
	Sets the attributes for the queues built through make_queue<T>(() More...

template<typename T >
mpmc_queue< T >	make_queue () const
	Makes a communication queue for elements of type T. More...

template<typename T , typename ... Transformers>
mpmc_queue< T > &	get_output_queue (mpmc_queue< T > &queue, Transformers &&...) const
	Returns the reference of a communication queue for elements of type T if the queue has been created in an outer pattern. Returns the reference of the queue received as argument. More...

template<typename T , typename ... Transformers>
mpmc_queue< T >	get_output_queue (Transformers &&...) const
	Makes a communication queue for elements of type T if the queue has not been created in an outer pattern. Call to the make_queue function and the value is returned via move semantics. More...

int	get_thread_id () const noexcept
	Get index of current thread in the thread table. More...

template<typename ... InputIterators, typename OutputIterator , typename Transformer >
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 using available OpenMP parallelism. More...

template<typename InputIterator , typename Identity , typename Combiner >
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 >
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 >
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 Queue , typename Transformer , typename Predicate , template< typename T, typename P > class Iteration, typename ... OtherTransformers, requires_iteration< Iteration< Transformer, Predicate >> , requires_pipeline< Transformer > >
void	do_pipeline (Queue &, Iteration< Transformer, Predicate > &&, OtherTransformers &&...) const

template<typename T , typename... Others>
void	do_pipeline (mpmc_queue< T > &, mpmc_queue< T > &, Others &&...) const

Detailed Description

OpenMP parallel execution policy.

This policy uses OpenMP as implementation back-end.

Constructor & Destructor Documentation

◆ parallel_execution_omp() [1/2]

grppi::parallel_execution_omp::parallel_execution_omp ( )

inlinenoexcept

Default construct an OpenMP parallel execution policy.

Creates an OpenMP parallel execution object.

The concurrency degree is determined by the platform according to OpenMP rules.

◆ parallel_execution_omp() [2/2]

grppi::parallel_execution_omp::parallel_execution_omp	(	int	concurrency_degree,
		bool	order = `true`
	)

inlinenoexcept

Set num_threads to _threads in order to run in parallel.

Parameters

_threads number of threads used in the parallel mode

Constructs an OpenMP parallel execution policy.

Creates an OpenMP parallel execution object selecting the concurrency degree and ordering.

Parameters

concurrency_degree	Number of threads used for parallel algorithms.
order	Whether ordered executions is enabled or disabled.

Member Function Documentation

◆ concurrency_degree()

int grppi::parallel_execution_omp::concurrency_degree ( ) const

inlinenoexcept

Get number of grppi threads.

◆ disable_ordering()

void grppi::parallel_execution_omp::disable_ordering ( )

inlinenoexcept

Disable ordering.

◆ divide_conquer() [1/2]

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

auto grppi::parallel_execution_omp::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::parallel_execution_omp::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() [1/2]

template<typename T , typename... Others>

void grppi::parallel_execution_omp::do_pipeline	(	mpmc_queue< T > &	,
		mpmc_queue< T > &	,
		Others &&	...
	)		const

◆ do_pipeline() [2/2]

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

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

◆ enable_ordering()

void grppi::parallel_execution_omp::enable_ordering ( )

inlinenoexcept

Enable ordering.

◆ get_output_queue() [1/2]

template<typename T , typename ... Transformers>

mpmc_queue<T>& grppi::parallel_execution_omp::get_output_queue	(	mpmc_queue< T > &	queue,
		Transformers &&	...
	)		const

inline

Returns the reference of a communication queue for elements of type T if the queue has been created in an outer pattern. Returns the reference of the queue received as argument.

Template Parameters

T	Element type for the queue.
Transformers	List of the next transformers.

Parameters

queue Reference of a queue of type T

◆ get_output_queue() [2/2]

template<typename T , typename ... Transformers>

mpmc_queue<T> grppi::parallel_execution_omp::get_output_queue ( Transformers && ... ) const

inline

Makes a communication queue for elements of type T if the queue has not been created in an outer pattern. Call to the make_queue function and the value is returned via move semantics.

Template Parameters

T	Element type for the queue.
Transformers	List of the next transformers.

◆ get_thread_id()

int grppi::parallel_execution_omp::get_thread_id ( ) const

inlinenoexcept

Get index of current thread in the thread table.

◆ is_ordered()

bool grppi::parallel_execution_omp::is_ordered ( ) const

inlinenoexcept

Is execution ordered.

◆ make_queue()

template<typename T >

mpmc_queue<T> grppi::parallel_execution_omp::make_queue ( ) const

inline

Makes a communication queue for elements of type T.

Constructs a queue using the attributes that can be set via set_queue_attributes(). The value is returned via move semantics.

◆ map()

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

void grppi::parallel_execution_omp::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 using available OpenMP parallelism.

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 >

auto grppi::parallel_execution_omp::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.

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::parallel_execution_omp::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::parallel_execution_omp::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 >

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

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.
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()

void grppi::parallel_execution_omp::set_concurrency_degree ( int degree )

inlinenoexcept

Set number of grppi threads.

◆ set_queue_attributes()

void grppi::parallel_execution_omp::set_queue_attributes	(	int	size,
		queue_mode	mode
	)

inlinenoexcept

Sets the attributes for the queues built through make_queue<T>(()

◆ stencil()

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

void grppi::parallel_execution_omp::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.

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:

parallel_execution_omp.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ parallel_execution_omp() [1/2]

◆ parallel_execution_omp() [2/2]

Member Function Documentation

◆ concurrency_degree()

◆ disable_ordering()

◆ divide_conquer() [1/2]

◆ divide_conquer() [2/2]

◆ do_pipeline() [1/2]

◆ do_pipeline() [2/2]

◆ enable_ordering()

◆ get_output_queue() [1/2]

◆ get_output_queue() [2/2]

◆ get_thread_id()

◆ is_ordered()

◆ make_queue()

◆ map()

◆ map_reduce()

◆ pipeline() [1/2]

◆ pipeline() [2/2]

◆ reduce()

◆ set_concurrency_degree()

◆ set_queue_attributes()

◆ stencil()