xmm::ClassParameters< KMeans > Class Template Reference

Parameters specific to each class of a K-Means Algorithm. More...

#include <xmmKMeansParameters.hpp>

Inheritance diagram for xmm::ClassParameters< KMeans >:

Collaboration diagram for xmm::ClassParameters< KMeans >:

Public Member Functions
	ClassParameters ()
	Default Constructor. More...
	ClassParameters (ClassParameters< KMeans > const &src)
	Copy Constructor. More...
	ClassParameters (Json::Value const &root)
	Constructor from Json Structure. More...
ClassParameters &	operator= (ClassParameters< KMeans > const &src)
	Assignment. More...
virtual	~ClassParameters ()
Json I/O
Json::Value	toJson () const
	Write the object to a JSON Structure. More...
virtual void	fromJson (Json::Value const &root)
	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 = false
	specifies if parameters have changed (model is invalid) More...
Attribute< unsigned int >	clusters
	Number of Gaussian Mixture Components. More...
Attribute< unsigned int >	max_iterations
	Maximum number of iterations of the training update. More...
Attribute< float >	relative_distance_threshold
	threshold (as relative distance between cluster) required to define convergence More...

Protected Member Functions
virtual void	onAttributeChange (AttributeBase *attr_pointer)
	notification function called when a member attribute is changed More...

Detailed Description

template<>
class xmm::ClassParameters< KMeans >

Parameters specific to each class of a K-Means Algorithm.

Constructor & Destructor Documentation

xmm::ClassParameters< KMeans >::ClassParameters

(

)

Default Constructor.

xmm::ClassParameters< KMeans >::ClassParameters

(

ClassParameters< KMeans > const &

src

)

Copy Constructor.

Parameters

src	Source Object

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

explicit

Constructor from Json Structure.

Parameters

root	Json Value

virtual xmm::ClassParameters< KMeans >::~ClassParameters ( )

inlinevirtual

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::ClassParameters< KMeans >::fromJson ( Json::Value const &  root )

virtual

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

Implements xmm::Writable.

virtual void xmm::ClassParameters< KMeans >::onAttributeChange ( AttributeBase *  attr_pointer )

protectedvirtual

notification function called when a member attribute is changed

ClassParameters& xmm::ClassParameters< KMeans >::operator=

(

ClassParameters< KMeans > const &

src

)

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

Json::Value xmm::ClassParameters< KMeans >::toJson ( ) const

virtual

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implements xmm::Writable.

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

bool xmm::ClassParameters< KMeans >::changed = false

specifies if parameters have changed (model is invalid)

Attribute<unsigned int> xmm::ClassParameters< KMeans >::clusters

Number of Gaussian Mixture Components.

Attribute<unsigned int> xmm::ClassParameters< KMeans >::max_iterations

Maximum number of iterations of the training update.

Attribute<float> xmm::ClassParameters< KMeans >::relative_distance_threshold

threshold (as relative distance between cluster) required to define convergence

---

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

• xmmKMeansParameters.hpp