CEPS  24.01
Cardiac ElectroPhysiology Simulator
ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)> Struct Template Reference

Detailed Description

template<CepsSize _N, class _Object, class _Res, class... _Args>
struct ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>

Specialization of ceps::Function with several constant values.

Definition at line 290 of file CepsFunction.hpp.

#include <CepsFunction.hpp>

Inheritance diagram for ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>:
[legend]

Public Types

using KeyType = std::remove_cvref_t< std::tuple_element_t< _N, CepsTuple< _Args... > >>
 extract the type that designate the region More...
 
- Public Types inherited from ceps::Function< _Res(_Args...)>
using ReturnType = _Res
 Return type definition. More...
 
using SignatureType = _Res(_Args...)
 signature type More...
 

Public Member Functions

 PiecewiseFunction (const CepsMap< KeyType, _Object > &map)
 Constructor with values. More...
 
 PiecewiseFunction (const PiecewiseFunction &that)
 Copy constructor. More...
 
 ~PiecewiseFunction () override
 Destructor. More...
 
_Res eval (_Args... args) final
 Call operator. More...
 
- Public Member Functions inherited from ceps::Function< _Res(_Args...)>
 Function ()=default
 Construct a new Function object. More...
 
 Function (const Function &)=default
 Copy constructor. More...
 
 Function (Function &&) noexcept=default
 Copy constructor. More...
 
Functionoperator= (const Function &)=default
 Assignment operator. More...
 
Functionoperator= (Function &&) noexcept=default
 Assignment operator. More...
 
virtual ~Function ()=default
 Destroy the Function object. More...
 
virtual _Res operator() (_Args... args) final
 Base operator for call. Cannot be overloaded, use eval instead. We do this as the It is used to select the correct evaluation of the derived classes, as C++ seems to not do the right thing. More...
 

Data Fields

CepsMap< KeyType, _Object > m_map
 Values. More...
 

Member Typedef Documentation

◆ KeyType

template<CepsSize _N, class _Object , class _Res , class... _Args>
using ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::KeyType = std::remove_cvref_t<std::tuple_element_t<_N, CepsTuple<_Args...> >>

extract the type that designate the region

Definition at line 294 of file CepsFunction.hpp.

Constructor & Destructor Documentation

◆ PiecewiseFunction() [1/2]

template<CepsSize _N, class _Object , class _Res , class... _Args>
ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::PiecewiseFunction ( const CepsMap< KeyType, _Object > &  map)
inlineexplicit

Constructor with values.

Definition at line 299 of file CepsFunction.hpp.

◆ PiecewiseFunction() [2/2]

template<CepsSize _N, class _Object , class _Res , class... _Args>
ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::PiecewiseFunction ( const PiecewiseFunction< _N, _Object, _Res(_Args...)> &  that)
inline

Copy constructor.

Definition at line 304 of file CepsFunction.hpp.

◆ ~PiecewiseFunction()

template<CepsSize _N, class _Object , class _Res , class... _Args>
ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::~PiecewiseFunction ( )
inlineoverride

Destructor.

Definition at line 309 of file CepsFunction.hpp.

Member Function Documentation

◆ eval()

template<CepsSize _N, class _Object , class _Res , class... _Args>
_Res ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::eval ( _Args...  args)
inlinefinalvirtual

Call operator.

Implements ceps::Function< _Res(_Args...)>.

Definition at line 314 of file CepsFunction.hpp.

Field Documentation

◆ m_map

template<CepsSize _N, class _Object , class _Res , class... _Args>
CepsMap<KeyType, _Object> ceps::PiecewiseFunction< _N, _Object, _Res(_Args...)>::m_map

Values.

Definition at line 296 of file CepsFunction.hpp.


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