eLynx SDK v3.3.0
C++ image processing API reference
Public Member Functions

eLynx::Math::IVector Class Reference

N-size vector interface. More...

#include <IVector.h>

Inheritance diagram for eLynx::Math::IVector:
eLynx::Math::MatrixColVector eLynx::Math::MatrixRowVector eLynx::Math::Vector

List of all members.

Public Member Functions

virtual ~IVector ()
 Default virtual destructor implementation.
virtual uint32 GetSize () const =0
 Returns the size of the vector.
virtual const double & operator() (uint32 iIndex) const =0
 Vector content access operator.
virtual double & operator() (uint32 iIndex)=0
 Vector content access operator.
virtual void SwapValues (uint32 iIndex1, uint32 iIndex2)=0
 Swaps specified values of the vector.

Detailed Description

N-size vector interface.

Provides general interface to vector objects. The interface include methods to query vector size and to read and write its content. Moreover, it enables value swapping. The vector indices are zero-based by default.


Member Function Documentation

virtual uint32 eLynx::Math::IVector::GetSize (  ) const [pure virtual]

Returns the size of the vector.

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

Implemented in eLynx::Math::MatrixColVector, eLynx::Math::MatrixRowVector, and eLynx::Math::Vector.

virtual const double& eLynx::Math::IVector::operator() ( uint32  iIndex ) const [pure 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:
iIndexthe vector value index
Returns:
the const reference to specified vector value

Implemented in eLynx::Math::MatrixColVector, eLynx::Math::MatrixRowVector, and eLynx::Math::Vector.

virtual double& eLynx::Math::IVector::operator() ( uint32  iIndex ) [pure 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:
iIndexthe vector value index
Returns:
the reference to specified vector value

Implemented in eLynx::Math::MatrixColVector, eLynx::Math::MatrixRowVector, and eLynx::Math::Vector.

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

Swaps specified values of the vector.

Parameters:
iIndex1the index of the first value to swap
iIndex2the index of the second value to swap

Implemented in eLynx::Math::MatrixColVector, eLynx::Math::MatrixRowVector, and eLynx::Math::Vector.


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

Generated on Thu Dec 9 2010 by doxygen 1.7.2