LAMA
Public Member Functions
lama::L2Norm Class Reference

L2Norm is a functor specialization of Norm that calculates the l2 norm for the passed values. More...

#include <L2Norm.hpp>

Inheritance diagram for lama::L2Norm:
Inheritance graph
[legend]

Public Member Functions

 L2Norm ()
 Constructs a L2Norm functor.
virtual ~L2Norm ()
 Destroys this L2Norm functor.
virtual Scalar apply (const Scalar &scalar) const
 calculates the l2 norm of the passed Scalar.
virtual Scalar apply (const Vector &vector) const
 calculates the l2 norm of the passed Vector.
Scalar operator() (const Scalar &scalar) const
 Calculates the norm of the passed Scalar.
Scalar operator() (const Vector &vector) const
 Calculates the norm of the passed Vector.

Detailed Description

L2Norm is a functor specialization of Norm that calculates the l2 norm for the passed values.

Constructor & Destructor Documentation

lama::L2Norm::L2Norm ( )

Constructs a L2Norm functor.

lama::L2Norm::~L2Norm ( ) [virtual]

Destroys this L2Norm functor.

Member Function Documentation

Scalar lama::L2Norm::apply ( const Scalar &  scalar) const [virtual]

calculates the l2 norm of the passed Scalar.

Parameters:
[in]scalarthe Scalar to calculate the l2 norm of.
Returns:
the l2 norm of the Scalar scalar.

Implements lama::Norm.

References lama::l2Norm().

Scalar lama::L2Norm::apply ( const Vector &  vector) const [virtual]

calculates the l2 norm of the passed Vector.

Parameters:
[in]vectorthe Vector to calculate the l2 norm of.
Returns:
the l2 norm of the Vector vector.

Implements lama::Norm.

References lama::l2Norm().

Scalar lama::Norm::operator() ( const Scalar &  scalar) const [inherited]

Calculates the norm of the passed Scalar.

To call this is equivalent to call apply with the same argument.

Parameters:
[in]scalarthe Scalar to caluclate the norm for.
Returns:
the norm of scalar.

References lama::Norm::apply().

Scalar lama::Norm::operator() ( const Vector &  vector) const [inherited]

Calculates the norm of the passed Vector.

To call this is equivalent to call apply with the same argument.

Parameters:
[in]vectorthe Vector to caluclate the norm for.
Returns:
the norm of vector.

References lama::Norm::apply().

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