VectorSmall< Dim > Class Template Reference

#include <VectorSmall.hpp>

Collaboration diagram for VectorSmall< Dim >:

Constructors and destructors
	VectorSmall ()
	Empty constructor (all components are set to zero) More...
	VectorSmall (const Real value)
	Non Empty constructor. More...
VectorSmall< Dim > &	operator= (VectorSmall< Dim > const &vector)
	Assignment operator. More...
	VectorSmall (VectorSmall< Dim > const &vector)
	Copy constructor. More...

Static initializations
static VectorSmall< Dim >	Constant (Real const &value)
	Constant initialization. More...
static VectorSmall< Dim >	Zero ()
	Zero initialization. More...

Overloaded operators
VectorSmall< Dim > &	operator+= (VectorSmall< Dim > const &vector)
	Operator +=. More...
VectorSmall< Dim >	operator+ (VectorSmall< Dim > const &vector) const
	Operator +. More...
VectorSmall< Dim > &	operator-= (VectorSmall< Dim > const &vector)
	Operator -=. More...
VectorSmall< Dim >	operator- (VectorSmall< Dim > const &vector) const
	Operator -. More...
VectorSmall< Dim > &	operator*= (Real const &factor)
	Operator *= (multiplication by scalar) More...
VectorSmall< Dim > &	operator/= (Real const &factor)
	Operator /= (division by scalar) More...
VectorSmall< Dim >	operator/ (Real const &factor) const
	Operator / (division by scalar) More...
Real const &	operator[] (UInt const &i) const
	Operator []. More...
Real &	operator[] (UInt const &i)
	Operator []. More...
Real const &	operator() (UInt const &i) const
	Operator () More...
Real &	operator() (UInt const &i)
	Operator () More...

Geometric Methods
Real	dot (VectorSmall< Dim > const &vector) const
	Scalar product. More...
MatrixSmall< Dim, Dim >	outerProduct (VectorSmall< Dim > const &vector) const
Real	norm () const
	norm More...
void	normalize ()
	Normalize vector. More...
VectorSmall< Dim >	normalized ()
	Create the versor associated to this VectorSmall. More...

Tools
static UInt	size ()
	function to get the size of the VectorSmall ( for compatibility with Eigen) More...

Data
Real	M_coords [Dim]
	Data storage. More...

Detailed Description

template<UInt Dim>
class LifeV::VectorSmall< Dim >

Definition at line 71 of file VectorSmall.hpp.

Constructor & Destructor Documentation

VectorSmall() [1/3]

VectorSmall ( )

inline

Empty constructor (all components are set to zero)

Definition at line 80 of file VectorSmall.hpp.

VectorSmall() [2/3]

VectorSmall ( const Real  value )

inline

Non Empty constructor.

Definition at line 89 of file VectorSmall.hpp.

VectorSmall() [3/3]

VectorSmall ( VectorSmall< Dim > const &  vector )

inline

Copy constructor.

Definition at line 108 of file VectorSmall.hpp.

Member Function Documentation

operator=()

VectorSmall<Dim>& operator= ( VectorSmall< Dim > const &  vector )

inline

Assignment operator.

Definition at line 98 of file VectorSmall.hpp.

Constant()

static VectorSmall<Dim> Constant ( Real const &  value )

inlinestatic

Constant initialization.

Definition at line 119 of file VectorSmall.hpp.

Here is the caller graph for this function:

Zero()

static VectorSmall<Dim> Zero ( )

inlinestatic

Zero initialization.

Definition at line 130 of file VectorSmall.hpp.

operator+=()

VectorSmall<Dim>& operator+= ( VectorSmall< Dim > const &  vector )

inline

Operator +=.

Definition at line 141 of file VectorSmall.hpp.

operator+()

VectorSmall<Dim> operator+ ( VectorSmall< Dim > const &  vector ) const

inline

Operator +.

Definition at line 151 of file VectorSmall.hpp.

operator-=()

VectorSmall<Dim>& operator-= ( VectorSmall< Dim > const &  vector )

inline

Operator -=.

Definition at line 158 of file VectorSmall.hpp.

operator-()

VectorSmall<Dim> operator- ( VectorSmall< Dim > const &  vector ) const

inline

Operator -.

Definition at line 168 of file VectorSmall.hpp.

operator*=()

VectorSmall<Dim>& operator*= ( Real const &  factor )

inline

Operator *= (multiplication by scalar)

Definition at line 175 of file VectorSmall.hpp.

operator/=()

VectorSmall<Dim>& operator/= ( Real const &  factor )

inline

Operator /= (division by scalar)

Definition at line 185 of file VectorSmall.hpp.

operator/()

VectorSmall<Dim> operator/ ( Real const &  factor ) const

inline

Operator / (division by scalar)

Definition at line 193 of file VectorSmall.hpp.

operator[]() [1/2]

Real const& operator[] ( UInt const &  i ) const

inline

Operator [].

Definition at line 200 of file VectorSmall.hpp.

operator[]() [2/2]

Real& operator[] ( UInt const &  i )

inline

Operator [].

Definition at line 207 of file VectorSmall.hpp.

operator()() [1/2]

Real const& operator() ( UInt const &  i ) const

inline

Operator ()

Definition at line 214 of file VectorSmall.hpp.

operator()() [2/2]

Real& operator() ( UInt const &  i )

inline

Operator ()

Definition at line 221 of file VectorSmall.hpp.

dot()

Real dot ( VectorSmall< Dim > const &  vector ) const

inline

Scalar product.

Parameters

vector

second operand

Returns

scalar product value

Definition at line 237 of file VectorSmall.hpp.

outerProduct()

MatrixSmall< Dim , Dim > outerProduct ( VectorSmall< Dim > const &  vector ) const

inline

Definition at line 247 of file VectorSmall.hpp.

norm()

Real norm ( ) const

inline

norm

Returns

norm value

Definition at line 263 of file VectorSmall.hpp.

Here is the caller graph for this function:

normalize()

void normalize ( )

inline

Normalize vector.

Definition at line 269 of file VectorSmall.hpp.

normalized()

VectorSmall<Dim> normalized ( )

inline

Create the versor associated to this VectorSmall.

Returns

the versor associated to this VectorSmall

Definition at line 278 of file VectorSmall.hpp.

size()

static UInt size ( )

inlinestatic

function to get the size of the VectorSmall ( for compatibility with Eigen)

Returns

the fixed size of the VectorSmall

Definition at line 292 of file VectorSmall.hpp.

Field Documentation

M_coords

Real M_coords[Dim]

private

Data storage.

Definition at line 305 of file VectorSmall.hpp.

---

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

• VectorSmall.hpp