STK::IMultiParameters< Parameters > Class Template Reference

Interface base class for the parameters of a multivariate model. More...

#include <STK_IMultiParameters.h>

Inheritance diagram for STK::IMultiParameters< Parameters >:

Public Member Functions
Range const &	range () const
void	resize (Range const &range)
	resize the parameters only if the range is modified, otherwise, stay with the current values.
Public Member Functions inherited from STK::IRecursiveTemplate< Parameters >
Parameters &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Parameters const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Parameters *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Parameters const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Parameters *	clone () const
	create a leaf using the copy constructor of the Derived class.
Parameters *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Protected Member Functions
	IMultiParameters ()
	default constructor.
	IMultiParameters (Range const &range)
	constructor with specified range
	IMultiParameters (IMultiParameters const &param)
	copy constructor.
	~IMultiParameters ()
	Destructor.
Protected Member Functions inherited from STK::IRecursiveTemplate< Parameters >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Private Attributes
Range	range_

Detailed Description

template<class Parameters>
class STK::IMultiParameters< Parameters >

Interface base class for the parameters of a multivariate model.

Definition at line 48 of file STK_IMultiParameters.h.

Constructor & Destructor Documentation

IMultiParameters() [1/3]

template<class Parameters >

STK::IMultiParameters< Parameters >::IMultiParameters ( )

inlineprotected

default constructor.

Definition at line 52 of file STK_IMultiParameters.h.

: range_() {}

IMultiParameters() [2/3]

template<class Parameters >

STK::IMultiParameters< Parameters >::IMultiParameters ( Range const &  range )

inlineprotected

constructor with specified range

Parameters

range

the range of the variables

Definition at line 56 of file STK_IMultiParameters.h.

: range_(range) {}

IMultiParameters() [3/3]

template<class Parameters >

STK::IMultiParameters< Parameters >::IMultiParameters ( IMultiParameters< Parameters > const &  param )

inlineprotected

copy constructor.

Definition at line 58 of file STK_IMultiParameters.h.

: range_(param.range_) {}

~IMultiParameters()

template<class Parameters >

STK::IMultiParameters< Parameters >::~IMultiParameters ( )

inlineprotected

Destructor.

Definition at line 60 of file STK_IMultiParameters.h.

{}

Member Function Documentation

range()

template<class Parameters >

Range const & STK::IMultiParameters< Parameters >::range ( ) const

inline

Returns

the range of the data set

Definition at line 64 of file STK_IMultiParameters.h.

{ return range_;}

References STK::IMultiParameters< Parameters >::range_.

Referenced by STK::IMultiParameters< Parameters >::resize().

resize()

template<class Parameters >

void STK::IMultiParameters< Parameters >::resize ( Range const &  range )

inline

resize the parameters only if the range is modified, otherwise, stay with the current values.

Parameters

range

the range of the parameters (= range of the variables of the model)

Definition at line 69 of file STK_IMultiParameters.h.

    { if (range != range_)
      { range_ = range;
        this->asDerived().resizeImpl(range);
      }
    }

References STK::IRecursiveTemplate< Parameters >::asDerived(), STK::IMultiParameters< Parameters >::range(), and STK::IMultiParameters< Parameters >::range_.

Member Data Documentation

range_

template<class Parameters >

Range STK::IMultiParameters< Parameters >::range_

private

Definition at line 77 of file STK_IMultiParameters.h.

Referenced by STK::IMultiParameters< Parameters >::range(), and STK::IMultiParameters< Parameters >::resize().

---

The documentation for this class was generated from the following file:

• STK_IMultiParameters.h