lti::multiplyScalar< T > Class Template Reference

Multiply by Scalar functor class. More...

#include <ltiMultScalar.h>

Inheritance diagram for lti::multiplyScalar< T >:

[legend]

Collaboration diagram for lti::multiplyScalar< T >:

[legend]

List of all members.

Public Member Functions
	multiplyScalar ()
	multiplyScalar (const T theValue)
	multiplyScalar (const parameters &theParams)
virtual	~multiplyScalar ()
virtual vector< T > &	apply (vector< T > &theObject) const
virtual vector< T > &	apply (const vector< T > &theObject, vector< T > &newObject) const
virtual matrix< T > &	apply (matrix< T > &theObject) const
virtual matrix< T > &	apply (const matrix< T > &theObject, matrix< T > &newObject) const
virtual functor *	clone () const
virtual const char *	getTypeName () const

---

Detailed Description

template<class T>
class lti::multiplyScalar< T >

Multiply by Scalar functor class.

apply() multiplies each element of the mathObj by the given scalar value.

---

Constructor & Destructor Documentation

template<class T >

lti::multiplyScalar< T >::multiplyScalar

(

)

[inline]

default constructor, sets the scalar value to 0

template<class T >

lti::multiplyScalar< T >::multiplyScalar

(

const T

theValue

)

[inline]

constructor, sets the scalar value.

template<class T >

lti::multiplyScalar< T >::multiplyScalar

(

const parameters &

theParams

)

[inline]

constructor, sets the parameters, i.e. the scalar value.

template<class T >

virtual lti::multiplyScalar< T >::~multiplyScalar

(

)

[virtual]

destructor

---

Member Function Documentation

template<class T >

virtual matrix<T>& lti::multiplyScalar< T >::apply	(	const matrix< T > &	theObject,
		matrix< T > &	newObject
	)			const [virtual]

onCopy version of apply.

applies the functor's function to the copy of 'theObject', 'newObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual matrix<T>& lti::multiplyScalar< T >::apply

(

matrix< T > &

theObject

)

const [virtual]

onPlace version of apply.

applies the functor's function to 'theObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual vector<T>& lti::multiplyScalar< T >::apply	(	const vector< T > &	theObject,
		vector< T > &	newObject
	)			const [virtual]

onCopy version of apply.

applies the functor's function to the copy of 'theObject', 'newObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual vector<T>& lti::multiplyScalar< T >::apply

(

vector< T > &

theObject

)

const [virtual]

onPlace version of apply.

applies the functor's function to 'theObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual functor* lti::multiplyScalar< T >::clone

(

)

const [virtual]

returns a pointer to a clone of the functor.

Implements lti::functor.

template<class T >

virtual const char* lti::multiplyScalar< T >::getTypeName

(

)

const [virtual]

returns the name of this type

Reimplemented from lti::iteratingFunctor< T >.

---

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

• ltiMultScalar.h