STK::CategoricalBridge< Id, Data > Class Template Reference

template implementation of the IMixtureBridge interface allowing to bridge a STK++ mixture with the composer. More...

#include <STK_CategoricalBridge.h>

Inheritance diagram for STK::CategoricalBridge< Id, Data >:

Public Types
enum	{ idMixtureClass_ = Clust::Categorical_ }
typedef IMixtureBridge< CategoricalBridge< Id, Data > >	Base
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Mixture	Mixture
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Parameters	Parameters
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::MissingIndexes	MissingIndexes
typedef Data::Type	Type
typedef MissingIndexes::const_iterator	ConstIterator
Public Types inherited from STK::IMixtureBridge< CategoricalBridge< Id, Data > >
enum
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Mixture	Mixture
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Data	Data
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Type	Type
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::Parameters	Parameters
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::MissingIndexes	MissingIndexes
typedef hidden::MixtureBridgeTraits< CategoricalBridge< Id, Data > >::MissingValues	MissingValues
typedef MissingIndexes::const_iterator	ConstIterator

Public Member Functions
	CategoricalBridge (Data *p_dataij, String const &idData, int nbCluster)
	default constructor.
	CategoricalBridge (CategoricalBridge const &bridge)
	copy constructor
virtual	~CategoricalBridge ()
	destructor
virtual CategoricalBridge *	clone () const
	This is a standard clone function in usual sense.
virtual CategoricalBridge *	create () const
	This is a standard create function in usual sense.
Type	safeValue (int j) const
	Compute a safe value for the jth variable by counting the most present modality.
Public Member Functions inherited from STK::IMixtureBridge< CategoricalBridge< Id, Data > >
Mixture const &	mixture () const
MissingIndexes const &	v_missing () const
Data *const	p_dataij () const
int	nbMissing () const
void	getMissingValues (MissingValues &data) const
	get the (imputed) missing values of a data set.
void	getParameters (Parameters &param) const
	get the parameters of the model
void	getParameters (Array &param) const
	This function is used in order to get the current values of the parameters in an array.
void	setParameters (Parameters const &param)
	set the parameters of the model
void	setParameters (ExprBase< Array > const &param)
	This function is used in order to set the current values of the parameters to the parameters using an array.
virtual void	initializeStep ()
	Initialize the mixture model before its use by the composer.
virtual Real	lnComponentProbability (int i, int k)
	This function must be defined to return the component probability distribution function (PDF) for corresponding sample i and cluster k.
virtual void	paramUpdateStep ()
	This function is equivalent to Mstep and must be defined to update parameters.
virtual void	randomInit ()
	This function should be used in order to initialize randomly the parameters of the mixture.
virtual int	nbFreeParameter () const
	This function must return the number of free parameters.
virtual int	nbMissingValues () const
	This function must return the number of missing value in data set identified by idData_.
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	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	writeParameters (ostream &os) const
	This function can be used to write summary of parameters to the output stream.
Public Member Functions inherited from STK::IMixture
	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 void	writeParameters (std::ostream &out) const
	This function can be used to write summary of parameters on to the output stream.
Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Private Member Functions
	CategoricalBridge (Mixture const &mixture, String const &idData, int nbCluster)
	protected constructor to use in order to create a bridge.

Additional Inherited Members
Protected Member Functions inherited from STK::IMixtureBridge< CategoricalBridge< Id, Data > >
	IMixtureBridge (Data *p_data, String const &idData, int nbCluster)
	default constructor.
	IMixtureBridge (IMixtureBridge const &bridge)
	copy constructor
	IMixtureBridge (Mixture const &mixture, String const &idData, int nbCluster)
	protected constructor to use in order to create a bridge.
virtual	~IMixtureBridge ()
	destructor
virtual std::vector< std::pair< int, int > >::size_type	findMissing ()
	utility function for lookup the data set and find missing values coordinates.
virtual void	removeMissing ()
	This function will be used once for imputation of missing data at the initialization step (.
Protected Member Functions inherited from STK::IMixture
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.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.
Protected Attributes inherited from STK::IMixtureBridge< CategoricalBridge< Id, Data > >
Mixture	mixture_
	The Mixture to bridge with the composer.
MissingIndexes	v_missing_
	vector with the coordinates of the missing values
Data *	p_dataij_
	pointer on the data set

Detailed Description

template<int Id, class Data>
class STK::CategoricalBridge< Id, Data >

template implementation of the IMixtureBridge interface allowing to bridge a STK++ mixture with the composer.

This class inherit from the IMixtureBridge.

Template Parameters

Id	is any identifier of a concrete model deriving from the interface STK::IMixtureDensity class.

Definition at line 111 of file STK_CategoricalBridge.h.

Member Typedef Documentation

Base

template<int Id, class Data >

typedef IMixtureBridge< CategoricalBridge<Id,Data> > STK::CategoricalBridge< Id, Data >::Base

Definition at line 115 of file STK_CategoricalBridge.h.

ConstIterator

template<int Id, class Data >

typedef MissingIndexes::const_iterator STK::CategoricalBridge< Id, Data >::ConstIterator

Definition at line 128 of file STK_CategoricalBridge.h.

MissingIndexes

template<int Id, class Data >

typedef hidden::MixtureBridgeTraits<CategoricalBridge<Id,Data>>::MissingIndexes STK::CategoricalBridge< Id, Data >::MissingIndexes

Definition at line 119 of file STK_CategoricalBridge.h.

Mixture

template<int Id, class Data >

typedef hidden::MixtureBridgeTraits<CategoricalBridge<Id,Data>>::Mixture STK::CategoricalBridge< Id, Data >::Mixture

Definition at line 117 of file STK_CategoricalBridge.h.

Parameters

template<int Id, class Data >

typedef hidden::MixtureBridgeTraits<CategoricalBridge<Id,Data>>::Parameters STK::CategoricalBridge< Id, Data >::Parameters

Definition at line 118 of file STK_CategoricalBridge.h.

Type

template<int Id, class Data >

typedef Data::Type STK::CategoricalBridge< Id, Data >::Type

Definition at line 121 of file STK_CategoricalBridge.h.

Member Enumeration Documentation

anonymous enum

template<int Id, class Data >

anonymous enum

Enumerator
idMixtureClass_

Definition at line 123 of file STK_CategoricalBridge.h.

    {
      idMixtureClass_ = Clust::Categorical_
    };

Constructor & Destructor Documentation

CategoricalBridge() [1/3]

template<int Id, class Data >

STK::CategoricalBridge< Id, Data >::CategoricalBridge	(	Data *	p_dataij,
		String const &	idData,
		int	nbCluster
	)

default constructor.

• Remove the missing values from the data set,
• initialize the mixture by setting the data set

  Parameters

  p_dataij	pointer on the data set that will be used by the bridge.
  idData	id name of the mixture model
  nbCluster	number of cluster

Definition at line 193 of file STK_CategoricalBridge.h.

                                             : Base( p_dataij, idData, nbCluster)
{
  removeMissing();
  mixture_.setData(*p_dataij_);
}

References STK::IMixtureBridge< CategoricalBridge< Id, Data > >::mixture_, STK::IMixtureBridge< CategoricalBridge< Id, Data > >::p_dataij_, and STK::IMixtureBridge< CategoricalBridge< Id, Data > >::removeMissing().

CategoricalBridge() [2/3]

template<int Id, class Data >

STK::CategoricalBridge< Id, Data >::CategoricalBridge

(

CategoricalBridge< Id, Data > const &

bridge

)

copy constructor

Definition at line 201 of file STK_CategoricalBridge.h.

                                                                             : Base(bridge)
{/*mixture_.setData(*p_dataij_);*/}

~CategoricalBridge()

template<int Id, class Data >

virtual STK::CategoricalBridge< Id, Data >::~CategoricalBridge ( )

inlinevirtual

destructor

Definition at line 146 of file STK_CategoricalBridge.h.

{}

CategoricalBridge() [3/3]

template<int Id, class Data >

STK::CategoricalBridge< Id, Data >::CategoricalBridge ( Mixture const &  mixture, String const &  idData, int  nbCluster  )

inlineprivate

protected constructor to use in order to create a bridge.

Parameters

mixture	the mixture to copy
idData	id name of the mixture
nbCluster	number of cluster

Definition at line 180 of file STK_CategoricalBridge.h.

                     : Base(mixture, idData, nbCluster)
    {}

Member Function Documentation

clone()

template<int Id, class Data >

virtual CategoricalBridge * STK::CategoricalBridge< Id, Data >::clone ( ) const

inlinevirtual

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.

Implements STK::IMixture.

Definition at line 153 of file STK_CategoricalBridge.h.

{ return new CategoricalBridge(*this);}

create()

template<int Id, class Data >

virtual CategoricalBridge * STK::CategoricalBridge< Id, Data >::create ( ) const

inlinevirtual

This is a standard create function in usual sense.

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

Returns

New instance of class as that of calling object.

Implements STK::IMixture.

Definition at line 159 of file STK_CategoricalBridge.h.

    {
      CategoricalBridge* p_bridge = new CategoricalBridge( mixture_, this->idData(), this->nbCluster());
      p_bridge->p_dataij_ = p_dataij_;
      p_bridge->mixture_.setData(*p_dataij_);
      p_bridge->v_missing_ = v_missing_;
      return p_bridge;
    }

References STK::IMixture::idData(), STK::IMixtureBridge< CategoricalBridge< Id, Data > >::mixture_, STK::IMixture::nbCluster(), STK::IMixtureBridge< Derived >::p_dataij_, STK::IMixtureBridge< CategoricalBridge< Id, Data > >::p_dataij_, STK::IRunnerSupervised< YArray_, XArray_, Weights_ >::setData(), and STK::IMixtureBridge< CategoricalBridge< Id, Data > >::v_missing_.

safeValue()

template<int Id, class Data >

Data::Type STK::CategoricalBridge< Id, Data >::safeValue

(

int

j

)

const

Compute a safe value for the jth variable by counting the most present modality.

Returns

a safe value for the jth variable

Parameters

j	index of the column with the safe value needed

Definition at line 210 of file STK_CategoricalBridge.h.

{
  int lmin = p_dataij_->col(j).safe().minElt(), lmax = p_dataij_->col(j).safe().maxElt();
  Array2DVector<int> count(Range(lmin, lmax, 0), 0);
  for (int i= p_dataij_->beginRows(); i < p_dataij_->endRows(); ++i)
  {
    if (!Arithmetic<int>::isNA(p_dataij_->elt(i,j)))
      count[p_dataij_->elt(i,j)]++;
  }
  int l; count.maxElt(l);
  return l;
}

References STK::count().

---

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

• STK_CategoricalBridge.h