LTI-Lib latest version v1.9 - last update 10 Apr 2010

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

the parameters for the class distanceFunctor More...

#include <ltiDistanceFunctor.h>

Inheritance diagram for lti::distanceFunctor< T >::parameters:
Inheritance graph
[legend]
Collaboration diagram for lti::distanceFunctor< T >::parameters:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
virtual ~parameters ()
const char * getTypeName () const
parameterscopy (const parameters &other)
virtual functor::parametersclone () const
bool write (ioHandler &handler, const bool complete) const
bool read (ioHandler &handler, const bool complete)

Public Attributes

bool rowWise

Detailed Description

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

the parameters for the class distanceFunctor


Constructor & Destructor Documentation

template<class T>
lti::distanceFunctor< T >::parameters::parameters ( void   )  [inline]
template<class T>
lti::distanceFunctor< T >::parameters::parameters ( const parameters other  )  [inline]

copy constructor

Parameters:
other the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::earthMoversDistance< W, C, D >::parameters.

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

template<class T>
virtual lti::distanceFunctor< T >::parameters::~parameters (  )  [inline, virtual]

Member Function Documentation

template<class T>
virtual functor::parameters* lti::distanceFunctor< T >::parameters::clone (  )  const [inline, virtual]
template<class T>
parameters& lti::distanceFunctor< T >::parameters::copy ( const parameters other  )  [inline]
template<class T>
const char* lti::distanceFunctor< T >::parameters::getTypeName ( void   )  const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::earthMoversDistance< W, C, D >::parameters.

template<class T>
bool lti::distanceFunctor< 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::linearAlgebraFunctor::parameters.

Reimplemented in lti::earthMoversDistance< W, C, D >::parameters.

References lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::distanceFunctor< T >::parameters::rowWise.

template<class T>
bool lti::distanceFunctor< 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.
Returns:
true if write was successful

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::earthMoversDistance< W, C, D >::parameters.

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


Member Data Documentation

template<class T>
bool lti::distanceFunctor< T >::parameters::rowWise

determine whether norms and distances between the row vectors in a matrix (true) or the column vectors in it (false) should be calculated.

Default value: true

Referenced by lti::distanceFunctor< T >::parameters::copy(), lti::distanceFunctor< T >::parameters::parameters(), lti::distanceFunctor< T >::parameters::read(), and lti::distanceFunctor< T >::parameters::write().


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

Generated on Sat Apr 10 15:28:14 2010 for LTI-Lib by Doxygen 1.6.1