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

#include <BALL/MATHS/function.h>

List of all members.

Public Member Functions
Constructors and destructor
	MutablePower ()
	MutablePower (const MutablePower &power)
virtual	~MutablePower ()
Assignment
MutablePower< Function, DataType > &	operator= (const MutablePower< Function, DataType > &power)
Predicates
bool	operator== (const MutablePower< Function, DataType > &power) const
Function realization
BALL_INLINE DataType	operator() (const DataType &x) const
Accessors
void	setFunction (const Function &function)
const Function &	getFunction () const
void	setExponent (DataType exp)
DataType	getExponent () const
Protected Attributes
Function	function_
DataType	exponent_

---

Detailed Description

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

MutablePower class.

---

Constructor & Destructor Documentation

template<typename Function , typename DataType >

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

(

)

[inline]

Default constructor

template<typename Function , typename DataType >

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

(

const MutablePower< Function, DataType > &

power

)

[inline]

Copy constructor

template<typename Function , typename DataType >

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

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

template<typename Function , typename DataType >

BALL_INLINE DataType BALL::MutablePower< Function, DataType >::getExponent

(

)

const [inline]

get the exponent of the power function

Returns:

the exponent of this

References BALL::MutablePower< Function, DataType >::exponent_.

template<typename Function, typename DataType = float>

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

(

)

const [inline]

get the function argument of the power

Returns:

a const reference to the function argument

template<typename Function, typename DataType = float>

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

(

const DataType &

x

)

const [inline]

Evaluation of this subterm

Parameters:

x

the point where to evaluate

Returns:

the function value

template<typename Function , typename DataType >

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

(

const MutablePower< Function, DataType > &

power

)

[inline]

Assignment operator

References BALL::MutablePower< Function, DataType >::exponent_, and BALL::MutablePower< Function, DataType >::function_.

template<typename Function , typename DataType >

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

(

const MutablePower< Function, DataType > &

power

)

const [inline]

Equality operator

References BALL::MutablePower< Function, DataType >::exponent_, and BALL::MutablePower< Function, DataType >::function_.

template<typename Function , typename DataType >

BALL_INLINE void BALL::MutablePower< Function, DataType >::setExponent

(

DataType

exp

)

[inline]

set the exponent of the power function

Parameters:

exp

the exponent

References BALL::MutablePower< Function, DataType >::exponent_.

template<typename Function, typename DataType = float>

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

(

const Function &

function

)

[inline]

set the function argument of the power

---

Member Data Documentation

template<typename Function, typename DataType = float>

DataType BALL::MutablePower< Function, DataType >::exponent_ [protected]

Referenced by BALL::MutablePower< Function, DataType >::getExponent(), BALL::MutablePower< Function, DataType >::operator=(), BALL::MutablePower< Function, DataType >::operator==(), and BALL::MutablePower< Function, DataType >::setExponent().

template<typename Function, typename DataType = float>

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

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