STK::JointGammaParameters Struct Reference

Structure encapsulating the parameters of a Joint Gamma model. More...

#include <STK_JointGammaModel.h>

Inheritance diagram for STK::JointGammaParameters:

Public Member Functions
	JointGammaParameters ()
	default constructor
	JointGammaParameters (Range const &range)
	default constructor
	JointGammaParameters (JointGammaParameters const &param)
	copy constructor.
	~JointGammaParameters ()
	destructor
Real	shape (int j) const
Real	scale (int j) const
void	resizeImpl (Range const &range)
	resize the set of parameter
Public Member Functions inherited from STK::IMultiParameters< JointGammaParameters >
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< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	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.

Public Attributes
Array2DPoint< Real >	shape_
	vector of the shape
Array2DPoint< Real >	scale_
	vector of the scale
Array2DPoint< Real >	mean_
	vector of the mean of the observations
Array2DPoint< Real >	meanLog_
	vector of the mean log of the observations
Array2DPoint< Real >	variance_
	vector of the variance of the observations

Additional Inherited Members
Protected Member Functions inherited from STK::IMultiParameters< JointGammaParameters >
	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< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

Structure encapsulating the parameters of a Joint Gamma model.

See also

GammaComponent, JointGammaModel

Definition at line 56 of file STK_JointGammaModel.h.

Constructor & Destructor Documentation

JointGammaParameters() [1/3]

STK::JointGammaParameters::JointGammaParameters ( )

inline

default constructor

Definition at line 59 of file STK_JointGammaModel.h.

: shape_(), scale_(), mean_(), meanLog_(), variance_() {}

JointGammaParameters() [2/3]

STK::JointGammaParameters::JointGammaParameters ( Range const &  range )

inline

default constructor

Definition at line 61 of file STK_JointGammaModel.h.

                      : shape_(range, 1.), scale_(range, 1.)
                      , mean_(range, 1.), meanLog_(range, 0.), variance_(range, 1.)
  {}

JointGammaParameters() [3/3]

STK::JointGammaParameters::JointGammaParameters ( JointGammaParameters const &  param )

inline

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 66 of file STK_JointGammaModel.h.

                      : shape_(param.shape_), scale_(param.scale_)
                      , mean_(param.mean_), meanLog_(param.meanLog_), variance_(param.variance_)
  {}

~JointGammaParameters()

STK::JointGammaParameters::~JointGammaParameters ( )

inline

destructor

Definition at line 71 of file STK_JointGammaModel.h.

{}

Member Function Documentation

resizeImpl()

void STK::JointGammaParameters::resizeImpl ( Range const &  range )

inline

resize the set of parameter

Parameters

range

range of the parameters

Definition at line 79 of file STK_JointGammaModel.h.

  {
    shape_.resize(range); shape_ = 1.;
    scale_.resize(range); scale_ = 1.;
    mean_.resize(range); mean_ = 1.;
    meanLog_.resize(range); meanLog_ = 0.;
    variance_.resize(range); variance_ = 1.;
  }

References mean_, meanLog_, STK::IMultiParameters< JointGammaParameters >::range(), STK::IArray2D< Derived >::resize(), scale_, shape_, and variance_.

scale()

Real STK::JointGammaParameters::scale ( int  j ) const

inline

Returns

the j-th scale value

Definition at line 75 of file STK_JointGammaModel.h.

{return scale_[j];}

References scale_.

shape()

Real STK::JointGammaParameters::shape ( int  j ) const

inline

Returns

the j-th shape value

Definition at line 73 of file STK_JointGammaModel.h.

{return shape_[j];}

References shape_.

Member Data Documentation

mean_

Array2DPoint<Real> STK::JointGammaParameters::mean_

vector of the mean of the observations

Definition at line 92 of file STK_JointGammaModel.h.

Referenced by resizeImpl().

meanLog_

Array2DPoint<Real> STK::JointGammaParameters::meanLog_

vector of the mean log of the observations

Definition at line 94 of file STK_JointGammaModel.h.

Referenced by resizeImpl().

scale_

Array2DPoint<Real> STK::JointGammaParameters::scale_

vector of the scale

Definition at line 90 of file STK_JointGammaModel.h.

Referenced by resizeImpl(), and scale().

shape_

Array2DPoint<Real> STK::JointGammaParameters::shape_

vector of the shape

Definition at line 88 of file STK_JointGammaModel.h.

Referenced by resizeImpl(), and shape().

variance_

Array2DPoint<Real> STK::JointGammaParameters::variance_

vector of the variance of the observations

Definition at line 96 of file STK_JointGammaModel.h.

Referenced by resizeImpl().

---

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

• STK_JointGammaModel.h