RealMat Class Reference

RealMat Class. More...

Inheritance diagram for RealMat:

[legend]Collaboration diagram for RealMat:

[legend]List of all members.

Constructors
	RealMat (u_int rows, u_int cols)
	RealMat (RealVec &src, u_int rstart, u_int rend, u_int rows, u_int cols)
	~RealMat ()
Unary Operators
RealMat &	operator- ()
RealMat &	transpose ()
Binary Operators
RealMat &	operator+= (const RealMat &r)
RealMat &	operator+= (const Real &r)
RealMat &	operator-= (const RealMat &r)
RealMat &	operator-= (const Real &r)
RealMat &	operator *= (const RealMat &r)
RealMat &	operator *= (const Real &r)
RealMat &	operator/= (const RealMat &r)
RealMat &	operator/= (const Real &r)
Vector-Matrix Operators
RealMat &	deltarule (Real rate, const RealVec &x, const RealVec &y)
static RealVec &	mul (RealVec &y, const RealVec &x, const RealMat &m)
static RealVec &	mul (RealVec &y, const RealMat &m, const RealVec &x)
Matrix-Matrix Operators
RealMat &	cover (const MatrixData< bool > &mask)
Math Functions
RealMat &	exp ()
RealMat &	scale (const Real v)
RealMat &	inv ()
Real	norm ()
void	normalize ()

---

Detailed Description

Motivation

Description

Warnings

---

Constructor & Destructor Documentation

RealMat	(	u_int	rows,
		u_int	cols
	)

Construct matrix of dimension size initialized to zero

RealMat	(	RealVec &	src,
		u_int	rstart,
		u_int	rend,
		u_int	rows,
		u_int	cols
	)

Construct a Matrix view from VectorData passed

Parameters:

src

is the RealVec from which this method constructs a RealMat view. See Documentation about MatrixData view constructor

~RealMat

(

)

Destructor

---

Member Function Documentation

RealMat& operator-

(

)

[inline]

Operator -

RealMat& transpose

(

)

[inline]

Transpose this RealMat

RealMat& operator+=

(

const RealMat &

r

)

[inline]

Operator += with RealMat

RealMat& operator+=

(

const Real &

r

)

[inline]

Operator += with Real

RealMat& operator-=

(

const RealMat &

r

)

[inline]

Operator -= with RealMat

RealMat& operator-=

(

const Real &

r

)

[inline]

Operator -= with Real

RealMat& operator *=

(

const RealMat &

r

)

[inline]

Operator *= with RealMat

RealMat& operator *=

(

const Real &

r

)

[inline]

Operator *= with Real

RealMat& operator/=

(

const RealMat &

r

)

[inline]

Operator /= with RealMat

RealMat& operator/=

(

const Real &

r

)

[inline]

Operator /= with Real

static RealVec& mul	(	RealVec &	y,
		const RealVec &	x,
		const RealMat &	m
	)			[static]

Right Multiplication: y += x*m

Parameters:

	y	the result of multiplication
	x	the vector
	m	the matrix

Returns:

the vector y

static RealVec& mul	(	RealVec &	y,
		const RealMat &	m,
		const RealVec &	x
	)			[static]

Left Multiplication: y += m*x

Parameters:

	y	the result of multiplication
	m	the matrix
	x	the vector

Returns:

the vector y

RealMat& deltarule	(	Real	rate,
		const RealVec &	x,
		const RealVec &	y
	)

Delta-Rule: m += rate * x * y
It return itself

Parameters:

	rate	is the factor of multiplicaton
	x	is the first vector, its dimension have to be the same of matrix's rows
	y	is the second vector, its dimension have to be the same of matrix's columns

RealMat& cover

(

const MatrixData< bool > &

mask

)

[inline]

Put to zero all elements at positions where mask elements are false

RealMat& exp

(

)

Exponential

RealMat& scale

(

const Real

v

)

[inline]

Scaling (scalar-vector multiply)

RealMat& inv

(

)

Element Inversion

Real norm

(

)

[inline]

"Entrywise" Norm of order 2 or Frobenius norm

void normalize

(

)

[inline]

normalize the matrix, so the "entrywise" norm is one

---

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

• include/realmat.h

Copyright © 2005-2008 G. Massera

Contact: emmegian (at) yahoo (dot) it

  Documentation generated by