lti::euclideanSimilarity< T >::parameters Class Reference

the parameters for the class similarityFunctor More...

#include <ltiEuclideanSimilarity.h>

Inheritance diagram for lti::euclideanSimilarity< T >::parameters:

[legend]

Collaboration diagram for lti::euclideanSimilarity< T >::parameters:

[legend]

List of all members.

Public Types
enum	eEuclideanSimilarityType { Inverse, Exponential }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
bool	write (ioHandler &handler, const bool complete) const
bool	read (ioHandler &handler, const bool complete)
Public Attributes
eEuclideanSimilarityType	type

Detailed Description

template<class T>
class lti::euclideanSimilarity< T >::parameters

the parameters for the class similarityFunctor

Member Enumeration Documentation

template<class T>

enum lti::euclideanSimilarity::parameters::eEuclideanSimilarityType

Types of similarity measures based on the euclidean distance.

Enumerator:

Inverse	Based on the inverse of the distance (1/(1+\|a-b\|^2)).
Exponential	Based on the exponential exp(-\|a-b\|^2).

Constructor & Destructor Documentation

template<class T>

lti::euclideanSimilarity< T >::parameters::parameters ( void ) [inline]

default constructor

Reimplemented from lti::similarityFunctor< T >::parameters.

References lti::similarityFunctor< T >::parameters::rowWise.

Referenced by lti::euclideanSimilarity< T >::parameters::clone().

template<class T>

lti::euclideanSimilarity< T >::parameters::parameters ( const parameters & other ) [inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::similarityFunctor< T >::parameters.

References lti::euclideanSimilarity< T >::parameters::copy().

template<class T>

virtual lti::euclideanSimilarity< T >::parameters::~parameters ( ) [inline, virtual]

destructor

Reimplemented from lti::similarityFunctor< T >::parameters.

Member Function Documentation

template<class T>

virtual functor::parameters* lti::euclideanSimilarity< T >::parameters::clone ( ) const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::similarityFunctor< T >::parameters.

References lti::euclideanSimilarity< T >::parameters::parameters().

template<class T>

parameters& lti::euclideanSimilarity< T >::parameters::copy ( const parameters & other ) [inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:: a reference to this parameters object

Reimplemented from lti::similarityFunctor< T >::parameters.

References lti::similarityFunctor< T >::parameters::rowWise.

Referenced by lti::euclideanSimilarity< T >::parameters::parameters().

template<class T>

const char* lti::euclideanSimilarity< T >::parameters::getTypeName ( void ) const [inline, virtual]

returns name of this type

Reimplemented from lti::similarityFunctor< T >::parameters.

template<class T>

bool lti::euclideanSimilarity< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete
	)			`[inline, virtual]`

read the parametersfrom the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:: true if write was successful

Reimplemented from lti::similarityFunctor< T >::parameters.

References lti::euclideanSimilarity< T >::parameters::Exponential, lti::euclideanSimilarity< T >::parameters::Inverse, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::euclideanSimilarity< T >::parameters::type.

template<class T>

bool lti::euclideanSimilarity< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete
	)			const `[inline, virtual]`

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.