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

the parameters for the class regularizedPCA More...

#include <ltiRegularizedPCA.h>

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

[legend]

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

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (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
T	kappa

Detailed Description

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

the parameters for the class regularizedPCA

Constructor & Destructor Documentation

template<class T>

lti::regularizedPCA< T >::parameters::parameters ( void ) [inline]

default constructor

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

References lti::regularizedPCA< T >::parameters::kappa.

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

template<class T>

lti::regularizedPCA< T >::parameters::parameters ( const parameters & other ) [inline]

copy constructor

Parameters:

other

the parameters object to be copied

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

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

template<class T>

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

destructor

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

Member Function Documentation

template<class T>

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

returns a pointer to a clone of the parameters

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

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

template<class T>

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

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

References lti::functor::parameters::copy(), and lti::regularizedPCA< T >::parameters::kappa.

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

template<class T>

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

returns name of this type

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

template<class T>

parameters& lti::regularizedPCA< T >::parameters::operator= ( const parameters & other ) [inline]

Assigns the contents of the other object to this object.

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

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

template<class T>

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

Returns:: true if write was successful

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

References lti::regularizedPCA< T >::parameters::kappa, lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T>

virtual bool lti::regularizedPCA< 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.