nl_cholmod.h File Reference

Internal OpenNL functions that interface Cholmod. More...

#include "nl_private.h"
#include "nl_matrix.h"

Go to the source code of this file.

Functions
NLAPI NLMatrix NLAPIENTRY	nlMatrixFactorize_CHOLMOD (NLMatrix M, NLenum solver)
	Factorizes a matrix using Cholmod.
NLboolean	nlInitExtension_CHOLMOD (void)
	Initializes the CHOLMOD extension.
NLboolean	nlExtensionIsInitialized_CHOLMOD (void)
	Tests whether the CHOLMOD extension is initialized.

Detailed Description

Internal OpenNL functions that interface Cholmod.

Definition in file nl_cholmod.h.

Function Documentation

nlExtensionIsInitialized_CHOLMOD()

NLboolean nlExtensionIsInitialized_CHOLMOD

(

void

)

Tests whether the CHOLMOD extension is initialized.

Return values

NL_TRUE	if the extension is initialized
NL_FALSE	otherwise

nlInitExtension_CHOLMOD()

NLboolean nlInitExtension_CHOLMOD

(

void

)

Initializes the CHOLMOD extension.

This dynamically loads the Cholmod library available in the system (if available) and retrieves the symbols in there.

Return values

NL_TRUE	if CHOLMOD could be successfully dynamically loaded and all functions could be found in it.
NL_FALSE	otherwise.

Note

For now, only implemented under Linux in dynamic libraries mode

nlMatrixFactorize_CHOLMOD()

NLAPI NLMatrix NLAPIENTRY nlMatrixFactorize_CHOLMOD	(	NLMatrix	M,
		NLenum	solver
	)

Factorizes a matrix using Cholmod.

The Cholmod extension needs to be initialized, by first calling nlInitExtension("CHOLMOD").

Parameters

[in]

M

the input sparse matrix. Should be a either an NLSparseMatrix or an NLCRSMatrix.

Returns

a factorization P of M. Subsequent calls to nlMultMatrixVector(P,x,y) solves M y = x (P may be thought-of as M^-1)

Parameters

[in]

solver

one of: NL_CHOLMOD_EXT