STK::CategoricalMixtureManager< DataHandler > Class Template Reference

A mixture manager is a factory class for injection dependency in the STK++ derived class of the IMixtureComposer interface class. More...

#include <STK_CategoricalMixtureManager.h>

Inheritance diagram for STK::CategoricalMixtureManager< DataHandler >:

Public Types
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager >::Type	Type
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager >::MissingIndexes	MissingIndexes
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager >::MissingValues	MissingValues
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager >::Data	Data
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager >::DataBridgeType	DataBridgeType
typedef IMixtureManager< CategoricalMixtureManager >	Base
typedef CategoricalBridge< Clust::Categorical_pjk_, Data >	MixtureBridge_pjk
typedef CategoricalBridge< Clust::Categorical_pk_, Data >	MixtureBridge_pk
Public Types inherited from STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::DataHandler	DataHandler
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::Type	Type
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::MissingIndexes	MissingIndexes
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::MissingValues	MissingValues
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::Data	Data
typedef hidden::MixtureManagerTraits< CategoricalMixtureManager< DataHandler > >::DataBridgeType	DataBridgeType

Public Member Functions
	CategoricalMixtureManager (DataHandler const &handler)
	Default constructor, need an instance of a DataHandler.
	~CategoricalMixtureManager ()
	destructor
void	getMissingValuesImpl (IMixture *p_mixture, MissingValues &missing) const
	get the missing values from an IMixture.
void	getParametersImpl (IMixture *p_mixture, ArrayXX &param) const
	get the parameters from an IMixture.
void	setParametersImpl (IMixture *p_mixture, ArrayXX const &param) const
	set the parameters to an IMixture.
IMixture *	createMixtureImpl (String const &modelName, String const &idData, int nbCluster)
	create a concrete mixture and initialize it.
void	registerDataBridge (IDataBridge *p_data)
	register a data bridge to the IMixtureManager.
IDataBridge *	getDataBridge (String const &idData) const
	Utility lookup function allowing to find a DataBridge from its idData.
Clust::Mixture	getIdModel (String const &idData) const
	Utility function allowing to find the idModel from the idData.
DataHandler const *const	p_handler () const
Public Member Functions inherited from STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >
	IMixtureManager (DataHandler const *const p_handler)
	Default constructor, need an instance of a DataHandler.
	~IMixtureManager ()
	destructor
DataHandler const *const	p_handler () const
Clust::Mixture	getIdModel (String const &idData) const
	Utility function allowing to find the idModel from the idData.
String	getIdModelName (String const &idData) const
	Utility function allowing to find the idModel name from the idData.
IMixture *	createMixture (String const &idData, int nbCluster)
	create a mixture and initialize it.
void	registerDataBridge (IDataBridge *p_data)
	register a data bridge to the IMixtureManager.
void	releaseDataBridge (String const &idData)
	release a data bridge from v_data_.
Data const &	getData (String const &idData) const
	get the wrapper for any kind of data set using its Id
void	getMissingValues (IMixture *p_mixture, MissingValues &missing) const
	get the missing values
void	getParameters (IMixture *p_mixture, ArrayXX &data) const
	get the parameters from an IMixture.
void	setParameters (IMixture *p_mixture, ArrayXX const &data) const
	set the parameters from an IMixture.
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
IMixture *	createMixtureImpl (Clust::Mixture idModel, String const &idData, int nbCluster)
	create a concrete mixture and initialize it.

Additional Inherited Members
Protected Member Functions inherited from STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >
IDataBridge *	getDataBridge (String const &idData) const
	Utility lookup function allowing to find a DataBridge from its idData.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

template<class DataHandler>
class STK::CategoricalMixtureManager< DataHandler >

A mixture manager is a factory class for injection dependency in the STK++ derived class of the IMixtureComposer interface class.

It allows to handle all the creation and initialization stuff needed by the (bridged) mixture models of the stkpp library.

Template Parameters

DataHandler

is any concrete class from the interface DataHandlerBase

Definition at line 93 of file STK_CategoricalMixtureManager.h.

Member Typedef Documentation

Base

template<class DataHandler >

typedef IMixtureManager<CategoricalMixtureManager> STK::CategoricalMixtureManager< DataHandler >::Base

Definition at line 102 of file STK_CategoricalMixtureManager.h.

Data

template<class DataHandler >

typedef hidden::MixtureManagerTraits<CategoricalMixtureManager>::Data STK::CategoricalMixtureManager< DataHandler >::Data

Definition at line 99 of file STK_CategoricalMixtureManager.h.

DataBridgeType

template<class DataHandler >

typedef hidden::MixtureManagerTraits<CategoricalMixtureManager>::DataBridgeType STK::CategoricalMixtureManager< DataHandler >::DataBridgeType

Definition at line 100 of file STK_CategoricalMixtureManager.h.

MissingIndexes

template<class DataHandler >

typedef hidden::MixtureManagerTraits<CategoricalMixtureManager>::MissingIndexes STK::CategoricalMixtureManager< DataHandler >::MissingIndexes

Definition at line 97 of file STK_CategoricalMixtureManager.h.

MissingValues

template<class DataHandler >

typedef hidden::MixtureManagerTraits<CategoricalMixtureManager>::MissingValues STK::CategoricalMixtureManager< DataHandler >::MissingValues

Definition at line 98 of file STK_CategoricalMixtureManager.h.

MixtureBridge_pjk

template<class DataHandler >

typedef CategoricalBridge<Clust::Categorical_pjk_, Data> STK::CategoricalMixtureManager< DataHandler >::MixtureBridge_pjk

Definition at line 109 of file STK_CategoricalMixtureManager.h.

MixtureBridge_pk

template<class DataHandler >

typedef CategoricalBridge<Clust::Categorical_pk_, Data> STK::CategoricalMixtureManager< DataHandler >::MixtureBridge_pk

Definition at line 110 of file STK_CategoricalMixtureManager.h.

Type

template<class DataHandler >

typedef hidden::MixtureManagerTraits<CategoricalMixtureManager>::Type STK::CategoricalMixtureManager< DataHandler >::Type

Definition at line 96 of file STK_CategoricalMixtureManager.h.

Constructor & Destructor Documentation

CategoricalMixtureManager()

template<class DataHandler >

STK::CategoricalMixtureManager< DataHandler >::CategoricalMixtureManager ( DataHandler const &  handler )

inline

Default constructor, need an instance of a DataHandler.

Definition at line 113 of file STK_CategoricalMixtureManager.h.

: Base(&handler) {}

~CategoricalMixtureManager()

template<class DataHandler >

STK::CategoricalMixtureManager< DataHandler >::~CategoricalMixtureManager ( )

inline

destructor

Definition at line 115 of file STK_CategoricalMixtureManager.h.

{}

Member Function Documentation

createMixtureImpl() [1/2]

template<class DataHandler >

IMixture * STK::CategoricalMixtureManager< DataHandler >::createMixtureImpl ( Clust::Mixture  idModel, String const &  idData, int  nbCluster  )

inlineprivate

create a concrete mixture and initialize it.

Parameters

idModel	Id name of the model
idData	Id name of the data
nbCluster	number of cluster of the model

Definition at line 197 of file STK_CategoricalMixtureManager.h.

    {
      switch (idModel)
      {
        case Clust::Categorical_pjk_:
          { STK_CREATE_MIXTURE(DataBridgeType, MixtureBridge_pjk)}
          break;
        case Clust::Categorical_pk_:
          { STK_CREATE_MIXTURE(DataBridgeType, MixtureBridge_pk)}
          break;
        default:
          return 0; // 0 if idModel is not implemented
          break;
      }
      return 0; // 0 if idModel is not a STK++ model
    }

References STK::Clust::Categorical_pjk_, STK::Clust::Categorical_pk_, and STK_CREATE_MIXTURE.

createMixtureImpl() [2/2]

template<class DataHandler >

IMixture * STK::CategoricalMixtureManager< DataHandler >::createMixtureImpl ( String const &  modelName, String const &  idData, int  nbCluster  )

inline

create a concrete mixture and initialize it.

Parameters

modelName	a valid model name
idData	Id of the data
nbCluster	number of cluster of the model

Definition at line 185 of file STK_CategoricalMixtureManager.h.

    {
      Clust::Mixture idModel = Clust::stringToMixture(modelName);
      return createMixtureImpl(idModel, idData, nbCluster);
    }

References STK::CategoricalMixtureManager< DataHandler >::createMixtureImpl(), and STK::Clust::stringToMixture().

Referenced by STK::CategoricalMixtureManager< DataHandler >::createMixtureImpl().

getDataBridge()

template<class DataHandler >

IDataBridge * STK::IMixtureManager< Derived >::getDataBridge

(

String const &

idData

)

const

Utility lookup function allowing to find a DataBridge from its idData.

Parameters

idData

the id name of the mixture we want to get

Returns

a pointer on the DataBridge

Definition at line 151 of file STK_IMixtureManager.h.

{
  typedef std::vector<IDataBridge*>::const_iterator ConstDataIterator;
  for (ConstDataIterator it = v_data_.begin(); it != v_data_.end(); ++it)
  {  if ((*it)->idData() == idData) return (*it);}
  return 0;
}

getIdModel()

template<class DataHandler >

Clust::Mixture STK::IMixtureManager< Derived >::getIdModel

(

String const &

idData

)

const

Utility function allowing to find the idModel from the idData.

Parameters

idData

the id name of the data we want the idModel

Returns

the idModel

Definition at line 91 of file STK_IMixtureManager.h.

{
  String modelName;
  if (!p_handler()->getIdModelName( idData, modelName))
  {
#ifdef STK_MIXTURE_VERY_VERBOSE
    stk_cout << _T("In IMixtureManager::getIdModel, fail to get idData = ") << idData << _T("\n");
#endif
    return Clust::unknown_mixture_;
  }
#ifdef STK_MIXTURE_VERY_VERBOSE
  stk_cout << _T("In IMixtureManager::getIdModel, success to get idData = ") << idData << _T("\n");
  stk_cout << _T("In IMixtureManager::getIdModel, modelName = ") << modelName << _T("\n");
#endif
  return Clust::stringToMixture(modelName);
}

Referenced by STK::CategoricalMixtureManager< DataHandler >::getMissingValuesImpl(), STK::CategoricalMixtureManager< DataHandler >::getParametersImpl(), and STK::CategoricalMixtureManager< DataHandler >::setParametersImpl().

getMissingValuesImpl()

template<class DataHandler >

void STK::CategoricalMixtureManager< DataHandler >::getMissingValuesImpl ( IMixture *  p_mixture, MissingValues &  missing  ) const

inline

get the missing values from an IMixture.

Parameters

p_mixture	pointer on the mixture
missing	structure to return with the missing values

Definition at line 121 of file STK_CategoricalMixtureManager.h.

    {
      Clust::Mixture idModel = getIdModel(p_mixture->idData());
      if (idModel == Clust::unknown_mixture_) return;
      // up-cast... (Yes it's bad....;)...)
      switch (idModel)
      {
        case Clust::Categorical_pjk_:
        { static_cast<MixtureBridge_pjk*>(p_mixture)->getMissingValues(missing);}
        break;
        case Clust::Categorical_pk_:
        { static_cast<MixtureBridge_pk*>(p_mixture)->getMissingValues(missing);}
        break;
        default: // idModel is not implemented
        break;
      }
    }

References STK::Clust::Categorical_pjk_, STK::Clust::Categorical_pk_, STK::CategoricalMixtureManager< DataHandler >::getIdModel(), STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >::getMissingValues(), and STK::Clust::unknown_mixture_.

getParametersImpl()

template<class DataHandler >

void STK::CategoricalMixtureManager< DataHandler >::getParametersImpl ( IMixture *  p_mixture, ArrayXX &  param  ) const

inline

get the parameters from an IMixture.

Parameters

p_mixture	pointer on the mixture
param	the array to return with the parameters

Definition at line 142 of file STK_CategoricalMixtureManager.h.

    {
      Clust::Mixture idModel = getIdModel(p_mixture->idData());
      if (idModel == Clust::unknown_mixture_) return;
      // up-cast... (Yes it's bad....;)...)
      switch (idModel)
      {
        case Clust::Categorical_pjk_:
        { static_cast<MixtureBridge_pjk*>(p_mixture)->getParameters(param);}
        break;
        case Clust::Categorical_pk_:
        { static_cast<MixtureBridge_pk*>(p_mixture)->getParameters(param);}
        break;
        default: // idModel is not implemented
        break;
      }
    }

References STK::Clust::Categorical_pjk_, STK::Clust::Categorical_pk_, STK::CategoricalMixtureManager< DataHandler >::getIdModel(), STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >::getParameters(), and STK::Clust::unknown_mixture_.

p_handler()

template<class DataHandler >

DataHandler const *const STK::IMixtureManager< Derived >::p_handler ( ) const

inline

Returns

constant pointer on the data handler

Definition at line 85 of file STK_IMixtureManager.h.

{ return p_handler_;}

registerDataBridge()

template<class DataHandler >

void STK::IMixtureManager< Derived >::registerDataBridge

(

IDataBridge *

p_data

)

register a data bridge to the IMixtureManager.

For each mixture created and registered, a data bridge is created and registered so that it will be deleted when the mixture itself is deleted.

Parameters

p_data

a pointer on the data manager

Definition at line 114 of file STK_IMixtureManager.h.

{ v_data_.push_back(p_data);}

setParametersImpl()

template<class DataHandler >

void STK::CategoricalMixtureManager< DataHandler >::setParametersImpl ( IMixture *  p_mixture, ArrayXX const &  param  ) const

inline

set the parameters to an IMixture.

Parameters

p_mixture	pointer on the mixture
param	the array with the parameters to set

Definition at line 163 of file STK_CategoricalMixtureManager.h.

    {
      Clust::Mixture idModel = getIdModel(p_mixture->idData());
      if (idModel == Clust::unknown_mixture_) return;
      // up-cast... (Yes it's bad....;)...)
      switch (idModel)
      {
        case Clust::Categorical_pjk_:
        { static_cast<MixtureBridge_pjk*>(p_mixture)->setParameters(param);}
        break;
        case Clust::Categorical_pk_:
        { static_cast<MixtureBridge_pk*>(p_mixture)->setParameters(param);}
        break;
        default: // idModel is not implemented
        break;
      }
    }

References STK::Clust::Categorical_pjk_, STK::Clust::Categorical_pk_, STK::CategoricalMixtureManager< DataHandler >::getIdModel(), STK::IMixtureManager< CategoricalMixtureManager< DataHandler > >::setParameters(), and STK::Clust::unknown_mixture_.

---

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

• STK_CategoricalMixtureManager.h