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

eLynx::Math::SubMatrix Class Reference

#include <SubMatrix.h>

Inheritance diagram for eLynx::Math::SubMatrix:

eLynx::Math::IMatrix

List of all members.


Public Member Functions

 SubMatrix (IMatrix &iMatrix, uint32 iRow1, uint32 iNRows, uint32 iCol1, uint32 iNCols)
 SubMatrix (const SubMatrix &iOther)
SubMatrixoperator= (const SubMatrix &iOther)
virtual uint32 GetWidth () const
 Returns the width (number of columns) of the submatrix.
virtual uint32 GetHeight () const
 Returns the height (number of rows) of the submatrix.
virtual const double & operator() (uint32 iRow, uint32 iCol) const
virtual double & operator() (uint32 iRow, uint32 iCol)
virtual void SwapRows (uint32 iRow1, uint32 iRow2)
virtual void SwapCols (uint32 iCol1, uint32 iCol2)

Detailed Description

Adapter, that allows to work with part of the matrix as a separate matrix. The submatrix is an intersection of several rows and columns.

Definition at line 30 of file SubMatrix.h.


Constructor & Destructor Documentation

eLynx::Math::SubMatrix::SubMatrix ( IMatrix iMatrix,
uint32  iRow1,
uint32  iNRows,
uint32  iCol1,
uint32  iNCols 
)

Constructor, creates submatrix adapter for given matrix and specified rows and columns.

Parameters:
iMatrix the matrix object
iRow1 first row of the submatrix
iNRows the number of rows in the submatrix
iCol1 first column of the submatrix
iNCols the number of columns in the submatrix

eLynx::Math::SubMatrix::SubMatrix ( const SubMatrix iOther  ) 

Copy constructor

Parameters:
iOther the object to copy


Member Function Documentation

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

An assignement operator

Parameters:
iOther the object to copy
Returns:
the reference to this object

virtual uint32 eLynx::Math::SubMatrix::GetWidth (  )  const [inline, virtual]

Returns the width (number of columns) of the submatrix.

Implements eLynx::Math::IMatrix.

Definition at line 54 of file SubMatrix.h.

virtual uint32 eLynx::Math::SubMatrix::GetHeight (  )  const [inline, virtual]

Returns the height (number of rows) of the submatrix.

Implements eLynx::Math::IMatrix.

Definition at line 57 of file SubMatrix.h.

virtual const double& eLynx::Math::SubMatrix::operator() ( uint32  iRow,
uint32  iCol 
) const [virtual]

Submatrix content access operator. Can be used in form Matrix(r, c).

Parameters:
iRow the row index (in the submatrix)
iCol the column index (in the submatrix)
Returns:
the const reference to specified matrix value

Implements eLynx::Math::IMatrix.

virtual double& eLynx::Math::SubMatrix::operator() ( uint32  iRow,
uint32  iCol 
) [virtual]

Submatrix content access operator. Can be used in form Matrix(r, c).

Parameters:
iRow the row index (in the submatrix)
iCol the column index (in the submatrix)
Returns:
the reference to specified matrix value

Implements eLynx::Math::IMatrix.

virtual void eLynx::Math::SubMatrix::SwapRows ( uint32  iRow1,
uint32  iRow2 
) [virtual]

Swaps content of the specified submatrix rows

Parameters:
iRow1 the first row to swap
iRow2 the second row to swap

Implements eLynx::Math::IMatrix.

virtual void eLynx::Math::SubMatrix::SwapCols ( uint32  iCol1,
uint32  iCol2 
) [virtual]

Swaps content of the specified submatrix columns

Parameters:
iCol1 the first column to swap
iCol2 the second column to swap

Implements eLynx::Math::IMatrix.


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

Generated on 14 Apr 2009 by doxygen 1.5.8