lti::validator Class Reference

Checks the validity of a matrix or vector with float or double elements. More...

#include <ltiValidator.h>

Inheritance diagram for lti::validator:

[legend]

Collaboration diagram for lti::validator:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class validator More...
Public Member Functions
	validator ()
	validator (const validator &other)
virtual	~validator ()
virtual const char *	getTypeName () const
bool	apply (const vector< double > &src) const
bool	apply (const vector< float > &src) const
bool	apply (const matrix< double > &src) const
bool	apply (const matrix< float > &src) const
validator &	copy (const validator &other)
validator &	operator= (const validator &other)
virtual functor *	clone () const
const parameters &	getParameters () const

---

Detailed Description

Checks the validity of a matrix or vector with float or double elements.

A matrix is invalid, if it contains nan or inf elements. Otherwise, it is assumed to be valid.

---

Constructor & Destructor Documentation

lti::validator::validator

(

)

default constructor

lti::validator::validator

(

const validator &

other

)

copy constructor

Parameters:

other

the object to be copied

virtual lti::validator::~validator

(

)

[virtual]

destructor

---

Member Function Documentation

bool lti::validator::apply

(

const matrix< float > &

src

)

const

operates on the given parameter.

Parameters:

src

matrix<float> with the source data.

Returns:

true if the matrix is valid or false otherwise.

bool lti::validator::apply

(

const matrix< double > &

src

)

const

operates on the given parameter.

Parameters:

src

matrix<double> with the source data.

Returns:

true if the matrix is valid or false otherwise.

bool lti::validator::apply

(

const vector< float > &

src

)

const

operates on the given parameter.

Parameters:

src

vector<float> with the source data.

Returns:

true if the vector is valid or false otherwise.

bool lti::validator::apply

(

const vector< double > &

src

)

const

operates on the given parameter.

Parameters:

src

vector<double> with the source data.

Returns:

true if the vector is valid or false otherwise.

virtual functor* lti::validator::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

validator& lti::validator::copy

(

const validator &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

const parameters& lti::validator::getParameters

(

)

const

returns used parameters

Reimplemented from lti::functor.

virtual const char* lti::validator::getTypeName

(

)

const [virtual]

returns the name of this type ("validator")

Reimplemented from lti::functor.

validator& lti::validator::operator=

(

const validator &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

---

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

• ltiValidator.h