MGIS 3.1.0
Loading...
Searching...
No Matches
EvaluatorModifierConcept.hxx File Reference

File which defines the concept an evaluator modifier must satisfy, the EvaluatorModifiersGroup class used to combine modifiers and the operator| used to apply them to an evaluator. More...

#include <tuple>
#include <concepts>
#include "MGIS/Function/EvaluatorConcept.hxx"
#include "MGIS/Function/EvaluatorModifierConcept.ixx"

Classes

struct  mgis::function::EvaluatorModifierTag
 a small class to specify that a type is a modifier More...
struct  mgis::function::EvaluatorModifiersGroup< Ms >
 a class meant to group modifiers, allowing modifiers composability More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Concepts

concept  mgis::function::EvaluatorModifierConcept
 concept defining the modifiers which can be applied to evaluators

Functions

template<EvaluatorConcept EvaluatorType, EvaluatorModifierConcept EvaluatorModifierType>
constexpr auto mgis::function::operator| (const EvaluatorType &, EvaluatorModifierType)
 applies a modifier to an evaluator
template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
constexpr auto mgis::function::internals::pop_front (const EvaluatorModifiersGroup< M0, Ms... > &m)
 removes the first modifier of a group of modifiers
template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
constexpr auto mgis::function::internals::apply (const EvaluatorModifiersGroup< Ms... > &m, const EvaluatorConcept auto &e)
 applies a group of modifiers to an evaluator
template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
 mgis::function::EvaluatorModifiersGroup (Ms...) -> EvaluatorModifiersGroup< Ms... >
 deduction guide allowing a group of modifiers to be built from an explicit list of modifiers
template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
 mgis::function::EvaluatorModifiersGroup (std::tuple< Ms... >) -> EvaluatorModifiersGroup< Ms... >
 deduction guide allowing a group of modifiers to be built from a tuple of modifiers
template<EvaluatorModifierConcept M0, EvaluatorModifierConcept M1>
constexpr auto mgis::function::operator| (M0 const &m0, M1 const &m1)
 groups two modifiers into a new group
template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... M1>
constexpr auto mgis::function::operator| (M0 const &m0, EvaluatorModifiersGroup< M1... > const &m1)
 adds a modifier at the beginning of a group of modifiers
template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... M1>
constexpr auto mgis::function::operator| (EvaluatorModifiersGroup< M1... > const &m1, M0 const &m0)
 adds a modifier at the end of a group of modifiers
template<EvaluatorModifierConcept... M0, EvaluatorModifierConcept... M1>
constexpr auto mgis::function::operator| (EvaluatorModifiersGroup< M0... > const &m0, EvaluatorModifiersGroup< M1... > const &m1)
 merges two groups of modifiers

Detailed Description

File which defines the concept an evaluator modifier must satisfy, the EvaluatorModifiersGroup class used to combine modifiers and the operator| used to apply them to an evaluator.

Author
Thomas Helfer
Date
05/06/2025

Function Documentation

◆ apply()

template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
auto mgis::function::internals::apply ( const EvaluatorModifiersGroup< Ms... > & m,
const EvaluatorConcept auto & e )
constexpr

applies a group of modifiers to an evaluator

The modifiers are applied in order: the first modifier of the group is applied to the evaluator, the second one to the evaluator resulting from this first modification, and so on.

Template Parameters
Mstypes of the grouped modifiers
Parameters
[in]mgroup of modifiers
[in]eevaluator
Returns
the evaluator resulting from applying all the modifiers to the given evaluator

◆ EvaluatorModifiersGroup() [1/2]

template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
mgis::function::EvaluatorModifiersGroup ( Ms... ) ->EvaluatorModifiersGroup< Ms... >

deduction guide allowing a group of modifiers to be built from an explicit list of modifiers

Template Parameters
Mstypes of the grouped modifiers

◆ EvaluatorModifiersGroup() [2/2]

template<EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
mgis::function::EvaluatorModifiersGroup ( std::tuple< Ms... > ) ->EvaluatorModifiersGroup< Ms... >

deduction guide allowing a group of modifiers to be built from a tuple of modifiers

Template Parameters
Mstypes of the grouped modifiers

◆ operator|() [1/5]

template<EvaluatorConcept EvaluatorType, EvaluatorModifierConcept EvaluatorModifierType>
auto mgis::function::operator| ( const EvaluatorType & e,
EvaluatorModifierType m )
constexpr

applies a modifier to an evaluator

implementation of the operator| which applies the modifier to the given evaluator, calling the call operator of the modifier

Template Parameters
EvaluatorTypeevaluator type
EvaluatorModifierTypetype of the modifier
Parameters
[in]eevaluator
[in]mmodifier
Returns
the evaluator resulting from applying the modifier to the evaluator

◆ operator|() [2/5]

template<EvaluatorModifierConcept... M0, EvaluatorModifierConcept... M1>
auto mgis::function::operator| ( EvaluatorModifiersGroup< M0... > const & m0,
EvaluatorModifiersGroup< M1... > const & m1 )
constexpr

merges two groups of modifiers

Template Parameters
M0types of the modifiers of the first group, which are applied first
M1types of the modifiers of the second group, which are applied after the modifiers of the first group
Parameters
[in]m0first group of modifiers
[in]m1second group of modifiers
Returns
a new group containing all the modifiers of the two given groups

◆ operator|() [3/5]

template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... M1>
auto mgis::function::operator| ( EvaluatorModifiersGroup< M1... > const & m1,
M0 const & m0 )
constexpr

adds a modifier at the end of a group of modifiers

Template Parameters
M0type of the modifier, which is applied last
M1types of the modifiers of the group, which are applied before the given modifier
Parameters
[in]m1group of modifiers
[in]m0modifier
Returns
a new group of modifiers

◆ operator|() [4/5]

template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... M1>
auto mgis::function::operator| ( M0 const & m0,
EvaluatorModifiersGroup< M1... > const & m1 )
constexpr

adds a modifier at the beginning of a group of modifiers

Template Parameters
M0type of the modifier, which is applied first
M1types of the modifiers of the group, which are applied after the given modifier
Parameters
[in]m0modifier
[in]m1group of modifiers
Returns
a new group of modifiers

◆ operator|() [5/5]

template<EvaluatorModifierConcept M0, EvaluatorModifierConcept M1>
auto mgis::function::operator| ( M0 const & m0,
M1 const & m1 )
constexpr

groups two modifiers into a new group

Template Parameters
M0type of the first modifier, which is applied first
M1type of the second modifier, which is applied to the result of the first modification
Parameters
[in]m0first modifier
[in]m1second modifier
Returns
a group containing the two given modifiers

◆ pop_front()

template<EvaluatorModifierConcept M0, EvaluatorModifierConcept... Ms>
requires (sizeof...(Ms) > 0)
auto mgis::function::internals::pop_front ( const EvaluatorModifiersGroup< M0, Ms... > & m)
constexpr

removes the first modifier of a group of modifiers

Template Parameters
M0type of the first modifier, which is removed
Mstypes of the other modifiers
Parameters
[in]mgroup of modifiers
Returns
a group containing all the modifiers of the given group except the first one