BALL::Reciprocal< Function, DataType > Class Template Reference

#include <BALL/MATHS/function.h>

List of all members.

Public Member Functions
Constructors and destructor
	Reciprocal ()
	Reciprocal (const Reciprocal &reciprocal)
virtual	~Reciprocal ()
Assignment
Reciprocal< Function, DataType > &	operator= (const Reciprocal< Function, DataType > &reciprocal)
Predicates
bool	operator== (const Reciprocal< Function, DataType > &reciprocal) const
Function realization
BALL_INLINE DataType	operator() (const DataType &x) const throw (Exception::DivisionByZero)
Accessors
void	setFunction (const Function &function)
const Function &	getFunction () const
Protected Attributes
Function	function_

---

Detailed Description

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

Reciprocal class.

---

Constructor & Destructor Documentation

template<typename Function , typename DataType >

BALL_INLINE BALL::Reciprocal< Function, DataType >::Reciprocal

(

)

[inline]

Default constructor

template<typename Function , typename DataType >

BALL_INLINE BALL::Reciprocal< Function, DataType >::Reciprocal

(

const Reciprocal< Function, DataType > &

reciprocal

)

[inline]

Copy constructor

template<typename Function , typename DataType >

BALL_INLINE BALL::Reciprocal< Function, DataType >::~Reciprocal

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

template<typename Function, typename DataType = float>

const Function& BALL::Reciprocal< Function, DataType >::getFunction

(

)

const [inline]

get the function argument of the reciprocal

Returns:

a const reference to the function argument

template<typename Function, typename DataType = float>

BALL_INLINE DataType BALL::Reciprocal< Function, DataType >::operator()

(

const DataType &

x

)

const throw (Exception::DivisionByZero) [inline]

Evaluation of this subterm

Parameters:

x

the point where to evaluate

Returns:

the function value

template<typename Function , typename DataType >

BALL_INLINE Reciprocal< Function, DataType > & BALL::Reciprocal< Function, DataType >::operator=

(

const Reciprocal< Function, DataType > &

reciprocal

)

[inline]

Assignment operator

References BALL::Reciprocal< Function, DataType >::function_.

template<typename Function , typename DataType >

BALL_INLINE bool BALL::Reciprocal< Function, DataType >::operator==

(

const Reciprocal< Function, DataType > &

reciprocal

)

const [inline]

Equality operator

References BALL::Reciprocal< Function, DataType >::function_.

template<typename Function, typename DataType = float>

void BALL::Reciprocal< Function, DataType >::setFunction

(

const Function &

function

)

[inline]

set the function argument of the reciprocal

---

Member Data Documentation

template<typename Function, typename DataType = float>

Function BALL::Reciprocal< Function, DataType >::function_ [protected]

Referenced by BALL::Reciprocal< Function, DataType >::operator=(), and BALL::Reciprocal< Function, DataType >::operator==().