STK::KernelMixtureManager Class Reference

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

#include <STK_KernelMixtureManager.h>

Inheritance diagram for STK::KernelMixtureManager:

Public Types
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::DataHandler	DataHandler
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::Type	Type
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::MissingIndexes	MissingIndexes
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::MissingValues	MissingValues
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::Data	Data
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::DataBridgeType	DataBridgeType
typedef IMixtureManager< KernelMixtureManager >	Base
typedef KmmBridge< Clust::Kmm_sk_, CSquareX >	KmmBridge_sk
typedef KmmBridge< Clust::Kmm_s_, CSquareX >	KmmBridge_s
Public Types inherited from STK::IMixtureManager< KernelMixtureManager >
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::DataHandler	DataHandler
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::Type	Type
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::MissingIndexes	MissingIndexes
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::MissingValues	MissingValues
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::Data	Data
typedef hidden::MixtureManagerTraits< KernelMixtureManager >::DataBridgeType	DataBridgeType

Public Member Functions
	KernelMixtureManager (KernelHandler const &handler)
	Default constructor, need an instance of a KernelHandler.
	~KernelMixtureManager ()
	destructor
void	setDim (IMixture *p_mixture, Real const &dim) const
	set the dimension of the kernel mixture model
template<class Vector >
void	setDim (IMixture *p_mixture, ExprBase< Vector > const &dim) const
	set the dimension of the kernel mixture model
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 from an IMixture.
IMixture *	createMixtureImpl (String const &modelName, String const &idData, int nbCluster)
	create a concrete mixture from its string name and initialize it.
Public Member Functions inherited from STK::IMixtureManager< KernelMixtureManager >
	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< KernelMixtureManager >
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

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

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

Definition at line 89 of file STK_KernelMixtureManager.h.

Member Typedef Documentation

Base

typedef IMixtureManager<KernelMixtureManager> STK::KernelMixtureManager::Base

Definition at line 99 of file STK_KernelMixtureManager.h.

Data

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::Data STK::KernelMixtureManager::Data

Definition at line 96 of file STK_KernelMixtureManager.h.

DataBridgeType

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::DataBridgeType STK::KernelMixtureManager::DataBridgeType

Definition at line 97 of file STK_KernelMixtureManager.h.

DataHandler

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::DataHandler STK::KernelMixtureManager::DataHandler

Definition at line 92 of file STK_KernelMixtureManager.h.

KmmBridge_s

typedef KmmBridge< Clust::Kmm_s_, CSquareX> STK::KernelMixtureManager::KmmBridge_s

Definition at line 102 of file STK_KernelMixtureManager.h.

KmmBridge_sk

typedef KmmBridge< Clust::Kmm_sk_, CSquareX> STK::KernelMixtureManager::KmmBridge_sk

Definition at line 101 of file STK_KernelMixtureManager.h.

MissingIndexes

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::MissingIndexes STK::KernelMixtureManager::MissingIndexes

Definition at line 94 of file STK_KernelMixtureManager.h.

MissingValues

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::MissingValues STK::KernelMixtureManager::MissingValues

Definition at line 95 of file STK_KernelMixtureManager.h.

Type

typedef hidden::MixtureManagerTraits<KernelMixtureManager>::Type STK::KernelMixtureManager::Type

Definition at line 93 of file STK_KernelMixtureManager.h.

Constructor & Destructor Documentation

KernelMixtureManager()

STK::KernelMixtureManager::KernelMixtureManager

(

KernelHandler const &

handler

)

Default constructor, need an instance of a KernelHandler.

Definition at line 42 of file STK_KernelMixtureManager.cpp.

: Base(&handler) {}

~KernelMixtureManager()

STK::KernelMixtureManager::~KernelMixtureManager

(

)

destructor

Definition at line 44 of file STK_KernelMixtureManager.cpp.

{}

Member Function Documentation

createMixtureImpl() [1/2]

IMixture * STK::KernelMixtureManager::createMixtureImpl ( Clust::Mixture  idModel, String const &  idData, int  nbCluster  )

private

create a concrete mixture and initialize it.

Parameters

idModel,idData	Id of the model and the data
nbCluster	number of cluster of the model

Definition at line 124 of file STK_KernelMixtureManager.cpp.

{
  Kernel::IKernel const* p_kernel = p_handler()->getKernel(idData);
  switch (idModel)
  {
    case Clust::Kmm_sk_:
    {
      KmmBridge_sk* p_mixture = new KmmBridge_sk( 0, idData, nbCluster);
      p_mixture->setKernel(p_kernel);
      return p_mixture;
      break;
    }
    case Clust::Kmm_s_:
    {
      KmmBridge_s* p_mixture = new KmmBridge_s( 0, idData, nbCluster);
      p_mixture->setKernel(p_kernel);
      return p_mixture;
      break;
    }
    default:
      return 0; // 0 if idModel does not exists
      break;
  }
  return 0; // 0 if idModel is not a STK++ model
}

References STK::Clust::Kmm_s_, STK::Clust::Kmm_sk_, and STK::IMixtureManager< KernelMixtureManager >::p_handler().

createMixtureImpl() [2/2]

IMixture * STK::KernelMixtureManager::createMixtureImpl	(	String const &	modelName,
		String const &	idData,
		int	nbCluster
	)

create a concrete mixture from its string name and initialize it.

Parameters

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

Definition at line 111 of file STK_KernelMixtureManager.cpp.

{
#ifdef STK_MIXTURE_VERY_VERBOSE
  stk_cout << _T("KernelMixtureManager::Entering createMixtureImpl(") <<  modelName
           << _T(",") << idData << _T(",") << nbCluster << _T(")\n");
#endif
  Clust::Mixture idModel = Clust::stringToMixture(modelName);
  return createMixtureImpl(idModel, idData, nbCluster);
}

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

Referenced by createMixtureImpl().

getParametersImpl()

void STK::KernelMixtureManager::getParametersImpl	(	IMixture *	p_mixture,
		ArrayXX &	param
	)		const

get the parameters from an IMixture.

Parameters

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

Definition at line 70 of file STK_KernelMixtureManager.cpp.

{
  if (!p_mixture) return;
  Clust::Mixture idModel = getIdModel(p_mixture->idData());
  // up-cast... (Yes it's bad....;)...)
  switch (idModel)
  {
    // Kernel models
    case Clust::Kmm_sk_:
    { static_cast<KmmBridge_sk*>(p_mixture)->getParameters(param);}
    break;
    case Clust::Kmm_s_:
    { static_cast<KmmBridge_s*>(p_mixture)->getParameters(param);}
    break;
    default: // idModel is not implemented
    break;
  }
}

References STK::IMixtureManager< KernelMixtureManager >::getIdModel(), STK::IMixtureManager< KernelMixtureManager >::getParameters(), STK::Clust::Kmm_s_, and STK::Clust::Kmm_sk_.

setDim() [1/2]

template<class Vector >

void STK::KernelMixtureManager::setDim	(	IMixture *	p_mixture,
		ExprBase< Vector > const &	dim
	)		const

set the dimension of the kernel mixture model

Definition at line 142 of file STK_KernelMixtureManager.h.

{
  STK_STATIC_ASSERT_ONE_DIMENSION_ONLY(Vector);
  if (!p_mixture) return;
  Clust::Mixture idModel = getIdModel(p_mixture->idData());
  // up-cast... (Yes it's bad....;)...)
  switch (idModel)
  {
    // Kernel models
    case Clust::Kmm_sk_:
    { static_cast<KmmBridge_sk*>(p_mixture)->setDim(dim.asDerived());}
    break;
    case Clust::Kmm_s_:
    { static_cast<KmmBridge_s*>(p_mixture)->setDim(dim.asDerived());}
    break;
    default: // idModel is not implemented
    break;
  }
}

References STK::IMixtureManager< KernelMixtureManager >::getIdModel(), STK::Clust::Kmm_s_, STK::Clust::Kmm_sk_, setDim(), and STK_STATIC_ASSERT_ONE_DIMENSION_ONLY.

setDim() [2/2]

void STK::KernelMixtureManager::setDim	(	IMixture *	p_mixture,
		Real const &	dim
	)		const

set the dimension of the kernel mixture model

Definition at line 47 of file STK_KernelMixtureManager.cpp.

{
  if (!p_mixture) return;
  Clust::Mixture idModel = getIdModel(p_mixture->idData());
  // up-cast... (Yes it's bad....;)...)
  switch (idModel)
  {
    // Kernel models
    case Clust::Kmm_sk_:
    { static_cast<KmmBridge_sk*>(p_mixture)->setDim(dim);}
    break;
    case Clust::Kmm_s_:
    { static_cast<KmmBridge_s*>(p_mixture)->setDim(dim);}
    break;
    default: // idModel is not implemented
    break;
  }
}

References STK::IMixtureManager< KernelMixtureManager >::getIdModel(), STK::Clust::Kmm_s_, STK::Clust::Kmm_sk_, and setDim().

Referenced by setDim(), and setDim().

setParametersImpl()

void STK::KernelMixtureManager::setParametersImpl	(	IMixture *	p_mixture,
		ArrayXX const &	param
	)		const

set the parameters from an IMixture.

Parameters

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

Definition at line 92 of file STK_KernelMixtureManager.cpp.

{
  if (!p_mixture) return;
  Clust::Mixture idModel = getIdModel(p_mixture->idData());
  // up-cast... (Yes it's bad....;)...)
  switch (idModel)
  {
    // Kernel models
    case Clust::Kmm_sk_:
    { static_cast<KmmBridge_sk*>(p_mixture)->setParameters(param);}
    break;
    case Clust::Kmm_s_:
    { static_cast<KmmBridge_s*>(p_mixture)->setParameters(param);}
    break;
    default: // idModel is not implemented
    break;
  }
}

References STK::IMixtureManager< KernelMixtureManager >::getIdModel(), STK::Clust::Kmm_s_, STK::Clust::Kmm_sk_, and STK::IMixtureManager< KernelMixtureManager >::setParameters().

---

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

• STK_KernelMixtureManager.h
• STK_KernelMixtureManager.cpp