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

The parameters for the class quickPartialSort. More...

#include <ltiQuickPartialSort.h>

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

[legend]

Collaboration diagram for lti::quickPartialSort< T >::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	pivotIndex

---

Detailed Description

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

The parameters for the class quickPartialSort.

---

Constructor & Destructor Documentation

template<class T>

lti::quickPartialSort< T >::parameters::parameters

(

void

)

[inline]

Default constructor.

Reimplemented from lti::functor::parameters.

References lti::quickPartialSort< T >::parameters::pivotIndex.

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

template<class T>

lti::quickPartialSort< T >::parameters::parameters

(

const parameters &

other

)

[inline]

Copy constructor.

Parameters:

other

the parameters object to be copied

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

template<class T>

lti::quickPartialSort< T >::parameters::~parameters

(

)

[inline, virtual]

Destructor.

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

template<class T>

virtual functor::parameters* lti::quickPartialSort< T >::parameters::clone

(

)

const [inline, virtual]

Returns a pointer to a clone of the parameters.

Implements lti::functor::parameters.

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

template<class T>

parameters& lti::quickPartialSort< 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

References lti::functor::parameters::copy(), and lti::quickPartialSort< T >::parameters::pivotIndex.

Referenced by lti::quickPartialSort< T >::parameters::operator=(), and lti::quickPartialSort< T >::parameters::parameters().

template<class T>

const char* lti::quickPartialSort< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

Returns name of this type.

Reimplemented from lti::functor::parameters.

template<class T>

parameters& lti::quickPartialSort< T >::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::quickPartialSort< T >::parameters::copy().

template<class T>

virtual bool lti::quickPartialSort< T >::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 read was successful

Reimplemented from lti::functor::parameters.

References lti::quickPartialSort< T >::parameters::pivotIndex, lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T>

virtual bool lti::quickPartialSort< T >::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::quickPartialSort< T >::parameters::pivotIndex, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T>

int lti::quickPartialSort< T >::parameters::pivotIndex

Specifies the position in the vectors that will have its own place, if the whole vector where sorted.

This means, all first "pivotIndex" elements in the output vectors will be smaller or equal the rest of the elements.

Default value: 2

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

---

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

• ltiQuickPartialSort.h