|
template<detail::ConfigElement ... _configs_t> |
class | configuration |
| Friend declaration for other instances of the configuration.
|
|
|
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (pipeable_config_element< lhs_derived_t, lhs_value_t > &&lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > &&rhs) |
| Combines two seqan3::pipeable_config_element objects to a seqan3::configuration. More...
|
|
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (pipeable_config_element< lhs_derived_t, lhs_value_t > &&lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > const &rhs) |
|
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (pipeable_config_element< lhs_derived_t, lhs_value_t > const &lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > &&rhs) |
|
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (pipeable_config_element< lhs_derived_t, lhs_value_t > const &lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > const &rhs) |
|
template<typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (configuration &&lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > &&rhs) |
| Combines a seqan3::configuration with a seqan3::pipeable_config_element. More...
|
|
template<typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (configuration const &lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > &&rhs) |
|
template<typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (configuration &&lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > const &rhs) |
|
template<typename rhs_derived_t , typename rhs_value_t > |
constexpr auto | operator| (configuration const &lhs, pipeable_config_element< rhs_derived_t, rhs_value_t > const &rhs) |
|
template<typename ... rhs_configs_t> |
constexpr auto | operator| (configuration &&lhs, configuration< rhs_configs_t... > &&rhs) |
| Combines two seqan3::configuration objects. More...
|
|
template<typename ... rhs_configs_t> |
constexpr auto | operator| (configuration const &lhs, configuration< rhs_configs_t... > &&rhs) |
|
template<typename ... rhs_configs_t> |
constexpr auto | operator| (configuration &&lhs, configuration< rhs_configs_t... > const &rhs) |
|
template<typename ... rhs_configs_t> |
constexpr auto | operator| (configuration const &lhs, configuration< rhs_configs_t... > const &rhs) |
|
|
template<typename query_t , typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) &noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<typename query_t , typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) const &noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<typename query_t , typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) &&noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<typename query_t , typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) const &&noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<template< typename... > typename query_t, typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) &noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<template< typename... > typename query_t, typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) const &noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<template< typename... > typename query_t, typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) &&noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<template< typename... > typename query_t, typename default_t > |
decltype(auto) constexpr | value_or (default_t &&default_value) const &&noexcept |
| Returns the contained value if *this has a value, otherwise returns default_value . More...
|
|
template<typename query_t > |
static constexpr bool | exists () noexcept |
| Checks if the given type exists in the tuple.
|
|
template<template< typename... > typename query_t> |
static constexpr bool | exists () noexcept |
| Checks if the given type exists in the tuple.
|
|
template<detail::ConfigElement ... configs_t>
class seqan3::configuration< configs_t >
Collection of elements to configure an algorithm.
- Template Parameters
-
configs_t | Template parameter pack containing all configuration elements; Must model seqan3::detail::ConfigElement |
This class provides a unified interface to create and query such configurations for a specific algorithm. It extends the standard tuple interface with some useful functions to modify and query the user configurations.
template<detail::ConfigElement ... configs_t>
template<typename query_t , typename default_t >
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<typename query_t , typename default_t >
decltype(auto) constexpr seqan3::configuration< configs_t >::value_or |
( |
default_t && |
default_value | ) |
const & |
|
inlinenoexcept |
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<typename query_t , typename default_t >
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<typename query_t , typename default_t >
decltype(auto) constexpr seqan3::configuration< configs_t >::value_or |
( |
default_t && |
default_value | ) |
const && |
|
inlinenoexcept |
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<template< typename... > typename query_t, typename default_t >
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<template< typename... > typename query_t, typename default_t >
decltype(auto) constexpr seqan3::configuration< configs_t >::value_or |
( |
default_t && |
default_value | ) |
const & |
|
inlinenoexcept |
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<template< typename... > typename query_t, typename default_t >
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<template< typename... > typename query_t, typename default_t >
decltype(auto) constexpr seqan3::configuration< configs_t >::value_or |
( |
default_t && |
default_value | ) |
const && |
|
inlinenoexcept |
Returns the contained value if *this
has a value, otherwise returns default_value
.
- Template Parameters
-
query_t | The type to get the value from. |
- Parameters
-
[in] | default_value | The default value if query_t is not contained in the configuration. |
Returns a reference to the stored configuration value by passing through the .value
member of the respective configuration element. If it does not exists than the default value is returned. The existence check of a type is done at compile time.
Example
std::cout << my_cfg.value_or<bar>(
"not there") <<
'\n';
std::cout << my_cfg.value_or<foo>(
"not there") <<
'\n';
Exception
no-throw guarantee.
Complexity
Constant time.
template<detail::ConfigElement ... configs_t>
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t >
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<detail::ConfigElement ... configs_t>
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t >
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<detail::ConfigElement ... configs_t>
template<typename lhs_derived_t , typename lhs_value_t , typename rhs_derived_t , typename rhs_value_t >
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.