eLynx SDK v3.0.1
C++ image processing API reference

eLynx::Math::Vector Class Reference

#include <Vector.h>

Inheritance diagram for eLynx::Math::Vector:

eLynx::Math::IVector

List of all members.


Public Member Functions

 Vector (uint32 iSize)
 Vector (const IVector &iOther)
 Vector (const Vector &iOther)
Vectoroperator= (const Vector &iOther)
void Resize (uint32 iSize)
double GetLength () const
IVector implementation
virtual uint32 GetSize () const
virtual const double & operator() (uint32 iIndex) const
virtual double & operator() (uint32 iIndex)
virtual void SwapValues (uint32 iIndex1, uint32 iIndex2)

Detailed Description

Basic N-size vector implementation as array of doubles. Vector indices are zero-based.

Definition at line 31 of file Vector.h.


Constructor & Destructor Documentation

eLynx::Math::Vector::Vector ( uint32  iSize  ) 

Constructor, creates vector of specified size. The content of the vector is not initialized.

Parameters:
iSize the size of the vector

eLynx::Math::Vector::Vector ( const IVector iOther  ) 

Constructor, creates vector as a copy of given vector.

Parameters:
iOther the vector to copy.

eLynx::Math::Vector::Vector ( const Vector iOther  ) 

Copy constructor.

Parameters:
iOther the vector to copy.


Member Function Documentation

Vector& eLynx::Math::Vector::operator= ( const Vector iOther  ) 

An assignement operator

Parameters:
iOther the vector to copy.
Returns:
the reference to this vector.

virtual uint32 eLynx::Math::Vector::GetSize (  )  const [inline, virtual]

Returns the size of the vector.

Returns:
the dimension of the vector ie number of components.

Implements eLynx::Math::IVector.

Definition at line 56 of file Vector.h.

virtual const double& eLynx::Math::Vector::operator() ( uint32  iIndex  )  const [virtual]

Vector content access operator. Can be used in form Vector(i). () operator is prefered on [] operator to unify content access for vectors and matrices.

Parameters:
iIndex the vector value index
Returns:
the const reference to specified vector value

Implements eLynx::Math::IVector.

virtual double& eLynx::Math::Vector::operator() ( uint32  iIndex  )  [virtual]

Vector content access operator. Can be used in form Vector(i). () operator is prefered on [] operator to unify content access for vectors and matrices.

Parameters:
iIndex the vector value index
Returns:
the reference to specified vector value

Implements eLynx::Math::IVector.

virtual void eLynx::Math::Vector::SwapValues ( uint32  iIndex1,
uint32  iIndex2 
) [virtual]

Swaps specified values of the vector.

Parameters:
iIndex1 the index of the first value to swap
iIndex2 the index of the second value to swap

Implements eLynx::Math::IVector.

void eLynx::Math::Vector::Resize ( uint32  iSize  ) 

Resizes vector to specified size. The vector content is not defined after this operation.

Parameters:
iSize the size of the vector.

double eLynx::Math::Vector::GetLength (  )  const

Computes vector euclidean length.

Returns:
the length of the vector


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

Generated on 14 Apr 2009 by doxygen 1.5.8