lti::sort2< T, U >::parameters Class Reference

The parameters for the class sort. More...

#include <ltiSort.h>

Inheritance diagram for lti::sort2< T, U >::parameters:

[legend]

Collaboration diagram for lti::sort2< T, U >::parameters:

[legend]

List of all members.

Public Types
enum	eWhichVectors { Columns, Rows }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	read (ioHandler &handler, const bool complete=true)
virtual bool	write (ioHandler &handler, const bool complete=true) const
Public Attributes
eWhichVectors	whichVectors

Detailed Description

template<class T, class U = int>
class lti::sort2< T, U >::parameters

The parameters for the class sort.

Member Enumeration Documentation

template<class T, class U = int>

enum lti::sort2::parameters::eWhichVectors

Type used in the specification of the sorting order (used when sorting the rows or columns of a matrix using as keys the values of a vector).

Enumerator:

Columns	sort the columns of the matrix
Rows	sort the rows of the matrix

Constructor & Destructor Documentation

template<class T, class U = int>

lti::sort2< T, U >::parameters::parameters ( void ) [inline]

Default constructor.

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

References lti::sort2< T, U >::parameters::Rows, and lti::sort2< T, U >::parameters::whichVectors.

Referenced by lti::sort2< T, U >::parameters::clone().

template<class T, class U = int>

lti::sort2< T, U >::parameters::parameters ( const parameters & other ) [inline]

Copy constructor.

Parameters:

other

the parameters object to be copied

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

References lti::sort2< T, U >::parameters::copy().

template<class T, class U = int>

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

Destructor.

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

Member Function Documentation

template<class T, class U = int>

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

Returns a pointer to a clone of the parameters.

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

References lti::sort2< T, U >::parameters::parameters().

template<class T, class U = int>

parameters& lti::sort2< T, U >::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::sort< T >::parameters.

References lti::sort2< T, U >::parameters::whichVectors.

Referenced by lti::sort2< T, U >::parameters::parameters().

template<class T, class U = int>

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

Returns name of this type.

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

template<class T, class U = int>

virtual bool lti::sort2< T, U >::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 read, otherwise only the data block will be read.

Returns:: true if write was successful

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

References lti::sort2< T, U >::parameters::Columns, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), lti::sort2< T, U >::parameters::Rows, and lti::sort2< T, U >::parameters::whichVectors.

template<class T, class U = int>

virtual bool lti::sort2< T, U >::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.