STK::ModelParameters< Clust::Gamma_ak_b_ > Struct Reference

Structure encapsulating the parameters of a Gamma_ak_b_ mixture model. More...

#include <STK_GammaParameters.h>

Inheritance diagram for STK::ModelParameters< Clust::Gamma_ak_b_ >:

Public Member Functions
	ModelParameters (int nbCluster)
	default constructor
	ModelParameters (ModelParameters const &param)
	copy constructor.
	~ModelParameters ()
	destructor
Real const &	shape (int k, int j) const
Real const &	scale (int k, int j) const
void	resize (Range const &range)
	resize and initialize the set of parameter.
void	updateStatistics ()
	update statistics of the parameters.
void	setStatistics ()
	Set the computed statistics.
void	releaseStatistics ()
	Release the computed statistics.
template<class Array >
void	setParameters (ExprBase< Array > const &params)
	Set the parameters of the mixture model.
Public Member Functions inherited from STK::ParametersGammaBase
	ParametersGammaBase (int nbCluster)
	default constructor
	ParametersGammaBase (ParametersGammaBase const &model)
	copy constructor
	~ParametersGammaBase ()
	destructor
ParametersGammaBase &	operator= (ParametersGammaBase const &other)
	copy operator
void	resize (Range const &range)

Public Attributes
Array1D< Real >	shape_
	shapes of the variables
Real	scale_
	scales of the variables
Array1D< Stat::Online< Real, Real > >	stat_shape_
	Array of the mean statistics.
Stat::Online< Real, Real >	stat_scale_
	Array of the standard deviation statistics.
Public Attributes inherited from STK::ParametersGammaBase
Array1D< CPointX >	mean_
	mean for each class
Array1D< CPointX >	meanLog_
	log-means for each class
Array1D< CPointX >	variance_
	variance for each class

Detailed Description

Structure encapsulating the parameters of a Gamma_ak_b_ mixture model.

Definition at line 558 of file STK_GammaParameters.h.

Constructor & Destructor Documentation

ModelParameters() [1/2]

STK::ModelParameters< Clust::Gamma_ak_b_ >::ModelParameters

(

int

nbCluster

)

default constructor

Parameters

nbCluster

the number of class of the mixture

Definition at line 536 of file STK_GammaParameters.cpp.

               : ParametersGammaBase(nbCluster)
               , shape_(nbCluster), scale_()
               , stat_shape_(nbCluster), stat_scale_()
{}

ModelParameters() [2/2]

STK::ModelParameters< Clust::Gamma_ak_b_ >::ModelParameters

(

ModelParameters< Clust::Gamma_ak_b_ > const &

param

)

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 544 of file STK_GammaParameters.cpp.

               : ParametersGammaBase(param)
               , shape_(param.shape_), scale_(param.scale_)
               , stat_shape_(param.stat_shape_), stat_scale_(param.stat_scale_)
{}

~ModelParameters()

STK::ModelParameters< Clust::Gamma_ak_b_ >::~ModelParameters

(

)

destructor

Definition at line 550 of file STK_GammaParameters.cpp.

{}

Member Function Documentation

releaseStatistics()

void STK::ModelParameters< Clust::Gamma_ak_b_ >::releaseStatistics

(

)

Release the computed statistics.

Definition at line 583 of file STK_GammaParameters.cpp.

{
  for(int k=stat_shape_.begin(); k<stat_shape_.end(); ++k)
  { stat_shape_[k].release();}
  stat_scale_.release();
}

resize()

void STK::ModelParameters< Clust::Gamma_ak_b_ >::resize

(

Range const &

range

)

resize and initialize the set of parameter.

Parameters

range

range of the variables in the data set

Definition at line 552 of file STK_GammaParameters.cpp.

{
  ParametersGammaBase::resize(range);
  scale_ = 1.;
  stat_scale_.release();
  for (int k = shape_.begin(); k< shape_.end(); ++k)
  {
    shape_[k] = 1.;
    stat_shape_[k].release();
  }
}

References STK::ParametersGammaBase::resize().

scale()

Real const & STK::ModelParameters< Clust::Gamma_ak_b_ >::scale ( int  k, int  j  ) const

inline

Returns

the standard deviation of the kth cluster and jth variable

Definition at line 583 of file STK_GammaParameters.h.

{ return scale_;}

setParameters()

template<class Array >

void STK::ModelParameters< Clust::Gamma_ak_b_ >::setParameters ( ExprBase< Array > const &  params )

inline

Set the parameters of the mixture model.

It is assumed that the array params store for each class the shapes and scales parameters on two consecutive rows. The number of column of params is the number of variables.

Definition at line 603 of file STK_GammaParameters.h.

    {
      scale_ = 0.;
      for(int k=shape_.begin(), kp= params.beginRows(); k<shape_.end(); ++k, kp+=2)
      {
        shape_[k] = params.row(kp).mean();
        scale_ += params.row(kp+1).mean();
      }
      scale_ /= shape_.size();
    }

setStatistics()

void STK::ModelParameters< Clust::Gamma_ak_b_ >::setStatistics

(

)

Set the computed statistics.

Definition at line 572 of file STK_GammaParameters.cpp.

{
  for(int k=stat_shape_.begin(); k<stat_shape_.end(); ++k)
  {
    shape_[k] = stat_shape_[k].mean();
    stat_shape_[k].release();
  }
  scale_ = stat_scale_.mean();
  stat_scale_.release();
}

shape()

Real const & STK::ModelParameters< Clust::Gamma_ak_b_ >::shape ( int  k, int  j  ) const

inline

Returns

the mean of the kth cluster and jth variable

Definition at line 581 of file STK_GammaParameters.h.

{ return shape_[k];}

updateStatistics()

void STK::ModelParameters< Clust::Gamma_ak_b_ >::updateStatistics

(

)

update statistics of the parameters.

Definition at line 565 of file STK_GammaParameters.cpp.

{
  for(int k=stat_shape_.begin(); k<stat_shape_.end(); ++k)
  { stat_shape_[k].update(shape_[k]);}
  stat_scale_.update(scale_);
}

Member Data Documentation

scale_

Real STK::ModelParameters< Clust::Gamma_ak_b_ >::scale_

scales of the variables

Definition at line 563 of file STK_GammaParameters.h.

shape_

Array1D<Real> STK::ModelParameters< Clust::Gamma_ak_b_ >::shape_

shapes of the variables

Definition at line 561 of file STK_GammaParameters.h.

stat_scale_

Stat::Online<Real, Real> STK::ModelParameters< Clust::Gamma_ak_b_ >::stat_scale_

Array of the standard deviation statistics.

Definition at line 567 of file STK_GammaParameters.h.

stat_shape_

Array1D< Stat::Online<Real, Real> > STK::ModelParameters< Clust::Gamma_ak_b_ >::stat_shape_

Array of the mean statistics.

Definition at line 565 of file STK_GammaParameters.h.

---

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

• STK_GammaParameters.h
• STK_GammaParameters.cpp