TGradientStep< T > Class Template Reference

The TGradientStep class provides a mean of storing a gradient step.

Public Member Functions
	TGradientStep ()
	TGradientStep (ufloat iParam, const T &iValue)
	~TGradientStep ()
bool	operator< (const TGradientStep< T > &iOther)
bool	operator== (const TGradientStep< T > &iOther)
ufloat	Param () const
void	Param (ufloat iParam)
T &	Value ()
const T &	Value () const

Static Public Member Functions
static std::shared_ptr< TGradientStep< T > >	MakeShared (ufloat iParam, const T &iValue)

Constructor & Destructor Documentation

~TGradientStep()

template<typename T >

TGradientStep< T >::~TGradientStep ( )

inline

Destroy the gradient step.

TGradientStep() [1/2]

template<typename T >

TGradientStep< T >::TGradientStep ( )

inline

Construct gradient step.

TGradientStep() [2/2]

template<typename T >

TGradientStep< T >::TGradientStep ( ufloat  iParam, const T &  iValue  )

inline

Construct gradient step.

Member Function Documentation

MakeShared()

template<typename T >

static std::shared_ptr< TGradientStep< T > > TGradientStep< T >::MakeShared ( ufloat  iParam, const T &  iValue  )

inlinestatic

operator<()

template<typename T >

bool TGradientStep< T >::operator< ( const TGradientStep< T > &  iOther )

inline

operator==()

template<typename T >

bool TGradientStep< T >::operator== ( const TGradientStep< T > &  iOther )

inline

Param() [1/2]

template<typename T >

ufloat TGradientStep< T >::Param ( ) const

inline

Get the step.

Param() [2/2]

template<typename T >

void TGradientStep< T >::Param ( ufloat  iParam )

inline

Set the step.

Value() [1/2]

template<typename T >

T& TGradientStep< T >::Value ( )

inline

Get the value, editable.

Value() [2/2]

template<typename T >

const T& TGradientStep< T >::Value ( ) const

inline

Get the value.