eLynx::Math::IMatrix Class Reference

M x N matrix interface. More...

#include <IMatrix.h>

Inheritance diagram for eLynx::Math::IMatrix:

List of all members.

Public Member Functions
virtual	~IMatrix ()
	Default virtual destructor implementation.
virtual uint32	GetWidth () const =0
	Returns width (number of columns, N) of the matrix.
virtual uint32	GetHeight () const =0
	Returns height (number of rows, M) of the matrix.
virtual const double &	operator() (uint32 iRow, uint32 iCol) const =0
	Matrix content access operator.
virtual double &	operator() (uint32 iRow, uint32 iCol)=0
	Matrix content access operator.
virtual void	SwapRows (uint32 iRow1, uint32 iRow2)=0
	Swaps specified rows of the matrix.
virtual void	SwapCols (uint32 iCol1, uint32 iCol2)=0
	Swaps specified columns of the matrix.

---

Detailed Description

M x N matrix interface.

Provides general interface to matrix objects. The interface include methods to query matrix size and to read and write its content. Moreover, it enables row and column swapping. The matrix uses row-first indexing and indices are zero-based by default.

---

Member Function Documentation

virtual uint32 eLynx::Math::IMatrix::GetHeight

(

)

const [pure virtual]

Returns height (number of rows, M) of the matrix.

Returns:

number of matrix rows

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

virtual uint32 eLynx::Math::IMatrix::GetWidth

(

)

const [pure virtual]

Returns width (number of columns, N) of the matrix.

Returns:

number of matrix columns

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

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

Matrix content access operator.

Can be used in form Matrix(r, c). () operator is prefered on [] operator, because it can have more params.

Parameters:

iRow	the row index
iCol	the column index

Returns:

the reference to specified matrix value

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

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

Matrix content access operator.

Can be used in form Matrix(r, c). () operator is prefered on [] operator, because it can have more params.

Parameters:

iRow	the row index
iCol	the column index

Returns:

the const reference to specified matrix value

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

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

Swaps specified columns of the matrix.

Parameters:

iCol1	the index of the first column to swap
iCol2	the index of the second column to swap

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

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

Swaps specified rows of the matrix.

Parameters:

iRow1	the index of the first row to swap
iRow2	the index of the second row to swap

Implemented in eLynx::Math::Matrix, eLynx::Math::SingleColMatrix, eLynx::Math::SingleRowMatrix, eLynx::Math::SubMatrix, and eLynx::Math::TransposedMatrix.

---

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

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