xmm::ClassParameters< ModelType > Class Template Reference

Class-specific Model Parameters. More...

#include <xmmModelParameters.hpp>

Inheritance diagram for xmm::ClassParameters< ModelType >:

Collaboration diagram for xmm::ClassParameters< ModelType >:

Public Member Functions
	ClassParameters ()
	Default Constructor. More...
	ClassParameters (ClassParameters const &src)
	Copy Constructor. More...
	ClassParameters (Json::Value const &root)
	Constructor from Json Structure. More...
ClassParameters &	operator= (ClassParameters const &src)
	Assignment. More...
Json I/O
virtual Json::Value	toJson () const =0
	Write the object to a JSON Structure. More...
virtual void	fromJson (Json::Value const &root)=0
	Read the object from a JSON Structure. More...
Python File I/O
void	writeFile (char *fileName) const
	write method for python wrapping ('write' keyword forbidden, name has to be different) More...
void	readFile (char *fileName)
	read method for python wrapping ('read' keyword forbidden, name has to be different) More...
std::string	__str__ () const
	"print" method for python => returns the results of write method More...

Public Attributes
bool	changed
	specifies if parameters have changed (model is invalid) More...

Detailed Description

template<typename ModelType>
class xmm::ClassParameters< ModelType >

Class-specific Model Parameters.

this structure is then encapsulated in a Configuration object that propagates default parameters or class-specific parameters to the SingleClassModel.

Constructor & Destructor Documentation

template<typename ModelType>

xmm::ClassParameters< ModelType >::ClassParameters ( )

inline

Default Constructor.

template<typename ModelType>

xmm::ClassParameters< ModelType >::ClassParameters ( ClassParameters< ModelType > const &  src )

inline

Copy Constructor.

Parameters

src	Source Object

template<typename ModelType>

xmm::ClassParameters< ModelType >::ClassParameters ( Json::Value const &  root )

inlineexplicit

Constructor from Json Structure.

Parameters

root	Json value

Member Function Documentation

std::string xmm::Writable::__str__ ( ) const

inlineinherited

"print" method for python => returns the results of write method

Warning

only defined if SWIGPYTHON is defined

virtual void xmm::Writable::fromJson ( Json::Value const &  root )

pure virtualinherited

Read the object from a JSON Structure.

Parameters

root	JSON value containing the object's information

Exceptions

JsonException

if the JSON value has a wrong format

Implemented in xmm::Model< SingleClassModel, ModelType >, xmm::Model< SingleClassHMM, HMM >, xmm::Model< SingleClassGMM, GMM >, xmm::Phrase, xmm::SingleClassProbabilisticModel, xmm::TrainingSet, xmm::GaussianDistribution, xmm::Configuration< ModelType >, xmm::Configuration< xmm::KMeans >, xmm::Configuration< GMM >, xmm::HierarchicalHMM, xmm::SingleClassHMM, xmm::SingleClassGMM, xmm::KMeans, xmm::SharedParameters, xmm::ClassParameters< KMeans >, and xmm::ClassParameters< GMM >.

template<typename ModelType>

xmm::ClassParameters< xmm::HMM > & xmm::ClassParameters< ModelType >::operator= ( ClassParameters< ModelType > const &  src )

inline

Assignment.

Parameters

src	Source Object

void xmm::Writable::readFile ( char *  fileName )

inlineinherited

read method for python wrapping ('read' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

virtual Json::Value xmm::Writable::toJson ( ) const

pure virtualinherited

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implemented in xmm::Model< SingleClassModel, ModelType >, xmm::Model< SingleClassHMM, HMM >, xmm::Model< SingleClassGMM, GMM >, xmm::Phrase, xmm::SingleClassProbabilisticModel, xmm::TrainingSet, xmm::GaussianDistribution, xmm::Configuration< ModelType >, xmm::Configuration< xmm::KMeans >, xmm::Configuration< GMM >, xmm::HierarchicalHMM, xmm::SingleClassHMM, xmm::SingleClassGMM, xmm::KMeans, xmm::SharedParameters, xmm::ClassParameters< KMeans >, and xmm::ClassParameters< GMM >.

void xmm::Writable::writeFile ( char *  fileName ) const

inlineinherited

write method for python wrapping ('write' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

Member Data Documentation

template<typename ModelType>

bool xmm::ClassParameters< ModelType >::changed

specifies if parameters have changed (model is invalid)

---

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

• xmmModelParameters.hpp
• xmmKMeansParameters.cpp
• xmmGmmParameters.cpp
• xmmHmmParameters.cpp