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

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

#include <STK_KernelParameters.h>

Public Member Functions
	ModelParameters (int nbCluster)
	default constructor
	ModelParameters (ModelParameters const &param)
	copy constructor.
	~ModelParameters ()
	destructor
Real const &	sigma2 (int k) const
Real const &	dim (int k) const
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 Attributes
Real	sigma2_
	variance of the variables
CPointX	dim_
	dimension of the gaussian kernel
Stat::Online< Real, Real >	stat_sigma2_
	sigma2 statistics
Array1D< Stat::Online< Real, Real > >	stat_dim_
	Array of the dim statistics.

Detailed Description

Structure encapsulating the parameters of a Kmm_s model.

Definition at line 53 of file STK_KernelParameters.h.

Constructor & Destructor Documentation

ModelParameters() [1/2]

STK::ModelParameters< Clust::Kmm_s_ >::ModelParameters

(

int

nbCluster

)

default constructor

Parameters

nbCluster

the number of class of the mixture

Definition at line 44 of file STK_KernelParameters.cpp.

               : sigma2_(1.), dim_(nbCluster, 10)
               , stat_sigma2_(), stat_dim_(nbCluster)
{}

ModelParameters() [2/2]

STK::ModelParameters< Clust::Kmm_s_ >::ModelParameters

(

ModelParameters< Clust::Kmm_s_ > const &

param

)

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 51 of file STK_KernelParameters.cpp.

               : sigma2_(param.sigma2_), dim_(param.dim_)
               , stat_sigma2_(param.stat_sigma2_)
               , stat_dim_(param.stat_dim_)
{}

~ModelParameters()

STK::ModelParameters< Clust::Kmm_s_ >::~ModelParameters

(

)

destructor

Definition at line 57 of file STK_KernelParameters.cpp.

{}

Member Function Documentation

dim()

Real const & STK::ModelParameters< Clust::Kmm_s_ >::dim ( int  k ) const

inline

Returns

the dimension of the kth cluster

Definition at line 79 of file STK_KernelParameters.h.

{ return dim_[k];}

releaseStatistics()

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

(

)

Release the computed statistics.

Definition at line 78 of file STK_KernelParameters.cpp.

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

setParameters()

template<class Array >

void STK::ModelParameters< Clust::Kmm_s_ >::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 sigma2 and dim parameters on consecutive rows. The number of column of params is the number of variables.

Definition at line 94 of file STK_KernelParameters.h.

    {
      sigma2_ = 0.;
      for(int k=dim_.begin(); k<dim_.end(); ++k)
      { sigma2_  += params(k, baseIdx)   ;
        dim_[k]  = params(k, baseIdx+1);
      }
      sigma2_ /= dim_.size();
    }

References STK::baseIdx.

setStatistics()

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

(

)

Set the computed statistics.

Definition at line 67 of file STK_KernelParameters.cpp.

{
  sigma2_ = stat_sigma2_.mean();
  stat_sigma2_.release();
  for(int k=stat_dim_.begin(); k<stat_dim_.end(); ++k)
  {
    dim_[k] = stat_dim_[k].mean();
    stat_dim_[k].release();
  }
}

sigma2()

Real const & STK::ModelParameters< Clust::Kmm_s_ >::sigma2 ( int  k ) const

inline

Returns

the standard deviation of the kth cluster

Definition at line 77 of file STK_KernelParameters.h.

{ return sigma2_;}

updateStatistics()

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

(

)

update statistics of the parameters.

Definition at line 60 of file STK_KernelParameters.cpp.

{
  stat_sigma2_.update(sigma2_);
  for(int k=stat_dim_.begin(); k<stat_dim_.end(); ++k)
  { stat_dim_[k].update(dim_[k]);}
}

Member Data Documentation

dim_

CPointX STK::ModelParameters< Clust::Kmm_s_ >::dim_

dimension of the gaussian kernel

Definition at line 58 of file STK_KernelParameters.h.

sigma2_

Real STK::ModelParameters< Clust::Kmm_s_ >::sigma2_

variance of the variables

Definition at line 56 of file STK_KernelParameters.h.

stat_dim_

Array1D< Stat::Online<Real, Real> > STK::ModelParameters< Clust::Kmm_s_ >::stat_dim_

Array of the dim statistics.

Definition at line 63 of file STK_KernelParameters.h.

stat_sigma2_

Stat::Online<Real, Real> STK::ModelParameters< Clust::Kmm_s_ >::stat_sigma2_

sigma2 statistics

Definition at line 61 of file STK_KernelParameters.h.

---

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

• STK_KernelParameters.h
• STK_KernelParameters.cpp