STK::IMixtureManager< Derived > Class Template Reference

Interface base class for mixture managers. More...

#include <STK_IMixtureManager.h>

Inheritance diagram for STK::IMixtureManager< Derived >:

Public Types
typedef hidden::MixtureManagerTraits< Derived >::DataHandler	DataHandler
typedef hidden::MixtureManagerTraits< Derived >::Type	Type
typedef hidden::MixtureManagerTraits< Derived >::MissingIndexes	MissingIndexes
typedef hidden::MixtureManagerTraits< Derived >::MissingValues	MissingValues
typedef hidden::MixtureManagerTraits< Derived >::Data	Data
typedef hidden::MixtureManagerTraits< Derived >::DataBridgeType	DataBridgeType

Public Member Functions
	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.

Protected Member Functions
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.

Private Member Functions
IMixture *	createMixture (String const &modelName, String const &idData, int nbCluster)
	create a concrete mixture and initialize it.

Private Attributes
DataHandler const *const	p_handler_
	A pointer on the concrete instance of the data handler.
std::vector< IDataBridge * >	v_data_
	vector of pointers to the data components

Detailed Description

template<class Derived>
class STK::IMixtureManager< Derived >

Interface base class for mixture managers.

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

• It handles all the creation and initialization stuff needed by mixture models,
• It allows to get parameters and imputed missing values from specific mixtures,
• It allows also to set parameters to a specific mixture,
• all data set are enclosed in a DataBridge structure and stored in vector v_data_

The pseudo pure virtual method to implement in derived classes are

void getMissingValuesImpl(IMixture* p_mixture, MissingValues& missing) const;
void getParametersImpl(IMixture* p_mixture, ArrayXX& data) const;
void setParametersImpl(IMixture* p_mixture, ArrayXX const& data) const;
IMixture* createMixtureImpl(String const& modelName, String const& idData, int nbCluster);

Template Parameters

Derived

any concrete class derived from this interface

Definition at line 69 of file STK_IMixtureManager.h.

Member Typedef Documentation

Data

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::Data STK::IMixtureManager< Derived >::Data

Definition at line 76 of file STK_IMixtureManager.h.

DataBridgeType

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::DataBridgeType STK::IMixtureManager< Derived >::DataBridgeType

Definition at line 77 of file STK_IMixtureManager.h.

DataHandler

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::DataHandler STK::IMixtureManager< Derived >::DataHandler

Definition at line 72 of file STK_IMixtureManager.h.

MissingIndexes

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::MissingIndexes STK::IMixtureManager< Derived >::MissingIndexes

Definition at line 74 of file STK_IMixtureManager.h.

MissingValues

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::MissingValues STK::IMixtureManager< Derived >::MissingValues

Definition at line 75 of file STK_IMixtureManager.h.

Type

template<class Derived >

typedef hidden::MixtureManagerTraits<Derived>::Type STK::IMixtureManager< Derived >::Type

Definition at line 73 of file STK_IMixtureManager.h.

Constructor & Destructor Documentation

IMixtureManager()

template<class Derived >

STK::IMixtureManager< Derived >::IMixtureManager

(

DataHandler const *const

p_handler

)

Default constructor, need an instance of a DataHandler.

Definition at line 191 of file STK_IMixtureManager.h.

                                         : p_handler_(p_handler)
{}

~IMixtureManager()

template<class Derived >

STK::IMixtureManager< Derived >::~IMixtureManager

(

)

destructor

Definition at line 196 of file STK_IMixtureManager.h.

{
  typedef std::vector<IDataBridge*>::iterator DataIterator;
  for (DataIterator it = v_data_.begin() ; it != v_data_.end(); ++it)
  { delete (*it);}
}

Member Function Documentation

createMixture() [1/2]

template<class Derived >

IMixture * STK::IMixtureManager< Derived >::createMixture	(	String const &	idData,
		int	nbCluster
	)

create a mixture and initialize it.

This method get the modelName from the DataHandler and then delegate the concrete creation to derived class using the pseudo pure virtual method createMixture( modelName, idData, nbCluster).

Parameters

idData	name of the model
nbCluster	number of cluster of the model

Returns

0 if the idData is not find, the result of createMixture( modelName, idData, nbCluster) otherwise.

Definition at line 230 of file STK_IMixtureManager.h.

{
  String modelName;
  if (!p_handler_->getIdModelName( idData, modelName)) { return 0;};
  return createMixture( modelName, idData, nbCluster);
}

createMixture() [2/2]

template<class Derived >

IMixture * STK::IMixtureManager< Derived >::createMixture ( String const &  modelName, String const &  idData, int  nbCluster  )

inlineprivate

create a concrete mixture and initialize it.

Parameters

modelName,idData	strings with the Id name of the model and of the data
nbCluster	number of cluster of the model

Definition at line 163 of file STK_IMixtureManager.h.

    { return this->asDerived().createMixtureImpl(modelName, idData, nbCluster);}

References STK::IRecursiveTemplate< Derived >::asDerived().

getData()

template<class Derived >

hidden::MixtureManagerTraits< Derived >::Data const & STK::IMixtureManager< Derived >::getData

(

String const &

idData

)

const

get the wrapper for any kind of data set using its Id

Parameters

idData

Id name of the data set attached to the mixture

Returns

a constant reference on the array with the data set

Definition at line 274 of file STK_IMixtureManager.h.

{
  IDataBridge* p_bridge = getDataBridge(idData);
  if (p_bridge)
    return static_cast<DataBridgeType*>(p_bridge)->dataij();
  else
    STKRUNTIME_ERROR_1ARG(IMixtureManager::getData,idData,data bridge does not exist);
}

References STK::IMixtureManager< Derived >::getData(), and STKRUNTIME_ERROR_1ARG.

Referenced by STK::IMixtureManager< Derived >::getData().

getDataBridge()

template<class Derived >

IDataBridge * STK::IMixtureManager< Derived >::getDataBridge ( String const &  idData ) const

protected

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 261 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 Derived >

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 172 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);
}

References _T, stk_cout, STK::Clust::stringToMixture(), and STK::Clust::unknown_mixture_.

getIdModelName()

template<class Derived >

String STK::IMixtureManager< Derived >::getIdModelName

(

String const &

idData

)

const

Utility function allowing to find the idModel name from the idData.

Parameters

idData

the id name of the data we want the idModel

Returns

the idModel name

Definition at line 207 of file STK_IMixtureManager.h.

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

References _T, and stk_cout.

getMissingValues()

template<class Derived >

void STK::IMixtureManager< Derived >::getMissingValues ( IMixture *  p_mixture, MissingValues &  missing  ) const

inline

get the missing values

Parameters

p_mixture	pointer on the mixture
missing	array with the indexes and the missing values

Definition at line 131 of file STK_IMixtureManager.h.

    {this->asDerived().getMissingValuesImpl(p_mixture, missing);}

References STK::IRecursiveTemplate< Derived >::asDerived().

getParameters()

template<class Derived >

void STK::IMixtureManager< Derived >::getParameters ( IMixture *  p_mixture, ArrayXX &  data  ) const

inline

get the parameters from an IMixture.

Parameters

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

Definition at line 137 of file STK_IMixtureManager.h.

    { this->asDerived().getParametersImpl(p_mixture, data);}

References STK::IRecursiveTemplate< Derived >::asDerived().

p_handler()

template<class Derived >

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_;}

References STK::IMixtureManager< Derived >::p_handler_.

registerDataBridge()

template<class Derived >

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 243 of file STK_IMixtureManager.h.

{ v_data_.push_back(p_data);}

releaseDataBridge()

template<class Derived >

void STK::IMixtureManager< Derived >::releaseDataBridge

(

String const &

idData

)

release a data bridge from v_data_.

Parameters

idData

name of the data set to release

Definition at line 249 of file STK_IMixtureManager.h.

{
  typedef std::vector<IDataBridge*>::iterator DataIterator;
  for (DataIterator it = v_data_.begin(); it != v_data_.end(); ++it)
  { if ((*it)->idData() == idData) {delete (*it); v_data_.erase(it); break;}}
}

setParameters()

template<class Derived >

void STK::IMixtureManager< Derived >::setParameters ( IMixture *  p_mixture, ArrayXX const &  data  ) const

inline

set the parameters from an IMixture.

Parameters

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

Definition at line 143 of file STK_IMixtureManager.h.

    { this->asDerived().setParametersImpl(p_mixture, data);}

References STK::IRecursiveTemplate< Derived >::asDerived().

Member Data Documentation

p_handler_

template<class Derived >

DataHandler const* const STK::IMixtureManager< Derived >::p_handler_

private

A pointer on the concrete instance of the data handler.

Definition at line 155 of file STK_IMixtureManager.h.

Referenced by STK::IMixtureManager< Derived >::p_handler().

v_data_

template<class Derived >

std::vector<IDataBridge*> STK::IMixtureManager< Derived >::v_data_

private

vector of pointers to the data components

Definition at line 157 of file STK_IMixtureManager.h.

---

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

• STK_IMixtureManager.h