utl::Function2< Arg, Result > Class Template Reference

Base class for binary function of arbitrary result and argument type. More...

#include <Function.h>

Public Types
typedef Arg	Input
	Input type.
typedef Result	Output
	Output type.

Public Member Functions
virtual	~Function2 ()
	Empty destructor.
virtual bool	isZero () const
	Returns whether the function is identically zero or not.
Result	operator() (const Arg &x, const Arg &y) const
	Operator returning the function value for the given arguments.

Protected Member Functions
	Function2 ()
	The constructor is protected to allow sub-class instances only.
virtual Result	evaluate (const Arg &x, const Arg &y) const =0
	Evaluates the function for the arguments x and y.

Detailed Description

template<class Arg, class Result>
class utl::Function2< Arg, Result >

Base class for binary function of arbitrary result and argument type.

The two arguments have to be of the same type.

Member Function Documentation

evaluate()

template<class Arg , class Result >

virtual Result utl::Function2< Arg, Result >::evaluate ( const Arg &  x, const Arg &  y  ) const

protectedpure virtual

Evaluates the function for the arguments x and y.

Implemented in ForceDirField, TractionField, and PressureField.

Referenced by utl::Function2< Arg, Result >::operator()().

isZero()

template<class Arg , class Result >

virtual bool utl::Function2< Arg, Result >::isZero ( ) const

inlinevirtual

Returns whether the function is identically zero or not.

Reimplemented in TractionField, PressureField, and ForceDirField.

---

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

• /home/runner/work/IFEM-2/IFEM-2/src/Utility/Function.h