seqan3::detail::parallel_mode< wrapped_config_id_t > Class Template Reference

A global configuration type used to enable parallel execution of algorithms. More...

#include <seqan3/core/configuration/detail/configuration_element_parallel_mode.hpp>

Inheritance diagram for seqan3::detail::parallel_mode< wrapped_config_id_t >:

Public Member Functions
Constructors, assignment and destructor
	parallel_mode ()=default
	Defaulted.
	parallel_mode (parallel_mode const &)=default
	Defaulted.
	parallel_mode (parallel_mode &&)=default
	Defaulted.
parallel_mode &	operator= (parallel_mode const &)=default
	Defaulted.
parallel_mode &	operator= (parallel_mode &&)=default
	Defaulted.
	~parallel_mode ()=default
	Defaulted.
	parallel_mode (uint32_t thread_count_) noexcept
	Sets the number of threads for the parallel configuration element.

Public Attributes
std::optional< uint32_t >	thread_count {std::nullopt}
	The maximum number of threads the algorithm can use.

Static Private Attributes
static constexpr wrapped_config_id_t::value_type	id {wrapped_config_id_t::value}
	Internal id to check for consistent configuration settings.

Detailed Description

template<typename wrapped_config_id_t>
class seqan3::detail::parallel_mode< wrapped_config_id_t >

A global configuration type used to enable parallel execution of algorithms.

Template Parameters

wrapped_config_id_t

The algorithm specific configuration id wrapped in a std::integral_constant.

This type is used to enable the parallel mode of the algorithms.

Constructor & Destructor Documentation

parallel_mode()

template<typename wrapped_config_id_t >

seqan3::detail::parallel_mode< wrapped_config_id_t >::parallel_mode ( uint32_t  thread_count_ )

inlineexplicitnoexcept

Sets the number of threads for the parallel configuration element.

Parameters

[in]

thread_count_

The maximum number of threads to be used by the algorithm.

---

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

• configuration_element_parallel_mode.hpp