structure storing the parameters of the HD matrix valued mixture More...

#include <STK_HDMatrixGaussianParameters.h>

Public Member Functions
	HDMatrixModelParameters (int nbCluster)
	default constructor

	HDMatrixModelParameters (HDMatrixModelParameters const &param)
	copy constructor.

	~HDMatrixModelParameters ()
	destructor

HDMatrixModelParameters &	operator= (HDMatrixModelParameters const &param)
	copy operator.

void	resize (Range const &rangeRows, Range const &rangeCols)
	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 Attributes
Array1D< Array_ >	meank_
	array of size nbCluster with for each cluster the mean matrix

Array1D< CSquareX >	rowQk_
	array of size nbCluster with the rotation matrix for rows

Array1D< CVectorX >	rowAjk_
	array of size nbCluster with inertia in low dimensional space for rows

Array1D< Real >	rowBk_
	array of size nbCluster with remaining variance noise for rows

CVectorXi	rowDk_
	array of size nbCluster with dimension of low dimensional space for rows

Array1D< CSquareX >	colQk_
	array of size nbCluster with the rotation matrix for columns

Array1D< CVectorX >	colAjk_
	array of size nbCluster with inertia in low dimensional space for columns

Array1D< Real >	colBk_
	array of size nbCluster with variance noise for columns

CVectorXi	colDk_
	array of size nbCluster with dimension of low dimensional space for columns

Array1D< Stat::Online< Array_, Real > >	statMeank_
	Array of size nbCluster of the mean statistics.

Array1D< Stat::Online< CSquareX, Real > >	statRowQk_
	Array of size nbCluster of the rotation matrix statistics for rows.

Array1D< Stat::Online< CVectorX, Real > >	statRowAjk_
	Array of size nbCluster of the rotation matrix statistics for rows.

Array1D< Stat::Online< Real, Real > >	statRowBk_
	Array of size nbCluster with the variance noise statistics for rows.

Array1D< Stat::Online< CSquareX, Real > >	statColQk_
	Array of the rotation matrix statistics for rows.

Array1D< Stat::Online< CVectorX, Real > >	statColAjk_
	Array of the standard deviation statistics.

Array1D< Stat::Online< Real, Real > >	statColBk_
	Array of the standard deviation statistics.

Detailed Description

template<class Array_>
struct STK::HDMatrixModelParameters< Array_ >

structure storing the parameters of the HD matrix valued mixture

struct storing the parameters of the matrix valued mixture.

Parameters of a matrix mixture model have two Id defined in STK::Clust::HDCovarianceModel enumeration.

Definition at line 54 of file STK_HDMatrixGaussianParameters.h.

Constructor & Destructor Documentation

◆ HDMatrixModelParameters() [1/2]

template<class Array_ >

STK::HDMatrixModelParameters< Array_ >::HDMatrixModelParameters ( int nbCluster )

inline

default constructor

Parameters

nbCluster the number of class of the mixture

Definition at line 99 of file STK_HDMatrixGaussianParameters.h.

                           : meank_(nbCluster)
                           , rowQk_(nbCluster), rowAjk_(nbCluster)
                           , rowBk_(nbCluster), rowDk_(nbCluster)
                           , colQk_(nbCluster), colAjk_(nbCluster)
                           , colBk_(nbCluster), colDk_(nbCluster)
                           , statMeank_(nbCluster)
                           , statRowQk_(nbCluster), statRowAjk_(nbCluster)
                           , statRowBk_(nbCluster)
                           , statColQk_(nbCluster), statColAjk_(nbCluster)
                           , statColBk_(nbCluster)
    {}

◆ HDMatrixModelParameters() [2/2]

template<class Array_ >

STK::HDMatrixModelParameters< Array_ >::HDMatrixModelParameters ( HDMatrixModelParameters< Array_ > const & param )

inline

copy constructor.

Parameters

param the parameters to copy.

Definition at line 114 of file STK_HDMatrixGaussianParameters.h.

                           : meank_(param.meank_)
                           , rowQk_(param.rowQk_), rowAjk_(param.rowAjk_)
                           , rowBk_(param.rowBk_), rowDk_(param.rowDk_)
                           , colQk_(param.colQk_), colAjk_(param.colAjk_)
                           , colBk_(param.colBk_), colDk_(param.colDk_)
                           , statMeank_(param.statMeank_)
                           , statRowQk_(param.statRowQk_), statRowAjk_(param.statRowAjk_)
                           , statRowBk_(param.statRowBk_)
                           , statColQk_(param.statColQk_), statColAjk_(param.statColAjk_)
                           , statColBk_(param.statColBk_)
    {}

◆ ~HDMatrixModelParameters()

template<class Array_ >

STK::HDMatrixModelParameters< Array_ >::~HDMatrixModelParameters ( )

inline

destructor

Definition at line 127 of file STK_HDMatrixGaussianParameters.h.

127{}

Member Function Documentation

◆ operator=()

template<class Array_ >

HDMatrixModelParameters & STK::HDMatrixModelParameters< Array_ >::operator= ( HDMatrixModelParameters< Array_ > const & param )

inline

copy operator.

Parameters

param the parameters to copy.

Definition at line 131 of file STK_HDMatrixGaussianParameters.h.

    {
      meank_ = param.meank_;
      rowQk_ = param.rowQk_; rowAjk_ = param.rowAjk_;
      rowBk_ = param.rowBk_; rowDk_  = param.rowDk_;
      colQk_ = param.colQk_; colAjk_ = param.colAjk_;
      colBk_ = param.colBk_; colDk_  = param.colDk_;
      statMeank_ = param.statMeank_;
      statRowQk_ = param.statRowQk_; statRowAjk_ = param.statRowAjk_;
      statRowBk_ = param.statRowBk_;
      statColQk_ = param.statColQk_; statColAjk_ = param.statColAjk_;
      statColBk_ = param.statColBk_;
    }

◆ releaseStatistics()

template<class Array_ >

void STK::HDMatrixModelParameters< Array_ >::releaseStatistics ( )

inline

Release the computed statistics.

Definition at line 180 of file STK_HDMatrixGaussianParameters.h.

    {
      for(int k=statMeank_.begin(); k<statMeank_.end(); ++k)
      {
        statMeank_[k].release();
        statRowQk_[k].release();
        statRowAjk_[k].release();
        statRowBk_[k].release();
        statColQk_[k].release();
        statColAjk_[k].release();
        statColBk_[k].release();
      }
    }

References STK::HDMatrixModelParameters< Array_ >::statColAjk_, STK::HDMatrixModelParameters< Array_ >::statColBk_, STK::HDMatrixModelParameters< Array_ >::statColQk_, STK::HDMatrixModelParameters< Array_ >::statMeank_, STK::HDMatrixModelParameters< Array_ >::statRowAjk_, STK::HDMatrixModelParameters< Array_ >::statRowBk_, and STK::HDMatrixModelParameters< Array_ >::statRowQk_.

Referenced by STK::HDMatrixModelParameters< Array_ >::setStatistics().

◆ resize()

template<class Array_ >

void STK::HDMatrixModelParameters< Array_ >::resize	(	Range const &	rangeRows,
		Range const &	rangeCols
	)

resize and initialize the set of parameter.

Parameters

range range of the variables in the data set

◆ setParameters()

template<class Array_ >

template<class Array >

void STK::HDMatrixModelParameters< Array_ >::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 mean and sd parameters on two consecutive rows. The number of column of params is the number of variables.

Definition at line 199 of file STK_HDMatrixGaussianParameters.h.

200 {}

◆ setStatistics()

template<class Array_ >

void STK::HDMatrixModelParameters< Array_ >::setStatistics ( )

inline

Set the computed statistics.

Definition at line 165 of file STK_HDMatrixGaussianParameters.h.

    {
      for(int k=statMeank_.begin(); k<statMeank_.end(); ++k)
      {
        meank_[k]  = statMeank_[k].mean();
        rowQk_[k]  = statRowQk_[k].mean();
        rowAjk_[k] = statRowAjk_[k].mean();
        rowBk_[k]  = statRowBk_[k].mean();
        colQk_[k]  = statColQk_[k].mean();
        colAjk_[k] = statColAjk_[k].mean();
        colBk_[k]  = statColBk_[k].mean();
      }
      releaseStatistics();
    }

◆ updateStatistics()

template<class Array_ >

void STK::HDMatrixModelParameters< Array_ >::updateStatistics ( )

inline

update statistics of the parameters.

Definition at line 151 of file STK_HDMatrixGaussianParameters.h.

    {
      for(int k=statMeank_.begin(); k<statMeank_.end(); ++k)
      {
        statMeank_[k].update(meank_[k]);
        statRowQk_[k].update(rowQk_[k]);
        statRowAjk_[k].update(rowAjk_[k]);
        statRowBk_[k].update(rowBk_[k]);
        statColQk_[k].update(colQk_[k]);
        statColAjk_[k].update(colAjk_[k]);
        statColBk_[k].update(colBk_[k]);
      }
    }