BALL::NumericalIntegrator< Function, DataType > Class Template Reference
[Function classes]

Numerical integrator class. More...

#include <numericalIntegrator.h>

Inheritance diagram for BALL::NumericalIntegrator< Function, DataType >:
Inheritance graph
[legend]

List of all members.


Public Member Functions

Constructors and destructor.
NumericalIntegrator ()
Default constructor.
NumericalIntegrator (const NumericalIntegrator &nint)
Copy constructor.
virtual ~NumericalIntegrator ()
Destructor.
Assignment
NumericalIntegrator & operator= (const NumericalIntegrator &nint)
Assignment operator.
Predicates
bool operator== (const NumericalIntegrator &nint) const
Equality operator.
Accessors
void setFunction (const Function &function)
set the function to be integrated
const Function & getFunction () const
Get the function to be integrated (const version).
Function & getFunction ()
Get the function to be integrated (const version).
DataType getValue (const DataType &x) const
Get the value of the function at position x .
DataType integrate (const DataType &from, const DataType &to) const
Integrate the function numerically.

Protected Attributes

Function function_

Detailed Description

template<typename Function, typename DataType = float>
class BALL::NumericalIntegrator< Function, DataType >

Numerical integrator class.

Member Function Documentation

template<typename Function, typename DataType = float>
Function& BALL::NumericalIntegrator< Function, DataType >::getFunction ( )

Get the function to be integrated (const version).

Returns:
a mutable reference to the actual function

template<typename Function, typename DataType = float>
const Function& BALL::NumericalIntegrator< Function, DataType >::getFunction ( ) const

Get the function to be integrated (const version).

Returns:
a const reference to the actual function

template<typename Function , typename DataType>
DataType BALL::NumericalIntegrator< Function, DataType >::getValue ( const DataType & x ) const

Get the value of the function at position x .

Parameters:
x the position at which function is to be evaluated
Returns:
the value of function at x

template<typename Function , typename DataType>
DataType BALL::NumericalIntegrator< Function, DataType >::integrate ( const DataType & from,
const DataType & to
) const

Integrate the function numerically.

Parameters:
from lower limit of the integration
to upper limit of the integration
Returns:
the value of the integral

template<typename Function, typename DataType >
void BALL::NumericalIntegrator< Function, DataType >::setFunction ( const Function & function )

set the function to be integrated

Parameters:
the function to be assigned

Generated on Thu Aug 6 18:30:34 2009 for BALL by doxygen 1.5.8