FREE::Accessor::VectorToNormAccessor< TVector > Class Template Reference
[Evaluation tools]

Accessor class which computes the norm of a vector. More...

#include <freVectorToNormAccessor.h>

List of all members.

Public Types
typedef VectorToNormAccessor	Self
typedef TVector	InternalType
typedef InternalType::ValueType	ExternalType
Public Member Functions
void	Set (InternalType &output, const ExternalType &input) const
ExternalType	Get (const InternalType &input) const
void	SetNormVector (const InternalType &normVector)
InternalType	GetNormVector () const
	VectorToNormAccessor ()
	~VectorToNormAccessor ()
Private Attributes
InternalType	m_NormVector
ExternalType	m_NormVectorNorm

---

Detailed Description

template<class TVector>
class FREE::Accessor::VectorToNormAccessor< TVector >

Accessor class which computes the norm of a vector.

The accessor calculates the norm of a passed vector. The accessor is also able to calculate the norm of the projection along a given "norm vector". If the norm of this "norm vector" is 0, no projection will be calculated, the norm will then be directly calculated. By default the "norm vector" is 0, so the direct norm will be calculated.

Remarks:

Any "norm vector" passed to the accessor will be internally stored as its normalized version to increase the accessor speed (if its norm is not 0).

Definition at line 47 of file freVectorToNormAccessor.h.

---

Member Typedef Documentation

template<class TVector>

typedef VectorToNormAccessor FREE::Accessor::VectorToNormAccessor< TVector >::Self

Standard class typedefs.

Definition at line 51 of file freVectorToNormAccessor.h.

template<class TVector>

typedef TVector FREE::Accessor::VectorToNormAccessor< TVector >::InternalType

Internal typedef. It defines the internal real representation of data

Definition at line 55 of file freVectorToNormAccessor.h.

template<class TVector>

typedef InternalType::ValueType FREE::Accessor::VectorToNormAccessor< TVector >::ExternalType

External typedef. It defines the external aspect that this class will exhibit

Definition at line 59 of file freVectorToNormAccessor.h.

---

Constructor & Destructor Documentation

template<class TVector>

FREE::Accessor::VectorToNormAccessor< TVector >::VectorToNormAccessor

(

)

[inline]

Definition at line 32 of file freVectorToNormAccessor.cxx.

References FREE::Accessor::VectorToNormAccessor< TVector >::m_NormVector, and FREE::Accessor::VectorToNormAccessor< TVector >::m_NormVectorNorm.

template<class TVector>

FREE::Accessor::VectorToNormAccessor< TVector >::~VectorToNormAccessor

(

)

[inline]

Definition at line 40 of file freVectorToNormAccessor.cxx.

---

Member Function Documentation

template<class TVector>

void FREE::Accessor::VectorToNormAccessor< TVector >::Set	(	InternalType &	output,
		const ExternalType &	input
	)			const [inline]

Write access to the VectorToNorm component

Definition at line 62 of file freVectorToNormAccessor.h.

template<class TVector>

ExternalType FREE::Accessor::VectorToNormAccessor< TVector >::Get

(

const InternalType &

input

)

const [inline]

Read access to the VectorToNorm component

Definition at line 68 of file freVectorToNormAccessor.h.

template<class TVector>

void FREE::Accessor::VectorToNormAccessor< TVector >::SetNormVector

(

const InternalType &

normVector

)

[inline]

Definition at line 77 of file freVectorToNormAccessor.h.

template<class TVector>

InternalType FREE::Accessor::VectorToNormAccessor< TVector >::GetNormVector

(

)

const [inline]

Definition at line 84 of file freVectorToNormAccessor.h.

---

Member Data Documentation

template<class TVector>

InternalType FREE::Accessor::VectorToNormAccessor< TVector >::m_NormVector [private]

Norm vector used to calculate the norm as projection along itself.

Definition at line 94 of file freVectorToNormAccessor.h.

Referenced by FREE::Accessor::VectorToNormAccessor< TVector >::VectorToNormAccessor().

template<class TVector>

ExternalType FREE::Accessor::VectorToNormAccessor< TVector >::m_NormVectorNorm [private]

The Norm of the norm vector. Used as cache to increase the speed of the accessor.

Definition at line 96 of file freVectorToNormAccessor.h.

Referenced by FREE::Accessor::VectorToNormAccessor< TVector >::VectorToNormAccessor().

---

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

• freVectorToNormAccessor.h
• freVectorToNormAccessor.cxx

---