Slu class

Wrapper class for a generic sparse direct solver. More...

Files
file	slu.h
	Class Slu: Wrapper class for a generic sparse direct solver.
Classes
struct	sSlu
	Contains public data members for Slu class. More...
Typedefs
typedef struct sSlu	Slu
	Declaration of the Slu class as the Slu structure.
Functions
Slu *	Slu_ctor (Vmem *vmem, int skey, int m, int n, int nnz, int *ia, int *ja, double *a)
	The Slu constructor.
void	Slu_dtor (Slu **thee)
	The Slu destructor.
int	Slu_factor (Slu *thee)
	Sparse LU factor the system.
int	Slu_solve (Slu *thee, int key, double *b, double *x)
	Use sparse LU factors to back/forward solve a linear system.
double	Slu_lnDet (Slu *thee)
	Calculate the log of the determinant of a factored matrix.

---

Detailed Description

Wrapper class for a generic sparse direct solver.

---

Typedef Documentation

typedef struct sSlu Slu

Declaration of the Slu class as the Slu structure.

Author:

Michael Holst and Stephen Bond

Returns:

None

---

Function Documentation

Slu* Slu_ctor	(	Vmem *	vmem,
		int	skey,
		int	m,
		int	n,
		int	nnz,
		int *	ia,
		int *	ja,
		double *	a
	)

The Slu constructor.

Author:

Michael Holst and Stephen Bond

Note:

Class Slu: Non-inlineable methods (slu.c)

Returns:

Pointer to a newly allocated (empty) Slu class

Parameters:

	vmem	Memory management object
	skey	index for storage format (0=row-wise YSMP, 1=col-wise YSMP)
	m	number of rows
	n	number of cols
	nnz	number of nonzeros
	ia	row-start (skey=0) or col-start (skey=1) in < j a >& < a >
	ja	col indices (skey=0) or row-indices (skey=1) for < a >
	a	the nonzeros in the matrix

void Slu_dtor

(

Slu **

thee

)

The Slu destructor.

Author:

Michael Holst and Stephen Bond

Note:

Class Slu: Non-inlineable methods (slu.c)

Returns:

None

Parameters:

thee

Pointer to the Slu class

int Slu_factor

(

Slu *

thee

)

Sparse LU factor the system.

Author:

Michael Holst and Stephen Bond

Note:

Class Slu: Non-inlineable methods (slu.c)

Returns:

Sparse LU factor the system

Parameters:

thee

Pointer to the Slu class

double Slu_lnDet

(

Slu *

thee

)

Calculate the log of the determinant of a factored matrix.

Author:

Stephen Bond

Note:

Class Slu: Non-inlineable methods (slu.c)

Returns:

the log of the determinant of a factored matrix

Parameters:

thee

Pointer to the Slu class

int Slu_solve	(	Slu *	thee,
		int	key,
		double *	b,
		double *	x
	)

Use sparse LU factors to back/forward solve a linear system.

Author:

Michael Holst and Stephen Bond

Note:

Class Slu: Non-inlineable methods (slu.c)

Returns:

Success enumeration

Parameters:

	thee	Pointer to the Slu class
	key	index for different solution methods
	b	Pointer to the array b
	x	Pointer to the array x