STK::ModelGamma_aj_bjParameters Struct Reference

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

#include <STK_ModelGamma_aj_bj.h>

Public Member Functions
	ModelGamma_aj_bjParameters ()
	default constructor
	ModelGamma_aj_bjParameters (Range const &range)
	default constructor
	ModelGamma_aj_bjParameters (ModelGamma_aj_bjParameters const &param)
	copy constructor.
	~ModelGamma_aj_bjParameters ()
	destructor
CPointX const &	shape () const
CPointX const &	scale () const
	vector of the mean log of the observations
void	resize (Range const &range)
	resize the parameters only if the range is modified, otherwise, stay with the current values.

Public Attributes
CPointX	shape_
	vector of the shape
CPointX	scale_
	vector of the scale
CPointX	mean_
	vector of the mean of the observations
CPointX	meanLog_
	vector of the mean log of the observations
CPointX	variance_
	vector of the variance of the observations
Range	range_

Detailed Description

Structure encapsulating the parameters of a Joint Gamma model.

See also

GammaComponent, ModelGamma_aj_bj

Definition at line 81 of file STK_ModelGamma_aj_bj.h.

Constructor & Destructor Documentation

ModelGamma_aj_bjParameters() [1/3]

STK::ModelGamma_aj_bjParameters::ModelGamma_aj_bjParameters ( )

inline

default constructor

Definition at line 84 of file STK_ModelGamma_aj_bj.h.

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

ModelGamma_aj_bjParameters() [2/3]

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

inline

default constructor

Definition at line 86 of file STK_ModelGamma_aj_bj.h.

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

ModelGamma_aj_bjParameters() [3/3]

STK::ModelGamma_aj_bjParameters::ModelGamma_aj_bjParameters ( ModelGamma_aj_bjParameters const &  param )

inline

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 91 of file STK_ModelGamma_aj_bj.h.

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

~ModelGamma_aj_bjParameters()

STK::ModelGamma_aj_bjParameters::~ModelGamma_aj_bjParameters ( )

inline

destructor

Definition at line 96 of file STK_ModelGamma_aj_bj.h.

{}

Member Function Documentation

resize()

void STK::ModelGamma_aj_bjParameters::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 106 of file STK_ModelGamma_aj_bj.h.

  {
    if (range != range_)
    {
      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.;
      range_ = range;
    }
  }

References mean_, meanLog_, range_, STK::ICArray< Derived >::resize(), scale_, shape_, and variance_.

scale()

CPointX const & STK::ModelGamma_aj_bjParameters::scale ( ) const

inline

vector of the mean log of the observations

Definition at line 100 of file STK_ModelGamma_aj_bj.h.

{return scale_;}

References scale_.

shape()

CPointX const & STK::ModelGamma_aj_bjParameters::shape ( ) const

inline

Returns

the vector of the mean of the observations

Definition at line 98 of file STK_ModelGamma_aj_bj.h.

{return shape_;}

References shape_.

Member Data Documentation

mean_

CPointX STK::ModelGamma_aj_bjParameters::mean_

vector of the mean of the observations

Definition at line 123 of file STK_ModelGamma_aj_bj.h.

Referenced by resize().

meanLog_

CPointX STK::ModelGamma_aj_bjParameters::meanLog_

vector of the mean log of the observations

Definition at line 125 of file STK_ModelGamma_aj_bj.h.

Referenced by resize().

range_

Range STK::ModelGamma_aj_bjParameters::range_

Definition at line 128 of file STK_ModelGamma_aj_bj.h.

Referenced by resize().

scale_

CPointX STK::ModelGamma_aj_bjParameters::scale_

vector of the scale

Definition at line 121 of file STK_ModelGamma_aj_bj.h.

Referenced by resize(), and scale().

shape_

CPointX STK::ModelGamma_aj_bjParameters::shape_

vector of the shape

Definition at line 119 of file STK_ModelGamma_aj_bj.h.

Referenced by resize(), and shape().

variance_

CPointX STK::ModelGamma_aj_bjParameters::variance_

vector of the variance of the observations

Definition at line 127 of file STK_ModelGamma_aj_bj.h.

Referenced by resize().

---

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

• STK_ModelGamma_aj_bj.h