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

#include <BALL/MATHS/function.h>

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
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.

Definition at line 606 of file function.h.

Constructor & Destructor Documentation

template<typename Function , typename DataType >

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

(

)

Default constructor

Definition at line 1259 of file function.h.

template<typename Function , typename DataType >

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

(

const Reciprocal< Function, DataType > &

reciprocal

)

Copy constructor

Definition at line 1266 of file function.h.

template<typename Function , typename DataType >

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

virtual

Destructor

Definition at line 1273 of file function.h.

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

Definition at line 685 of file function.h.

template<typename Function, typename DataType = float>

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

inline

Evaluation of this subterm

Parameters

x	the point where to evaluate

Returns

the function value

Exceptions

Exception::DivisionByZero

if x is zero

Definition at line 657 of file function.h.

template<typename Function , typename DataType >

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

(

const Reciprocal< Function, DataType > &

reciprocal

)

Assignment operator

Definition at line 1279 of file function.h.

template<typename Function , typename DataType >

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

(

const Reciprocal< Function, DataType > &

reciprocal

)

const

Equality operator

Definition at line 1287 of file function.h.

template<typename Function, typename DataType = float>

void BALL::Reciprocal< Function, DataType >::setFunction ( const Function &  function )

inline

set the function argument of the reciprocal

Definition at line 677 of file function.h.

Member Data Documentation

template<typename Function, typename DataType = float>

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

protected

Definition at line 696 of file function.h.