OperatorSAFunc< _Op, _Res1, _Res2 > Class Template Reference

Detailed Description

template<char _Op, typename _Res1, typename _Res2>
class OperatorSAFunc< _Op, _Res1, _Res2 >

Operation on two SA Funcs.

Definition at line 162 of file SAFunc.hpp.

#include <SAFunc.hpp>

Inheritance diagram for OperatorSAFunc< _Op, _Res1, _Res2 >:

Public Types
using	Fn1 = SAFunc< _Res1 >
	Type of function of the left operand. More...
using	Fn2 = SAFunc< _Res2 >
	Type of function of the right operand. More...
using	Result = ceps::ResultOfOperation< _Op, _Res1, _Res2 >
	Type of result. More...
Public Types inherited from SAFunc< ceps::ResultOfOperation< _Op, _Res1, _Res2 > >
using	BaseFunction = ceps::Function< ceps::ResultOfOperation< _Op, _Res1, _Res2 >(CepsStandardArgs)>
	Typedef for the function type. More...

Public Member Functions
	OperatorSAFunc (Fn1 *fn1, Fn2 *fn2)
	Constructor. More...
	~OperatorSAFunc () override
	Destructor. More...
OperatorSAFunc &	operator= (const OperatorSAFunc &)=default
	We allow the assignement from a functor to another. More...
CepsEnum	getFlags () const override
	Could be none, but better make it pure virtual. More...
void	getLocalData () override
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
void	releaseLocalData () override
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
Result	eval (CepsStandardArgs) override
	Returns the operation on evals of fn1, fn2. More...
void	setOwned (CepsBool o1, CepsBool o2)
	Tells if operands will be deleted by product function (false by default) More...
Public Member Functions inherited from SAFunc< ceps::ResultOfOperation< _Op, _Res1, _Res2 > >
	SAFunc (const SAFunc &)=default
	We allow the copy from a functor to another. More...
SAFunc &	operator= (const SAFunc &)=default
	We allow the assignement from a functor to another. More...
CepsBool	hasOption (CepsFunctionFlag flag)
	Tells if option is activated. More...

Protected Attributes
Fn1 *	m_fn1
	left operand More...
Fn2 *	m_fn2
	right operand More...
CepsBool	m_ownedFn1
	Fn1 will be deleted with product. More...
CepsBool	m_ownedFn2
	Fn2 will be deleted with product. More...

Member Typedef Documentation

Fn1

template<char _Op, typename _Res1 , typename _Res2 >

using OperatorSAFunc< _Op, _Res1, _Res2 >::Fn1 = SAFunc<_Res1>

Type of function of the left operand.

Definition at line 168 of file SAFunc.hpp.

Fn2

template<char _Op, typename _Res1 , typename _Res2 >

using OperatorSAFunc< _Op, _Res1, _Res2 >::Fn2 = SAFunc<_Res2>

Type of function of the right operand.

Definition at line 170 of file SAFunc.hpp.

Result

template<char _Op, typename _Res1 , typename _Res2 >

using OperatorSAFunc< _Op, _Res1, _Res2 >::Result = ceps::ResultOfOperation<_Op, _Res1, _Res2>

Type of result.

Definition at line 172 of file SAFunc.hpp.

Constructor & Destructor Documentation

OperatorSAFunc()

template<char _Op, typename _Res1 , typename _Res2 >

OperatorSAFunc< _Op, _Res1, _Res2 >::OperatorSAFunc	(	Fn1 *	fn1,
		Fn2 *	fn2
	)

Constructor.

~OperatorSAFunc()

template<char _Op, typename _Res1 , typename _Res2 >

OperatorSAFunc< _Op, _Res1, _Res2 >::~OperatorSAFunc ( )

override

Destructor.

Member Function Documentation

eval()

template<char _Op, typename _Res1 , typename _Res2 >

Result OperatorSAFunc< _Op, _Res1, _Res2 >::eval ( CepsStandardArgs  )

override

Returns the operation on evals of fn1, fn2.

getFlags()

template<char _Op, typename _Res1 , typename _Res2 >

CepsEnum OperatorSAFunc< _Op, _Res1, _Res2 >::getFlags ( ) const

overridevirtual

Could be none, but better make it pure virtual.

Implements SAFunc< ceps::ResultOfOperation< _Op, _Res1, _Res2 > >.

getLocalData()

template<char _Op, typename _Res1 , typename _Res2 >

void OperatorSAFunc< _Op, _Res1, _Res2 >::getLocalData ( )

overridevirtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented from SAFunc< ceps::ResultOfOperation< _Op, _Res1, _Res2 > >.

operator=()

template<char _Op, typename _Res1 , typename _Res2 >

OperatorSAFunc& OperatorSAFunc< _Op, _Res1, _Res2 >::operator= ( const OperatorSAFunc< _Op, _Res1, _Res2 > &  )

default

We allow the assignement from a functor to another.

releaseLocalData()

template<char _Op, typename _Res1 , typename _Res2 >

void OperatorSAFunc< _Op, _Res1, _Res2 >::releaseLocalData ( )

overridevirtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented from SAFunc< ceps::ResultOfOperation< _Op, _Res1, _Res2 > >.

setOwned()

template<char _Op, typename _Res1 , typename _Res2 >

void OperatorSAFunc< _Op, _Res1, _Res2 >::setOwned	(	CepsBool	o1,
		CepsBool	o2
	)

Tells if operands will be deleted by product function (false by default)

Field Documentation

m_fn1

template<char _Op, typename _Res1 , typename _Res2 >

Fn1* OperatorSAFunc< _Op, _Res1, _Res2 >::m_fn1

protected

left operand

Definition at line 207 of file SAFunc.hpp.

m_fn2

template<char _Op, typename _Res1 , typename _Res2 >

Fn2* OperatorSAFunc< _Op, _Res1, _Res2 >::m_fn2

protected

right operand

Definition at line 208 of file SAFunc.hpp.

m_ownedFn1

template<char _Op, typename _Res1 , typename _Res2 >

CepsBool OperatorSAFunc< _Op, _Res1, _Res2 >::m_ownedFn1

protected

Fn1 will be deleted with product.

Definition at line 209 of file SAFunc.hpp.

m_ownedFn2

template<char _Op, typename _Res1 , typename _Res2 >

CepsBool OperatorSAFunc< _Op, _Res1, _Res2 >::m_ownedFn2

protected

Fn2 will be deleted with product.

Definition at line 210 of file SAFunc.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/functions/SAFunc.hpp