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

Structure encapsulating the parameters of a Categorical_pk model. More...

#include <STK_CategoricalParameters.h>

Public Member Functions
	ModelParameters (int nbCluster)
	default constructor
	ModelParameters (ModelParameters const &param)
	copy constructor.
	~ModelParameters ()
	destructor
ModelParameters &	operator= (ModelParameters const &param)
	copy operator.
Real const &	proba (int k, int j, int l) const
CVectorX	proba (int k, int j) const
void	resize (Range const &rangeModalities, Range const &rangeCols)
	resize the set of parameter
void	updateStatistics ()
	update statistics of the parameters.
void	setStatistics ()
	set and release the computed statistics
void	releaseStatistics ()
	Set the computed statistics.
template<class Array >
void	setParameters (ExprBase< Array > const &params)
	Set the parameters of the mixture model.

Public Attributes
Array1D< CVectorX >	proba_
	array of size nbCluster with the probabilities of the variables
Array1D< Stat::Online< CVectorX, Real > >	stat_proba_
	array of size nbCluster with the statistics of the probabilities

Detailed Description

Structure encapsulating the parameters of a Categorical_pk model.

Definition at line 118 of file STK_CategoricalParameters.h.

Constructor & Destructor Documentation

ModelParameters() [1/2]

STK::ModelParameters< Clust::Categorical_pk_ >::ModelParameters

(

int

nbCluster

)

default constructor

Parameters

nbCluster

the number of class of the mixture

Definition at line 101 of file STK_CategoricalParameters.cpp.

               : proba_(nbCluster), stat_proba_(nbCluster) {}

ModelParameters() [2/2]

STK::ModelParameters< Clust::Categorical_pk_ >::ModelParameters

(

ModelParameters< Clust::Categorical_pk_ > const &

param

)

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 106 of file STK_CategoricalParameters.cpp.

               : proba_(param.proba_), stat_proba_(param.stat_proba_)
{}

~ModelParameters()

STK::ModelParameters< Clust::Categorical_pk_ >::~ModelParameters

(

)

destructor

Definition at line 110 of file STK_CategoricalParameters.cpp.

{}

Member Function Documentation

operator=()

ModelParameters< Clust::Categorical_pk_ > & STK::ModelParameters< Clust::Categorical_pk_ >::operator=

(

ModelParameters< Clust::Categorical_pk_ > const &

param

)

copy operator.

Parameters

param

the parameters to copy.

Definition at line 114 of file STK_CategoricalParameters.cpp.

{
  proba_      = param.proba_;
  stat_proba_ = param.stat_proba_;
  return *this;
}

proba() [1/2]

CVectorX STK::ModelParameters< Clust::Categorical_pk_ >::proba ( int  k, int  j  ) const

inline

Returns

the probabilities of the kth cluster for the jth variable

Definition at line 144 of file STK_CategoricalParameters.h.

{ return proba_[k];}

proba() [2/2]

Real const & STK::ModelParameters< Clust::Categorical_pk_ >::proba ( int  k, int  j, int  l  ) const

inline

Returns

the probability of the kth cluster, jth variable, lth modality

Definition at line 142 of file STK_CategoricalParameters.h.

{ return proba_[k][l];}

releaseStatistics()

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

(

)

Set the computed statistics.

Definition at line 146 of file STK_CategoricalParameters.cpp.

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

resize()

void STK::ModelParameters< Clust::Categorical_pk_ >::resize	(	Range const &	rangeModalities,
		Range const &	rangeCols
	)

resize the set of parameter

Parameters

rangeModalities	range of the modalities
rangeCols	range of the variables (not used)

Definition at line 122 of file STK_CategoricalParameters.cpp.

{
  for (int k = proba_.begin(); k< proba_.end(); ++k)
  {
    proba_[k].resize(rangeModalities) = 1./rangeModalities.size();
    stat_proba_[k].resize(rangeModalities);
  }
}

setParameters()

template<class Array >

void STK::ModelParameters< Clust::Categorical_pk_ >::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 165 of file STK_CategoricalParameters.h.

    {
      int kp = params.beginRows();
      for(int k=proba_.begin(); k<proba_.end(); ++k)
      {
        for (int l = proba_[k].beginRows(); l < proba_[k].endRows(); ++l, ++kp)
        {
          proba_[k][l] = 0.;
          for (int j = params.beginCols(); j < params.endCols(); ++j)
          { proba_[k][l] += params(kp , j) ;}
          proba_[k][l] /= proba_[k].sizeCols();
        }
      }
    }

setStatistics()

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

(

)

set and release the computed statistics

Definition at line 137 of file STK_CategoricalParameters.cpp.

{
  for(int k=stat_proba_.begin(); k<stat_proba_.end(); ++k)
  {
    proba_[k] = stat_proba_[k].mean();
    stat_proba_[k].release();
  }
}

updateStatistics()

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

(

)

update statistics of the parameters.

Definition at line 131 of file STK_CategoricalParameters.cpp.

{
  for(int k=stat_proba_.begin(); k<stat_proba_.end(); ++k)
  { stat_proba_[k].update(proba_[k]);}
}

Member Data Documentation

proba_

Array1D<CVectorX> STK::ModelParameters< Clust::Categorical_pk_ >::proba_

array of size nbCluster with the probabilities of the variables

Definition at line 121 of file STK_CategoricalParameters.h.

stat_proba_

Array1D< Stat::Online<CVectorX, Real> > STK::ModelParameters< Clust::Categorical_pk_ >::stat_proba_

array of size nbCluster with the statistics of the probabilities

Definition at line 123 of file STK_CategoricalParameters.h.

---

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

• STK_CategoricalParameters.h
• STK_CategoricalParameters.cpp