lti::minimumSpanningTree< K, V, Distantor >::parameters Class Reference

the parameters for the class minimumSpanningTree More...

#include <ltiMinimumSpanningTree.h>

Inheritance diagram for lti::minimumSpanningTree< K, V, Distantor >::parameters:

[legend]

Collaboration diagram for lti::minimumSpanningTree< K, V, Distantor >::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
int	nbNeighbors
bool	useCompleteGraph

---

Detailed Description

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>
class lti::minimumSpanningTree< K, V, Distantor >::parameters

the parameters for the class minimumSpanningTree

---

Constructor & Destructor Documentation

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::functor::parameters.

References lti::minimumSpanningTree< K, V, Distantor >::parameters::nbNeighbors, and lti::minimumSpanningTree< K, V, Distantor >::parameters::useCompleteGraph.

Referenced by lti::minimumSpanningTree< K, V, Distantor >::parameters::clone().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

References lti::minimumSpanningTree< K, V, Distantor >::parameters::copy().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

lti::minimumSpanningTree< K, V, Distantor >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

virtual functor::parameters* lti::minimumSpanningTree< K, V, Distantor >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

References lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

parameters& lti::minimumSpanningTree< K, V, Distantor >::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

References lti::functor::parameters::copy(), lti::minimumSpanningTree< K, V, Distantor >::parameters::nbNeighbors, and lti::minimumSpanningTree< K, V, Distantor >::parameters::useCompleteGraph.

Referenced by lti::minimumSpanningTree< K, V, Distantor >::parameters::operator=(), and lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

const char* lti::minimumSpanningTree< K, V, Distantor >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

parameters& lti::minimumSpanningTree< K, V, Distantor >::parameters::operator=

(

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

References lti::minimumSpanningTree< K, V, Distantor >::parameters::copy().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

virtual bool lti::minimumSpanningTree< K, V, Distantor >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, virtual]

read the parameters from 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::functor::parameters.

References lti::minimumSpanningTree< K, V, Distantor >::parameters::nbNeighbors, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::minimumSpanningTree< K, V, Distantor >::parameters::useCompleteGraph.

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

virtual bool lti::minimumSpanningTree< K, V, Distantor >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			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::functor::parameters.

References lti::minimumSpanningTree< K, V, Distantor >::parameters::nbNeighbors, lti::minimumSpanningTree< K, V, Distantor >::parameters::useCompleteGraph, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

int lti::minimumSpanningTree< K, V, Distantor >::parameters::nbNeighbors

The number of neighboring points each point is connected with, before minimization.

Referenced by lti::minimumSpanningTree< K, V, Distantor >::parameters::copy(), lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters(), lti::minimumSpanningTree< K, V, Distantor >::parameters::read(), and lti::minimumSpanningTree< K, V, Distantor >::parameters::write().

template<class K, class V = int, class Distantor = l2SquareDistantor<K>>

bool lti::minimumSpanningTree< K, V, Distantor >::parameters::useCompleteGraph

If true, first a complete graph of the input data is computed, for searching the minimum spanning tree.

If false an approximation is used of the complete graph is used. In most cases this approxiation leads to the correct minimum spanning tree. default is false.

Referenced by lti::minimumSpanningTree< K, V, Distantor >::parameters::copy(), lti::minimumSpanningTree< K, V, Distantor >::parameters::parameters(), lti::minimumSpanningTree< K, V, Distantor >::parameters::read(), and lti::minimumSpanningTree< K, V, Distantor >::parameters::write().

---

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

• ltiMinimumSpanningTree.h