MGIS 3.1.0
Loading...
Searching...
No Matches
FixedSizeModifier.ixx File Reference

File which contains the implementation of the FixedSizeModifier class declared in MGIS/Function/FixedSizeModifier.hxx. More...

#include <array>
#include "MGIS/Raise.hxx"
#include "MGIS/Function/DataViewConcept.hxx"

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Functions

template<size_type N, typename EvaluatorType>
requires ( (N > 0) && (N != dynamic_extent) && // (EvaluatorConcept<std::decay_t<EvaluatorType>>))
constexpr auto mgis::function::view (const EvaluatorType &)
 create a fixed size view from an evaluator
template<EvaluatorConcept EvaluatorType, size_type N>
constexpr decltype(auto) mgis::function::getSpace (const FixedSizeModifier< EvaluatorType, N > &)
 return the underlying space
template<EvaluatorConcept EvaluatorType, size_type N>
constexpr bool mgis::function::check (AbstractErrorHandler &, const FixedSizeModifier< EvaluatorType, N > &)
 perform consistency checks
template<EvaluatorConcept EvaluatorType, size_type N>
constexpr size_type mgis::function::getNumberOfComponents (const FixedSizeModifier< EvaluatorType, N > &)
 return the number of components

Detailed Description

File which contains the implementation of the FixedSizeModifier class declared in MGIS/Function/FixedSizeModifier.hxx.

Author
Thomas Helfer
Date
07/05/2025

Function Documentation

◆ check()

template<EvaluatorConcept EvaluatorType, size_type N>
bool mgis::function::check ( AbstractErrorHandler & eh,
const FixedSizeModifier< EvaluatorType, N > & e )
nodiscardconstexpr

perform consistency checks

Template Parameters
EvaluatorTypetype of the underlying evaluator
Nnumber of components of the modifier
Parameters
[in]eherror handler used to report the errors
[in]efixed size modifier
Returns
true if the values computed by the modifier are valid

◆ getNumberOfComponents()

template<EvaluatorConcept EvaluatorType, size_type N>
size_type mgis::function::getNumberOfComponents ( const FixedSizeModifier< EvaluatorType, N > & e)
nodiscardconstexpr

return the number of components

Template Parameters
EvaluatorTypetype of the underlying evaluator
Nnumber of components of the modifier
Parameters
[in]efixed size modifier
Returns
the number of components of the modifier, which is N

◆ getSpace()

template<EvaluatorConcept EvaluatorType, size_type N>
decltype(auto) mgis::function::getSpace ( const FixedSizeModifier< EvaluatorType, N > & e)
nodiscardconstexpr

return the underlying space

Template Parameters
EvaluatorTypetype of the underlying evaluator
Nnumber of components of the modifier
Parameters
[in]efixed size modifier
Returns
the space on which the modifier is defined

◆ view()

template<size_type N, typename EvaluatorType>
requires ( (N > 0) && (N != dynamic_extent) && // (EvaluatorConcept<std::decay_t<EvaluatorType>>))
auto mgis::function::view ( const EvaluatorType & f)
nodiscardconstexpr

create a fixed size view from an evaluator

Template Parameters
Nnumber of components of the view
EvaluatorTypetype of the evaluator, which may be a qualified type
Parameters
[in]fevaluator
Returns
a fixed size modifier of the evaluator