Interface base class for all the mixture models that will be processed by the composer. More...

#include <STK_IMixture.h>

Inheritance diagram for STK::IMixture:

Public Member Functions
	IMixture (String const &idData=String())
	Constructor with identification character.

	IMixture (IMixture const &mixture)
	copy constructor.

virtual	~IMixture ()
	Virtual destructor.

String const &	idData () const

IMixtureStatModel const *const	p_composer () const

void	setMixtureModel (IMixtureStatModel const *p_composer)
	set the mixture composer to the mixture

virtual IMixture *	clone () const =0
	This is a standard clone function in usual sense.

virtual IMixture *	create () const =0
	This is a standard create function in usual sense.

virtual void	initializeStep ()=0
	This function must be defined in derived class for initialization of the mixture parameters.

virtual void	randomInit ()=0
	This function should be used in order to initialize randomly the parameters of the mixture.

virtual void	paramUpdateStep ()=0
	This function is equivalent to mStep and must be defined to update parameters.

virtual Real	lnComponentProbability (int sample_num, int Cluster_num)=0
	This function must be defined to return the posterior probability (PDF) for corresponding sample_num and Cluster_num.

virtual int	nbFreeParameter () const =0
	This function must return the number of free parameters.

virtual int	nbMissingValues () const =0
	This function must return the number of missing value in data set identified by idData_.

virtual void	imputationStep ()
	This function should be used for Imputation of data.

virtual void	samplingStep ()
	This function must be defined for simulation of all the latent variables and/or missing data excluding class labels.

virtual void	storeIntermediateResults (int iteration)
	This function should be used to store any intermediate results during various iterations after the burn-in period.

virtual void	releaseIntermediateResults ()
	This step can be used to signal to the mixtures that they must release the stored results.

virtual void	setParametersStep ()
	set the parameters of the model.

virtual void	finalizeStep ()
	This step can be used by developer to finalize any thing.

virtual void	writeParameters (std::ostream &out) const
	This function can be used to write summary of parameters on to the output stream.

Protected Member Functions
int	nbSample () const
	This function can be used in derived classes to get number of samples.

int	nbCluster () const
	This function can be used in derived classes to get number of classes.

CPointX const *	p_pk () const
	This function can be used in derived classes to get estimated number of individuals from the framework.

CPointX const *	p_tk () const
	This function can be used in derived classes to get proportions from the framework.

CArrayXX const *	p_tik () const
	This function can be used in derived classes to get posterior probabilities from the framework.

CVectorXi const *	p_zi () const
	This function can be used in derived classes to get class labels from the framework.

Private Attributes
const IMixtureStatModel *	p_composer_
	pointer on the main composer model

String	idData_
	Id name of the mixture.

Detailed Description

Interface base class for all the mixture models that will be processed by the composer.

Any mixture that can be used and add to a mixed model have to implement the pure virtual methods defined in this interface. With each mixture is associated a data set identified by an idData string.

Using an idData is not mandatory but is useful in case data set is stored in a DataHandler.

See also: STK::IDataHandler

Definition at line 64 of file STK_IMixture.h.

Constructor & Destructor Documentation

◆ IMixture() [1/2]

STK::IMixture::IMixture ( String const & idData = String() )

Constructor with identification character.

Parameters

idData Identification string of the data associated to this mixture.

Note: The Id is provided by the framework if the associated data set is in a STK::IDataHandler struct.

Definition at line 45 of file STK_IMixture.cpp.

46 : p_composer_(0), idData_(idData)

47{}

STK::IMixture::p_composer_

const IMixtureStatModel * p_composer_

pointer on the main composer model

Definition STK_IMixture.h:207

STK::IMixture::idData_

String idData_

Id name of the mixture.

Definition STK_IMixture.h:209

STK::IMixture::idData

String const & idData() const

Definition STK_IMixture.h:82

◆ IMixture() [2/2]

STK::IMixture::IMixture ( IMixture const & mixture )

copy constructor.

Warning: The pointer on the composer is not copied and is set to 0: it has to be set again.

Parameters

mixture the mixture to copy

Definition at line 50 of file STK_IMixture.cpp.

                  : p_composer_(0)
                  , idData_(mixture.idData_)
{}

◆ ~IMixture()

STK::IMixture::~IMixture ( )

virtual

Virtual destructor.

Definition at line 55 of file STK_IMixture.cpp.

55{}

Member Function Documentation

◆ clone()

virtual IMixture * STK::IMixture::clone ( ) const

pure virtual

This is a standard clone function in usual sense.

It must be defined to provide new object of your class with values of various parameters equal to the values of calling object. In other words, this is equivalent to polymorphic copy constructor.

Returns: New instance of class as that of calling object.

Implemented in STK::CategoricalBridge< Id, Data >, STK::DiagGaussianBridge< Id, Data >, STK::GammaBridge< Id, Data >, STK::HDMatrixGaussianBridge< IdRow, IdCol, Data >, STK::HDGaussianBridge< Id, Data >, STK::KmmBridge< Id, Data >, and STK::PoissonBridge< Id, Data >.

◆ create()

virtual IMixture * STK::IMixture::create ( ) const

pure virtual

This is a standard create function in usual sense.

It must be defined to provide new object of your class with correct behavior. In other words, this is equivalent to virtual constructor.

Returns: New instance of class as that of calling object.

Implemented in STK::CategoricalBridge< Id, Data >, STK::DiagGaussianBridge< Id, Data >, STK::GammaBridge< Id, Data >, STK::HDMatrixGaussianBridge< IdRow, IdCol, Data >, STK::HDGaussianBridge< Id, Data >, STK::KmmBridge< Id, Data >, and STK::PoissonBridge< Id, Data >.

◆ finalizeStep()

virtual void STK::IMixture::finalizeStep ( )

inlinevirtual

This step can be used by developer to finalize any thing.

It will be called only once after we finish running the estimation algorithm.

Do nothing by default

Reimplemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 167 of file STK_IMixture.h.

167{}

◆ idData()

String const & STK::IMixture::idData ( ) const

inline

Returns: the Id data of the mixture

Definition at line 82 of file STK_IMixture.h.

82{ return idData_;}

References idData_.

Referenced by STK::CategoricalBridge< Id, Data >::create(), STK::DiagGaussianBridge< Id, Data >::create(), STK::GammaBridge< Id, Data >::create(), STK::HDMatrixGaussianBridge< IdRow, IdCol, Data >::create(), STK::HDGaussianBridge< Id, Data >::create(), STK::KmmBridge< Id, Data >::create(), and STK::PoissonBridge< Id, Data >::create().

◆ imputationStep()

virtual void STK::IMixture::imputationStep ( )

inlinevirtual

This function should be used for Imputation of data.

The default implementation (in the base class) is to do nothing.

Do nothing by default

Reimplemented in STK::KmmBridge< Id, Data >, STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 140 of file STK_IMixture.h.

140{}

◆ initializeStep()

virtual void STK::IMixture::initializeStep ( )

pure virtual

This function must be defined in derived class for initialization of the mixture parameters.

This method should create any container needed by the model, resize them and initialize them. Since this method can be used when create is called, its main purpose should be to reset the mixture parameters, while leaving the data unchanged. This function will be called once the model is created and data is set.

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ lnComponentProbability()

virtual Real STK::IMixture::lnComponentProbability	(	int	sample_num,
		int	Cluster_num
	)

pure virtual

This function must be defined to return the posterior probability (PDF) for corresponding sample_num and Cluster_num.

Parameters

sample_num	Sample number
Cluster_num	Cluster number

Returns: the value of component probability in log scale

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ nbCluster()

int STK::IMixture::nbCluster ( ) const

protected

This function can be used in derived classes to get number of classes.

Returns: Number of classes.

Definition at line 68 of file STK_IMixture.cpp.

68{ return p_composer_->nbCluster();}

References p_composer_.

Referenced by STK::CategoricalBridge< Id, Data >::create(), STK::DiagGaussianBridge< Id, Data >::create(), STK::GammaBridge< Id, Data >::create(), STK::HDMatrixGaussianBridge< IdRow, IdCol, Data >::create(), STK::HDGaussianBridge< Id, Data >::create(), STK::KmmBridge< Id, Data >::create(), and STK::PoissonBridge< Id, Data >::create().

◆ nbFreeParameter()

virtual int STK::IMixture::nbFreeParameter ( ) const

pure virtual

This function must return the number of free parameters.

Returns: Number of free parameters

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ nbMissingValues()

virtual int STK::IMixture::nbMissingValues ( ) const

pure virtual

This function must return the number of missing value in data set identified by idData_.

Returns: Number of missing values

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ nbSample()

int STK::IMixture::nbSample ( ) const

protected

This function can be used in derived classes to get number of samples.

Returns: Number of samples.

Definition at line 64 of file STK_IMixture.cpp.

64{ return p_composer_->nbSample();}

References p_composer_.

◆ p_composer()

IMixtureStatModel const *const STK::IMixture::p_composer ( ) const

inline

Returns: A constant pointer on the composer.

Definition at line 84 of file STK_IMixture.h.

84{ return p_composer_;}

References p_composer_.

Referenced by STK::IMixtureBridge< Derived >::initializeStep(), and setMixtureModel().

◆ p_pk()

CPointX const * STK::IMixture::p_pk ( ) const

protected

This function can be used in derived classes to get estimated number of individuals from the framework.

Returns: Pointer to the number of individuals.

Definition at line 73 of file STK_IMixture.cpp.

73{ return &(p_composer_->pk());}

References p_composer_.

◆ p_tik()

CArrayXX const * STK::IMixture::p_tik ( ) const

protected

This function can be used in derived classes to get posterior probabilities from the framework.

Returns: Pointer to tik.

Definition at line 81 of file STK_IMixture.cpp.

81{ return &(p_composer_->tik());}

References p_composer_.

Referenced by STK::IMixtureBridge< Derived >::paramUpdateStep(), STK::IMixtureBridge< Derived >::randomInit(), and STK::IMixtureBridge< Derived >::writeParameters().

◆ p_tk()

CPointX const * STK::IMixture::p_tk ( ) const

protected

This function can be used in derived classes to get proportions from the framework.

Returns: Pointer to proportions.

Definition at line 77 of file STK_IMixture.cpp.

77{ return &(p_composer_->tk());}

References p_composer_.

Referenced by STK::IMixtureBridge< Derived >::paramUpdateStep(), and STK::IMixtureBridge< Derived >::randomInit().

◆ p_zi()

CVectorXi const * STK::IMixture::p_zi ( ) const

protected

This function can be used in derived classes to get class labels from the framework.

Returns: Pointer to zi.

Definition at line 85 of file STK_IMixture.cpp.

85{ return &(p_composer_->zi());}

References p_composer_.

◆ paramUpdateStep()

virtual void STK::IMixture::paramUpdateStep ( )

pure virtual

This function is equivalent to mStep and must be defined to update parameters.

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ randomInit()

virtual void STK::IMixture::randomInit ( )

pure virtual

This function should be used in order to initialize randomly the parameters of the mixture.

Implemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

◆ releaseIntermediateResults()

virtual void STK::IMixture::releaseIntermediateResults ( )

inlinevirtual

This step can be used to signal to the mixtures that they must release the stored results.

This is usually called if the estimation process failed.

Do nothing by default

Reimplemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 157 of file STK_IMixture.h.

157{}

◆ samplingStep()

virtual void STK::IMixture::samplingStep ( )

inlinevirtual

This function must be defined for simulation of all the latent variables and/or missing data excluding class labels.

The class labels will be simulated by the framework itself because to do so we have to take into account all the mixture laws.

Do nothing by default

Reimplemented in STK::KmmBridge< Id, Data >, STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 146 of file STK_IMixture.h.

146{};

◆ setMixtureModel()

void STK::IMixture::setMixtureModel ( IMixtureStatModel const * p_composer )

set the mixture composer to the mixture

Parameters

p_composer the composer to set

Definition at line 58 of file STK_IMixture.cpp.

58{ p_composer_ = p_composer;}

STK::IMixture::p_composer

IMixtureStatModel const *const p_composer() const

Definition STK_IMixture.h:84

References p_composer(), and p_composer_.

◆ setParametersStep()

virtual void STK::IMixture::setParametersStep ( )

inlinevirtual

set the parameters of the model.

This function should be used to set the parameters computed using the intermediate results. This method will be called after the long-run and before the finalize step.

Do nothing by default

Reimplemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 163 of file STK_IMixture.h.

163{}

◆ storeIntermediateResults()

virtual void STK::IMixture::storeIntermediateResults ( int iteration )

inlinevirtual

This function should be used to store any intermediate results during various iterations after the burn-in period.

Parameters

iteration Provides the iteration number beginning after the burn-in period.

Do nothing by default

Reimplemented in STK::IMixtureBridge< Derived >, STK::IMixtureBridge< CategoricalBridge< Id, Data > >, STK::IMixtureBridge< DiagGaussianBridge< Id, Data > >, STK::IMixtureBridge< GammaBridge< Id, Data > >, STK::IMixtureBridge< HDGaussianBridge< Id, Data > >, STK::IMixtureBridge< HDMatrixGaussianBridge< IdRow, IdCol, Data > >, STK::IMixtureBridge< KmmBridge< Id, Data > >, and STK::IMixtureBridge< PoissonBridge< Id, Data > >.

Definition at line 152 of file STK_IMixture.h.

152{}

◆ writeParameters()

virtual void STK::IMixture::writeParameters ( std::ostream & out ) const

inlinevirtual

This function can be used to write summary of parameters on to the output stream.

Parameters

out	Stream where you want to write the summary of parameters.

Definition at line 171 of file STK_IMixture.h.

    {
#ifdef STK_MIXTURE_DEBUG
    stk_cout<< _T("You need to override this method in your mixture!");
#endif
    }

References _T, and stk_cout.

Member Data Documentation

◆ idData_

String STK::IMixture::idData_

private

Id name of the mixture.

Definition at line 209 of file STK_IMixture.h.

Referenced by idData().

◆ p_composer_

const IMixtureStatModel* STK::IMixture::p_composer_

private

pointer on the main composer model

Definition at line 207 of file STK_IMixture.h.

Referenced by nbCluster(), nbSample(), p_composer(), p_pk(), p_tik(), p_tk(), p_zi(), and setMixtureModel().

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IMixture() [1/2]

◆ IMixture() [2/2]

◆ ~IMixture()

Member Function Documentation

◆ clone()

◆ create()

◆ finalizeStep()

◆ idData()

◆ imputationStep()

◆ initializeStep()

◆ lnComponentProbability()

◆ nbCluster()

◆ nbFreeParameter()

◆ nbMissingValues()

◆ nbSample()

◆ p_composer()

◆ p_pk()

◆ p_tik()

◆ p_tk()

◆ p_zi()

◆ paramUpdateStep()

◆ randomInit()

◆ releaseIntermediateResults()

◆ samplingStep()

◆ setMixtureModel()

◆ setParametersStep()

◆ storeIntermediateResults()

◆ writeParameters()

Member Data Documentation

◆ idData_

◆ p_composer_