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

#include <BALL/MATHS/function.h>

List of all members.

Public Member Functions
Constructors and destructor
	SquareFunction ()
	SquareFunction (const SquareFunction &square)
virtual	~SquareFunction ()
Assignment
SquareFunction< Function, DataType > &	operator= (const SquareFunction< Function, DataType > &square)
Predicates
bool	operator== (const SquareFunction< Function, DataType > &square) 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::SquareFunction< Function, DataType >

SquareFunction class.

---

Constructor & Destructor Documentation

template<typename Function , typename DataType >

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

(

)

[inline]

Default constructor

template<typename Function , typename DataType >

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

(

const SquareFunction< Function, DataType > &

square

)

[inline]

Copy constructor

template<typename Function , typename DataType >

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

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

template<typename Function, typename DataType = float>

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

(

)

const [inline]

get the function argument of the square

Returns:

a const reference to the function argument

template<typename Function, typename DataType = float>

BALL_INLINE DataType BALL::SquareFunction< 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 SquareFunction< Function, DataType > & BALL::SquareFunction< Function, DataType >::operator=

(

const SquareFunction< Function, DataType > &

square

)

[inline]

Assignment operator

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

template<typename Function , typename DataType >

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

(

const SquareFunction< Function, DataType > &

square

)

const [inline]

Equality operator

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

template<typename Function, typename DataType = float>

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

(

const Function &

function

)

[inline]

set the function argument of the square

---

Member Data Documentation

template<typename Function, typename DataType = float>

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

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