BALL  1.5.0
List of all members
BALL::CubicFunction< Function, DataType > Class Template Reference

#include <BALL/MATHS/function.h>

Public Member Functions

Constructors and destructor
 CubicFunction ()
 
 CubicFunction (const CubicFunction &cubic)
 
virtual ~CubicFunction ()
 
Assignment
CubicFunction< Function, DataType > & operator= (const CubicFunction< Function, DataType > &cubic)
 
Predicates
bool operator== (const CubicFunction< Function, DataType > &cubic) const
 
Function realization
BALL_INLINE DataType operator() (const DataType &x) const
 

Accessors

Function function_
 
void setFunction (const Function &function)
 
const Function & getFunction () const
 

Detailed Description

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

CubicFunction class.

Definition at line 794 of file function.h.

Constructor & Destructor Documentation

◆ CubicFunction() [1/2]

template<typename Function , typename DataType >
BALL_INLINE BALL::CubicFunction< Function, DataType >::CubicFunction

Default constructor

Definition at line 1223 of file function.h.

◆ CubicFunction() [2/2]

template<typename Function , typename DataType >
BALL_INLINE BALL::CubicFunction< Function, DataType >::CubicFunction ( const CubicFunction< Function, DataType > &  cubic)

Copy constructor

Definition at line 1230 of file function.h.

◆ ~CubicFunction()

template<typename Function , typename DataType >
BALL_INLINE BALL::CubicFunction< Function, DataType >::~CubicFunction
virtual

Destructor

Definition at line 1237 of file function.h.

Member Function Documentation

◆ getFunction()

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

get the function argument of the cubic

Returns
a const reference to the function argument

Definition at line 865 of file function.h.

◆ operator()()

template<typename Function , typename DataType = float>
BALL_INLINE DataType BALL::CubicFunction< Function, DataType >::operator() ( const DataType &  x) const
inline

Evaluation of this subterm

Parameters
xthe point where to evaluate
Returns
the function value

Definition at line 844 of file function.h.

◆ operator=()

template<typename Function , typename DataType >
BALL_INLINE CubicFunction< Function, DataType > & BALL::CubicFunction< Function, DataType >::operator= ( const CubicFunction< Function, DataType > &  cubic)

Assignment operator

Definition at line 1243 of file function.h.

◆ operator==()

template<typename Function , typename DataType >
BALL_INLINE bool BALL::CubicFunction< Function, DataType >::operator== ( const CubicFunction< Function, DataType > &  cubic) const

Equality operator

Definition at line 1251 of file function.h.

◆ setFunction()

template<typename Function , typename DataType = float>
void BALL::CubicFunction< Function, DataType >::setFunction ( const Function &  function)
inline

set the function argument of the cubic

Definition at line 857 of file function.h.

Member Data Documentation

◆ function_

template<typename Function , typename DataType = float>
Function BALL::CubicFunction< Function, DataType >::function_
protected

Definition at line 876 of file function.h.