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

The parameters for the class quickMedian. More...

#include <ltiQuickMedian.h>

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

[legend]

Collaboration diagram for lti::quickMedian< T >::parameters:

[legend]

List of all members.

Public Types
enum	eEvenCase { TakeLower, TakeHigher }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
Public Attributes
eEvenCase	evenCase

---

Detailed Description

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

The parameters for the class quickMedian.

---

Member Enumeration Documentation

template<class T>

enum lti::quickMedian::parameters::eEvenCase

This enum specifies how to consider the case of vectors with an even number of elements.

Enumerator:

TakeLower	take the element with the lower index, i.e. N/2-1 with N the number of elements of the vector
TakeHigher	take the element with the higher index, i.e. N/2 with N the number of elements of the vector

---

Constructor & Destructor Documentation

template<class T>

lti::quickMedian< T >::parameters::parameters

(

void

)

[inline]

Default constructor.

Reimplemented from lti::functor::parameters.

References lti::quickMedian< T >::parameters::evenCase, and lti::quickMedian< T >::parameters::TakeLower.

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

template<class T>

lti::quickMedian< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

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

template<class T>

lti::quickMedian< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

template<class T>

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

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

template<class T>

parameters& lti::quickMedian< 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::quickMedian< T >::parameters::evenCase.

Referenced by lti::quickMedian< T >::parameters::parameters().

template<class T>

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

---

Member Data Documentation

template<class T>

eEvenCase lti::quickMedian< T >::parameters::evenCase

Specifies how to consider the case when the number of elements of the vector is even (see eEvenCase).

This parameter has no effect for odd-sized vectors.

Default value: TakeLower

Referenced by lti::quickMedian< T >::parameters::copy(), and lti::quickMedian< T >::parameters::parameters().

---

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

• ltiQuickMedian.h