LUDecomposition Class Reference

This is the class used to calculate a LU decomposition of a rectangular matrix to solve the matrix equation A = bx. More...

#include <ludecomposition.h>

Collaboration diagram for LUDecomposition:

Public Member Functions
	LUDecomposition ()
	This is the default LUDecomposition constructor. More...
	LUDecomposition (const DoubleMatrix &A)
	This is the LUDecomposition constructor for a given DoubleMatrix. More...
	~LUDecomposition ()
	This is the default LUDecomposition destructor. More...
DoubleVector	Solve (const DoubleVector &b)
	This function will solve the matrix equation A = bx and return the resulting DoubleVector. More...
double	getLogDet ()
	This function will return the log of the determinate of the matrix. More...
int	isIllegal ()
	This function will return the flag to denote whether the algorithm will fail. More...

Detailed Description

This is the class used to calculate a LU decomposition of a rectangular matrix to solve the matrix equation A = bx.

Constructor & Destructor Documentation

LUDecomposition() [1/2]

LUDecomposition::LUDecomposition ( )

inline

This is the default LUDecomposition constructor.

LUDecomposition() [2/2]

LUDecomposition::LUDecomposition

(

const DoubleMatrix &

A

)

This is the LUDecomposition constructor for a given DoubleMatrix.

Parameters

A	is the DoubleMatrix that will be decomposed into a lower triangular matrix L and an upper triangular matrix U

~LUDecomposition()

LUDecomposition::~LUDecomposition ( )

inline

This is the default LUDecomposition destructor.

Member Function Documentation

getLogDet()

double LUDecomposition::getLogDet ( )

inline

This function will return the log of the determinate of the matrix.

Returns

logdet

isIllegal()

int LUDecomposition::isIllegal ( )

inline

This function will return the flag to denote whether the algorithm will fail.

Returns

illegal

Solve()

DoubleVector LUDecomposition::Solve

(

const DoubleVector &

b

)

This function will solve the matrix equation A = bx and return the resulting DoubleVector.

Parameters

b	is the DoubleVector that is to be used to solve the matrix equation A = bx

Returns

x, the solution of the matrix equation A = bx

---

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

• src/include/ludecomposition.h
• src/ludecomposition.cc