cvr::sort2::sort2::parameters Class Reference

The parameters for the class sort. More...

#include <cvrSort2.h>

Inheritance diagram for cvr::sort2::sort2::parameters:

[legend]

Collaboration diagram for cvr::sort2::sort2::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	read (ioHandler &handler, const bool complete=true)
virtual bool	write (ioHandler &handler, const bool complete=true) const
Public Attributes
eWhichVectors	whichVectors
eSortingOrder	sortingOrder
int	thresholdForBubble

---

Detailed Description

The parameters for the class sort.

---

Constructor & Destructor Documentation

cvr::sort2::sort2::parameters::parameters

(

)

Default constructor.

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

cvr::sort2::sort2::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

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

cvr::sort2::sort2::parameters::~parameters

(

)

[virtual]

Destructor.

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

---

Member Function Documentation

virtual parameters* cvr::sort2::sort2::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

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

parameters& cvr::sort2::sort2::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

virtual const std::string& cvr::sort2::sort2::parameters::name

(

)

const [virtual]

Returns the name of this class.

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

virtual parameters* cvr::sort2::sort2::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

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

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

virtual bool cvr::sort2::sort2::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			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

eSortingOrder cvr::sort2::sort2::parameters::sortingOrder

Order of the sorting the default value is ascending order.

int cvr::sort2::sort2::parameters::thresholdForBubble

For vector/matrices with size smaller than this value, a bubble sort will be used (this way is faster)!

The default value is usually 10, but if you configured your system for performance this value could change.

The best value can be found in the cvrPerformanceConfig.h file, under _CVR_PERFORMANCE_SORT_STOP_QUICKSORT.

Default value: 10 or better.

eWhichVectors cvr::sort2::sort2::parameters::whichVectors

Specify if in the apply(vector<T>,matrix<U>) the rows or the columns of the matrix should be sorted.

The default value is Rows

---

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

• cvrSort2.h