FMatrix Class Reference

#include <FMatrix.h>

Collaboration diagram for FMatrix:

Public Member Functions
void	LUD ()
void	LUsolve (Real *)
FMatrix &	operator= (FMatrix &)
template<class T >
	FMatrix (T, T)
	~FMatrix ()
void	Zero ()
FMatrix *	Transpose (bool)
FMatrix *	Invert ()
void	resize (int, int)
FMatrix *	Inv ()

Public Attributes
int	mxNCols =0
	max. number of cols More...
int	mxNRows =0
	max. number of rows More...
int	NCols =0
	actual number of cols More...
int	NRows =0
	actual number of rows More...
int	lsize =0
	local size More...
Real **	Ent =NULL
	matrix entries More...
bool	decomposed =false
	true if decomposed More...
int *	indx =NULL
	indices for decomposition More...
Real **	base1 =NULL
	base1 version of matrix More...

Detailed Description

Routines to perform operations on small, local Full Matrices

For larger, possibly distributed dense matrices, set the matreix structure to DenseSym or DenseASym

Definition at line 20 of file FMatrix.h.

Constructor & Destructor Documentation

FMatrix()

template<class T >

FMatrix::FMatrix	(	T	,
		T
	)

Here is the caller graph for this function:

~FMatrix()

FMatrix::~FMatrix

(

)

Free Element Matrix

Parameters

M	element matrix

Postcondition

element matrix memory freed

Definition at line 10 of file FMatrix.cc.

Member Function Documentation

Inv()

FMatrix * FMatrix::Inv

(

)

invert a matrix

Parameters

[in,out]	A	the matrix
[out]	A_inv	the inverted matrix

Postcondition

A is decomposed, A_inv holds inverse

Returns

inverted matrix

Definition at line 376 of file FMatrix.cc.

Invert()

FMatrix * FMatrix::Invert

(

)

invert a matrix

Parameters

[in]	A	the matrix
[out]	A_inv	the inverted matrix

Postcondition

A_inv holds inverse, matrix A is unchanged

Returns

inverted matrix

Definition at line 407 of file FMatrix.cc.

LUD()

void FMatrix::LUD

(

)

perform LU decomposition on an FMatrix

Parameters

a	the matrix

Return values

the	sign of the determinant

Postcondition

the matrix decomposed, the decompose flag is set, indx is allocated, and a base1 array is set up

Definition at line 320 of file FMatrix.cc.

Here is the caller graph for this function:

LUsolve()

void FMatrix::LUsolve

(

Real *

rhs

)

perform back and forward substitution to solve a linear system Ax=b

Parameters

A	the matrix
rhs	the right hand side, b

Precondition

A has been decomposed and is now base 1

Postcondition

rhs is the solution, x

Definition at line 355 of file FMatrix.cc.

Here is the caller graph for this function:

operator=()

FMatrix & FMatrix::operator=

(

FMatrix &

A

)

B:=A

copy matrix A into B

Parameters

[in]	A	matrix to be copied
[out]	B	matrix we copy into

Postcondition

B is equal to A

Returns

pointer to B

Definition at line 48 of file FMatrix.cc.

resize()

void FMatrix::resize	(	int	nr,
		int	nc
	)

set size of FMatrix to use

Parameters

[in,out]	M	the matrix to be resized
[in]	nr	number or rows in resized matrix
[in]	nc	number of columns in resized matrix

Postcondition

the matrix will be zeroed

Definition at line 73 of file FMatrix.cc.

Here is the caller graph for this function:

Transpose()

FMatrix * FMatrix::Transpose

(

bool

ip

)

transpose a matrix

Parameters

A	the matrix
A_t	the transposed matrix

A_t can be NULL (in this case A_t will be allocated) or A_t == A (in-place transpose)

Postcondition

A is transposed

Definition at line 443 of file FMatrix.cc.

Zero()

void FMatrix::Zero

(

)

Zero Element Matrix

Parameters

M	element matrix

Postcondition

element matrix memory freed

Definition at line 28 of file FMatrix.cc.

Here is the caller graph for this function:

Member Data Documentation

base1

Real** FMatrix::base1 =NULL

base1 version of matrix

Definition at line 30 of file FMatrix.h.

decomposed

bool FMatrix::decomposed =false

true if decomposed

Definition at line 28 of file FMatrix.h.

Ent

Real** FMatrix::Ent =NULL

matrix entries

Definition at line 27 of file FMatrix.h.

indx

int* FMatrix::indx =NULL

indices for decomposition

Definition at line 29 of file FMatrix.h.

lsize

int FMatrix::lsize =0

local size

Definition at line 26 of file FMatrix.h.

mxNCols

int FMatrix::mxNCols =0

max. number of cols

Definition at line 22 of file FMatrix.h.

mxNRows

int FMatrix::mxNRows =0

max. number of rows

Definition at line 23 of file FMatrix.h.

NCols

int FMatrix::NCols =0

actual number of cols

Definition at line 24 of file FMatrix.h.

NRows

int FMatrix::NRows =0

actual number of rows

Definition at line 25 of file FMatrix.h.

---

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

• tools/igbutils/FMatrix.h
• tools/igbutils/FMatrix.cc