MatrixMN Class Reference

A simple, non-optimized implementation of rectangular matrixes. More...

#include <matrix-mn.h>

Public Member Functions
	MatrixMN (int, int, double=0.0)
	Create a rectangular matrix.
	MatrixMN (int, double=0.0)
	Create a square matrix.
	MatrixMN (int, int, const std::vector< double > &)
	Create a square matrix.
	MatrixMN (const std::vector< std::vector< double > > &)
	Creates a rectangular matrix from a 2D std::vector.
double &	operator() (int, int)
	Return the matrix term value for given indexess.
double	operator() (int, int) const
	Return the matrix term value for given indexess.
void	SwapRows (int, int)
	Swap rows.
MatrixMN	Transpose () const
	Transpose.
MatrixMN	Inverse () const
	Compute the Gauss Jordan inverse.
MatrixMN &	operator+= (const MatrixMN &)
	Self sum.
MatrixMN &	operator-= (const MatrixMN &)
	Self difference.
MatrixMN &	operator*= (const MatrixMN &)
	Self product.
MatrixMN &	operator*= (const double &)
	Self multiply by a scalar.
MatrixMN &	operator/= (const double &)
	Self division by a scalar.

Static Public Member Functions
static MatrixMN	Identity (int)
	Create the identity matrix.
static MatrixMN	Covariance (const std::vector< std::vector< double > > &vectors)
	Create the covariance matrix of a given set of vectors.

Protected Member Functions
int	Index (int, int) const
	Compute the entry of a term.
bool	SameSize (const MatrixMN &) const
	Test if the matrix has the same size as the argument matrix.

Protected Attributes
int	m = 0
	Rows.
int	n = 0
	Columns.
std::vector< double >	v
	Array of data.

Friends
MatrixMN	operator+ (const MatrixMN &a, const MatrixMN &b)
	Sum.
MatrixMN	operator- (const MatrixMN &a, const MatrixMN &b)
	Difference.
MatrixMN	operator* (const MatrixMN &a, const MatrixMN &b)
	Product.
MatrixMN	operator* (const MatrixMN &a, double b)
	Right multiply by a scalar.
MatrixMN	operator* (double b, MatrixMN &a)
	Left multiply by a scalar.
std::ostream &	operator<< (std::ostream &s, const MatrixMN &mat)
	Overloaded.

Detailed Description

A simple, non-optimized implementation of rectangular matrixes.

Author

Hugo Schott

Constructor & Destructor Documentation

MatrixMN() [1/4]

MatrixMN::MatrixMN	(	int	m,
		int	n,
		double	d = 0.0 )

Create a rectangular matrix.

Parameters

m,n	Size in rows, columns.
d	Default scalar value.

MatrixMN() [2/4]

MatrixMN::MatrixMN	(	int	n,
		double	d = 0.0 )

Create a square matrix.

Parameters

n	Size.
d	Default scalar value.

MatrixMN() [3/4]

MatrixMN::MatrixMN	(	int	m,
		int	n,
		const std::vector< double > &	data )

Create a square matrix.

Parameters

m,n	Size in rows, columns.
data	Linearized array of values.

MatrixMN() [4/4]

MatrixMN::MatrixMN

(

const std::vector< std::vector< double > > &

data

)

Creates a rectangular matrix from a 2D std::vector.

Parameters

data	2D std::vector, each row must have same number of elements.

Member Function Documentation

Covariance()

MatrixMN MatrixMN::Covariance ( const std::vector< std::vector< double > > & vectors )

static

Create the covariance matrix of a given set of vectors.

Parameters

vectors

Set of vectors, they must have the same size.

Identity()

MatrixMN MatrixMN::Identity ( int n )

static

Create the identity matrix.

Parameters

n

Size.

Index()

int MatrixMN::Index ( int i, int j ) const

inlineprotected

Compute the entry of a term.

Parameters

i,j

Indexes.

Inverse()

MatrixMN MatrixMN::Inverse

(

)

const

Compute the Gauss Jordan inverse.

The function only works the matrix is squared

operator()() [1/2]

double & MatrixMN::operator() ( int i, int j )

inline

Return the matrix term value for given indexess.

Parameters

i,j	Integer coordinates of the vertex.

operator()() [2/2]

double MatrixMN::operator() ( int i, int j ) const

inline

Return the matrix term value for given indexess.

Parameters

i,j	Integer coordinates of the vertex.

operator*=() [1/2]

MatrixMN & MatrixMN::operator*=

(

const double &

d

)

Self multiply by a scalar.

Parameters

d

Real.

operator*=() [2/2]

MatrixMN & MatrixMN::operator*=

(

const MatrixMN &

a

)

Self product.

Parameters

a

Matrix.

operator+=()

MatrixMN & MatrixMN::operator+=

(

const MatrixMN &

a

)

Self sum.

Parameters

a

Matrix.

operator-=()

MatrixMN & MatrixMN::operator-=

(

const MatrixMN &

a

)

Self difference.

Parameters

a

Matrix.

operator/=()

MatrixMN & MatrixMN::operator/=

(

const double &

d

)

Self division by a scalar.

Parameters

d

Real.

SameSize()

bool MatrixMN::SameSize ( const MatrixMN & A ) const

inlineprotected

Test if the matrix has the same size as the argument matrix.

Parameters

A

Matrix

SwapRows()

void MatrixMN::SwapRows	(	int	i,
		int	j )

Swap rows.

Parameters

i,j

Indexes.

Friends And Related Symbol Documentation

operator* [1/3]

MatrixMN operator* ( const MatrixMN & a, const MatrixMN & b )

friend

Product.

Parameters

a,b

Matrixes.

operator* [2/3]

MatrixMN operator* ( const MatrixMN & a, double b )

friend

Right multiply by a scalar.

Parameters

a	Matrix.
b	Real.

operator* [3/3]

MatrixMN operator* ( double b, MatrixMN & a )

friend

Left multiply by a scalar.

Parameters

a	Matrix.
b	Real.

operator+

MatrixMN operator+ ( const MatrixMN & a, const MatrixMN & b )

friend

Sum.

Parameters

a,b

Matrixes.

operator-

MatrixMN operator- ( const MatrixMN & a, const MatrixMN & b )

friend

Difference.

Parameters

a,b

Matrixes.

operator<<

std::ostream & operator<< ( std::ostream & s, const MatrixMN & mat )

friend

Overloaded.

Parameters

s	Stream.
mat	Matrix.