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

the parameters for the class distanceFunctor More...

#include <cvrDistanceFunctor.h>

Inheritance diagram for cvr::distanceFunctor< T >::distanceFunctor::parameters:

[legend]

Collaboration diagram for cvr::distanceFunctor< T >::distanceFunctor::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
parameters &	copy (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
bool	write (ioHandler &handler, const bool complete) const
bool	read (ioHandler &handler, const bool complete)
Public Attributes
bool	rowWise

---

Detailed Description

template<typename T>
class cvr::distanceFunctor< T >::parameters

the parameters for the class distanceFunctor

---

Constructor & Destructor Documentation

template<typename T>

cvr::distanceFunctor< T >::distanceFunctor::parameters::parameters

(

)

default constructor

Reimplemented from cvr::functor::functor::parameters.

template<typename T>

cvr::distanceFunctor< T >::distanceFunctor::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

template<typename T>

virtual cvr::distanceFunctor< T >::distanceFunctor::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

template<typename T>

virtual parameters* cvr::distanceFunctor< T >::distanceFunctor::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements cvr::functor::functor::parameters.

template<typename T>

parameters& cvr::distanceFunctor< T >::distanceFunctor::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

template<typename T>

virtual const std::string& cvr::distanceFunctor< T >::distanceFunctor::parameters::name

(

)

const [virtual]

Return the name of the class.

Implements cvr::functor::functor::parameters.

template<typename T>

virtual parameters* cvr::distanceFunctor< T >::distanceFunctor::parameters::newInstance

(

)

const [virtual]

returns a pointer to a new instance of the parameters

Implements cvr::functor::functor::parameters.

template<typename T>

bool cvr::distanceFunctor< T >::distanceFunctor::parameters::read	(	ioHandler &	handler,
		const bool	complete
	)			[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 cvr::parametersManager::parametersManager::parameters.

template<typename T>

bool cvr::distanceFunctor< T >::distanceFunctor::parameters::write	(	ioHandler &	handler,
		const bool	complete
	)			const [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 cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

template<typename T>

bool cvr::distanceFunctor< T >::distanceFunctor::parameters::rowWise

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

Default value: true

---

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

• cvrDistanceFunctor.h