eLynx::Math::SubMatrix Class Reference

Adapter, that allows to work with part of the matrix as a separate matrix. More...

#include <SubMatrix.h>

Inheritance diagram for eLynx::Math::SubMatrix:

List of all members.

Public Member Functions
	SubMatrix (IMatrix &iMatrix, uint32 iRow1, uint32 iNRows, uint32 iCol1, uint32 iNCols)
	Constructor, creates submatrix adapter for given matrix and specified rows and columns.
	SubMatrix (const SubMatrix &iOther)
	Copy constructor.
SubMatrix &	operator= (const SubMatrix &iOther)
	An assignement operator.
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
	Submatrix content access operator.
virtual double &	operator() (uint32 iRow, uint32 iCol)
	Submatrix content access operator.
virtual void	SwapRows (uint32 iRow1, uint32 iRow2)
	Swaps content of the specified submatrix rows.
virtual void	SwapCols (uint32 iCol1, uint32 iCol2)
	Swaps content of the specified submatrix columns.

---

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.

---

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

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.

SubMatrix& eLynx::Math::SubMatrix::operator=

(

const SubMatrix &

iOther )

An assignement operator.

Parameters:

iOther

the object to copy

Returns:

the reference to this object

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.

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.

---

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

• E:/dev/eLynx/include/elx/math/SubMatrix.h