CEPS  24.01
Cardiac ElectroPhysiology Simulator
SAFunc.hpp File Reference

Go to the source code of this file.

Data Structures

class  SAFunc< _Result >
 A SAFunc is a ceps::Function that uses CepsStandardArgs as argument of call operator (), hence the name. Moreover, an object is stored as ptr in the class. This object can be used to evaluate the result. More...
 
class  OperatorSAFunc< _Op, _Res1, _Res2 >
 Operation on two SA Funcs. More...
 

Namespaces

 ceps
 A namespace for all utility methods.
 

Typedefs

using ScalarSAFunc = SAFunc< CepsMathScalar >
 TypeDef for functions that return a scalar. More...
 
using VectorSAFunc = SAFunc< CepsMathVertex >
 TypeDef for functions that return a vector (R^3) More...
 
using TensorSAFunc = SAFunc< CepsMathTensor >
 TypeDef for functions that return a tensor (M(3,3,R)) More...
 

Functions

template<typename _Fn >
CepsEnum ceps::getFlagsOf (_Fn f)
 Tell that this function is template, nothing more. More...
 
template<typename _Result >
CepsEnum ceps::getFlagsOf (Function< _Result(CepsStandardArgs)> *f)
 Get flags of dereferenced object ptr. More...
 
template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'+', _Res1, _Res2 > * newSumSAFunc (SAFunc< _Res1 > *, SAFunc< _Res2 > *)
 Get a new addition object without having to look after return types of fn1 and fn2. More...
 
template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'-', _Res1, _Res2 > * newDiffSAFunc (SAFunc< _Res1 > *, SAFunc< _Res2 > *)
 Get a new substraction object without having to look after return types of fn1 and fn2. More...
 
template<typename _Res1 , typename _Res2 >
OperatorSAFunc<' *', _Res1, _Res2 > * newProductSAFunc (SAFunc< _Res1 > *, SAFunc< _Res2 > *)
 Get a new product object without having to look after return types of fn1 and fn2. More...
 
template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'/', _Res1, _Res2 > * newDivSAFunc (SAFunc< _Res1 > *, SAFunc< _Res2 > *)
 Get a new division object without having to look after return types of fn1 and fn2. More...
 

Detailed Description

ceps functions that uses a shared struct as argument

Definition in file SAFunc.hpp.

Typedef Documentation

◆ ScalarSAFunc

TypeDef for functions that return a scalar.

Definition at line 134 of file SAFunc.hpp.

◆ TensorSAFunc

TypeDef for functions that return a tensor (M(3,3,R))

Definition at line 138 of file SAFunc.hpp.

◆ VectorSAFunc

TypeDef for functions that return a vector (R^3)

Definition at line 136 of file SAFunc.hpp.

Function Documentation

◆ newDiffSAFunc()

template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'-',_Res1,_Res2>* newDiffSAFunc ( SAFunc< _Res1 > *  ,
SAFunc< _Res2 > *   
)

Get a new substraction object without having to look after return types of fn1 and fn2.

◆ newDivSAFunc()

template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'/',_Res1,_Res2>* newDivSAFunc ( SAFunc< _Res1 > *  ,
SAFunc< _Res2 > *   
)

Get a new division object without having to look after return types of fn1 and fn2.

◆ newProductSAFunc()

template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'*',_Res1,_Res2>* newProductSAFunc ( SAFunc< _Res1 > *  ,
SAFunc< _Res2 > *   
)

Get a new product object without having to look after return types of fn1 and fn2.

◆ newSumSAFunc()

template<typename _Res1 , typename _Res2 >
OperatorSAFunc<'+',_Res1,_Res2>* newSumSAFunc ( SAFunc< _Res1 > *  ,
SAFunc< _Res2 > *   
)

Get a new addition object without having to look after return types of fn1 and fn2.