CFL
Public Member Functions | List of all members
cfl::IMultiFunction Class Referenceabstract

Interface for multi-dimensional function objects. More...

#include <cfl/MultiFunction.hpp>

Public Member Functions

virtual ~IMultiFunction ()
 
virtual bool belongs (const std::valarray< double > &rX) const =0
 
virtual unsigned dim () const =0
 
virtual double operator() (const std::valarray< double > &rX) const =0
 

Detailed Description

This is the abstract class for multi-dimensional function objects. A dynamically allocated implementation of this interface is used to construct the standard multi-dimensional function class MultiFunction.

See also
MultiFunction

Constructor & Destructor Documentation

virtual cfl::IMultiFunction::~IMultiFunction ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

virtual bool cfl::IMultiFunction::belongs ( const std::valarray< double > &  rX) const
pure virtual

Returns true if argument belongs to the domain of the function. Returns false otherwise.

Parameters
rXThe argument of the function. The size of this array should equal the dimension of the function.
Returns
True if argument belongs to the domain of the function and false otherwise.
virtual unsigned cfl::IMultiFunction::dim ( ) const
pure virtual

Returns the dimension of the function.

Returns
The dimension of the function.
virtual double cfl::IMultiFunction::operator() ( const std::valarray< double > &  rX) const
pure virtual

Returns the value of the function at rX.

Parameters
rXThe argument of the function. The size of this array should equal the dimension of the function.
Returns
The value of the function at rX.

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