eLynx::Math::MatrixColVector Class Reference

Adapter, that provides vector-like read/write access to the column of the matrix. More...

#include <MatrixColVector.h>

Inheritance diagram for eLynx::Math::MatrixColVector:

List of all members.

Public Member Functions
	MatrixColVector (IMatrix &iMatrix, uint32 iCol)
	Constructor, creates an column vector adapter above specified matrix and its column.
	MatrixColVector (const MatrixColVector &iC)
	Copy constructor.
MatrixColVector &	operator= (const MatrixColVector &iC)
	An assignement operator.
virtual uint32	GetSize () const
	Returns the vector size (matrix column height).
virtual const double &	operator() (uint32 iIndex) const
	Vector access operator - returns reference to particular value of the matrix column.
virtual double &	operator() (uint32 iIndex)
	Vector access operator - returns reference to particular value of the matrix column.
virtual void	SwapValues (uint32 iIndex1, uint32 iIndex2)
	Swaps specified vector (column) values.

---

Detailed Description

Adapter, that provides vector-like read/write access to the column of the matrix.

Adapter references a matrix and column index and acts like a vector of the same size and content as the specified column.

---

Constructor & Destructor Documentation

eLynx::Math::MatrixColVector::MatrixColVector	(	IMatrix &	iMatrix,
		uint32	iCol
	)

Constructor, creates an column vector adapter above specified matrix and its column.

Parameters:

iMatrix	the matrix
iCol	the index of the matrix column

eLynx::Math::MatrixColVector::MatrixColVector

(

const MatrixColVector &

iC )

Copy constructor.

Parameters:

iC	the object to be copied

---

Member Function Documentation

virtual uint32 eLynx::Math::MatrixColVector::GetSize

(

)

const [inline, virtual]

Returns the vector size (matrix column height).

Returns:

the size of the vector

Implements eLynx::Math::IVector.

virtual double& eLynx::Math::MatrixColVector::operator()

(

uint32

iIndex )

[inline, virtual]

Vector access operator - returns reference to particular value of the matrix column.

Parameters:

iIndex

the index in the vector/column

Returns:

the reference to the column value

Implements eLynx::Math::IVector.

virtual const double& eLynx::Math::MatrixColVector::operator()

(

uint32

iIndex )

const [inline, virtual]

Vector access operator - returns reference to particular value of the matrix column.

Parameters:

iIndex

the index in the vector/column

Returns:

the const reference to the column value

Implements eLynx::Math::IVector.

MatrixColVector& eLynx::Math::MatrixColVector::operator=

(

const MatrixColVector &

iC )

An assignement operator.

Parameters:

iC	the object to be copied

Returns:

the reference to this object

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

Swaps specified vector (column) values.

Parameters:

iIndex1	the index of the first value
iIndex2	the index of the second value

Implements eLynx::Math::IVector.

---

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

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