maspack.solvers

Class UmfpackSolver

java.lang.Object

maspack.solvers.UmfpackSolver

All Implemented Interfaces:

DirectSolver

public class UmfpackSolver
extends java.lang.Object
implements DirectSolver

Nested Class Summary

Nested classes/interfaces inherited from interface maspack.solvers.DirectSolver

DirectSolver.IterativeMethod

Field Summary

Fields

Modifier and Type	Field and Description
static int	UMFPACK_ERROR_argument_missing
static int	UMFPACK_ERROR_different_pattern
static int	UMFPACK_ERROR_file_IO
static int	UMFPACK_ERROR_internal_error
static int	UMFPACK_ERROR_invalid_matrix
static int	UMFPACK_ERROR_invalid_Numeric_object
static int	UMFPACK_ERROR_invalid_permutation
static int	UMFPACK_ERROR_invalid_Symbolic_object
static int	UMFPACK_ERROR_invalid_system
static int	UMFPACK_ERROR_n_nonpositive
static int	UMFPACK_ERROR_out_of_memory
static int	UMFPACK_OK
static int	UMFPACK_WARNING_determinant_overflow
static int	UMFPACK_WARNING_determinant_underflow
static int	UMFPACK_WARNING_singular_matrix

Fields inherited from interface maspack.solvers.DirectSolver

ANALYZED, DEFAULT_ITERATIVE_MAX_SOLVES, DEFAULT_ITERATIVE_TOLERANCE, FACTORED, UNSET

Constructor Summary

Constructors

Constructor and Description
UmfpackSolver()

Method Summary

Modifier and Type	Method and Description
void	analyze(double[] vals, int[] colIdxs, int[] rowOffs, int size, int type) Performs prefactor analysis on a matrix whose structure and values are supplied in compressed row storage (CRS) format, using 1-based indices, as described in the documentation for Matrix.setCRSValues.
int	analyze(int[] colOffs, int[] rowIdxs, int size, int numVals)
void	analyze(Matrix M, int size, int type) Performs prefactor analysis on a specified matrix.
void	analyzeAndFactor(Matrix M) Factors a matrix.
void	dispose() Releases all internal resources allocated by this solver.
void	factor() Factors a previously analyzed matrix.
void	factor(double[] vals) Factors a previously analyzed matrix, using the numeric values supplied by vals.
void	finalize()
java.lang.String	getErrorMessage() Returns a message describing the reason for the failure of the most recent call to analyze() or factor(), or null if the method succeeded.
static java.lang.String	getInitErrorMessage()
long	getNumNonZerosInFactors() If possible, returns the number of non-zero elements in the factorization.
int	getState() Returns the current state of this solver, which is one of UNSET, ANALYZED, or FACTORED.
boolean	hasIterativeSolves() Returns true if this solver supports iterative solving, using a recent directly-factored matrix as a preconditioner.
static boolean	isAvailable()
static void	main(java.lang.String[] args)
void	solve(double[] x, double[] b) Solves the system
void	solve(VectorNd x, VectorNd b) Solves the system

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface maspack.solvers.DirectSolver

getIterativeMaxSolves, getIterativeMethod, getIterativeTolerance, getLastIterativeResidual, getLastIterativeSolves, getMaxRefinementSteps, getNumNegEigenvalues, getNumPerturbedPivots, getNumPosEigenvalues, hasMultipleRhsSolves, iterativeSolve, iterativeSolve, residual, setIterativeMaxSolves, setIterativeMethod, setIterativeTolerance, setMaxRefinementSteps, solve

Field Detail

UMFPACK_OK

public static int UMFPACK_OK

UMFPACK_WARNING_singular_matrix

public static int UMFPACK_WARNING_singular_matrix

UMFPACK_WARNING_determinant_underflow

public static int UMFPACK_WARNING_determinant_underflow

UMFPACK_WARNING_determinant_overflow

public static int UMFPACK_WARNING_determinant_overflow

UMFPACK_ERROR_out_of_memory

public static int UMFPACK_ERROR_out_of_memory

UMFPACK_ERROR_invalid_Numeric_object

public static int UMFPACK_ERROR_invalid_Numeric_object

UMFPACK_ERROR_invalid_Symbolic_object

public static int UMFPACK_ERROR_invalid_Symbolic_object

UMFPACK_ERROR_argument_missing

public static int UMFPACK_ERROR_argument_missing

UMFPACK_ERROR_n_nonpositive

public static int UMFPACK_ERROR_n_nonpositive

UMFPACK_ERROR_invalid_matrix

public static int UMFPACK_ERROR_invalid_matrix

UMFPACK_ERROR_different_pattern

public static int UMFPACK_ERROR_different_pattern

UMFPACK_ERROR_invalid_system

public static int UMFPACK_ERROR_invalid_system

UMFPACK_ERROR_invalid_permutation

public static int UMFPACK_ERROR_invalid_permutation

UMFPACK_ERROR_internal_error

public static int UMFPACK_ERROR_internal_error

UMFPACK_ERROR_file_IO

public static int UMFPACK_ERROR_file_IO

Constructor Detail

UmfpackSolver

public UmfpackSolver()

Method Detail

isAvailable

public static boolean isAvailable()

getInitErrorMessage

public static java.lang.String getInitErrorMessage()

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

analyze

public void analyze(Matrix M,
                    int size,
                    int type)

Description copied from interface: DirectSolver

Performs prefactor analysis on a specified matrix. The matrix reference is stored and used by later calls to factor(). If size is less than the actual matrix size, then the analysis is done on the principal submatrix of M defined by the first size rows and columns.

Specified by:

analyze in interface DirectSolver

Parameters:

M - matrix to analyze

size - size of the matrix to factor.

type - or-ed flags giving information about the matrix type. Typical flags are SYMMETRIC or POSITIVE_DEFINITE

analyze

public void analyze(double[] vals,
                    int[] colIdxs,
                    int[] rowOffs,
                    int size,
                    int type)

Performs prefactor analysis on a matrix whose structure and values are supplied in compressed row storage (CRS) format, using 1-based indices, as described in the documentation for Matrix.setCRSValues. The number of non-zero values is given by rowOffs[size]-1. If the matrix type is symmetric, only the upper triangular portion should be supplied.

Because no matrix object is supplied, factor() cannot be used after calling this method; use factor(vals) instead. The values supplied here may be used to assist the analysis but are not used for any numeric factorization.

This method is not supported by Umfpack, which requires its matrix structure to be supplied in compressed column storage (CCS) format using analyze(colOffs,rowIdxs,size,numVals).

Specified by:

analyze in interface DirectSolver

Parameters:

vals - values of the non-zero matrix elements

colIdxs - 1-based column indices of the non-zero matrix elements

rowOffs - 1-based row start offsets into vals and colIdxs

size - size of the matrix to be analyzed

type - or-ed flags giving information about the matrix type, as described for analyze(M,size,type)

analyze

public int analyze(int[] colOffs,
                   int[] rowIdxs,
                   int size,
                   int numVals)

factor

public void factor(double[] vals)

Factors a previously analyzed matrix, using the numeric values supplied by vals. These must be ordered in the same way as those supplied to the most recent call to analyze().

The values must be ordered to match the compressed column storage (CCS) structure supplied to analyze(colOffs,rowIdxs,size,numVals).

Specified by:

factor in interface DirectSolver

Parameters:

vals - non-zero matrix element values

factor

public void factor()

Description copied from interface: DirectSolver

Factors a previously analyzed matrix.

Specified by:

factor in interface DirectSolver

analyzeAndFactor

public void analyzeAndFactor(Matrix M)

Description copied from interface: DirectSolver

Factors a matrix. This is equivalent to the two calls

   analyze (M, M.rowSize(), 0)
   factor()
 

Specified by:

analyzeAndFactor in interface DirectSolver

Parameters:

M - matrix to factor

solve

public void solve(VectorNd x,
                  VectorNd b)

Description copied from interface: DirectSolver

Solves the system

  M x = b
 

where M was specified using previous calls to analyze or factor.

Specified by:

solve in interface DirectSolver

Parameters:

x - vector in which result is returned

b - right hand vector of matrix equation

hasIterativeSolves

public boolean hasIterativeSolves()

Returns true if this solver supports iterative solving, using a recent directly-factored matrix as a preconditioner. If it does, all the methods described by DirectSolver.IterativeMethod are available, as are the settings DirectSolver.setIterativeMethod(maspack.solvers.DirectSolver.IterativeMethod), DirectSolver.setIterativeMaxSolves(int) and DirectSolver.setIterativeTolerance(double).

Umfpack does not support iterative solving.

Specified by:

hasIterativeSolves in interface DirectSolver

Returns:

true if iterative solving is available

getState

public int getState()

Returns the current state of this solver, which is one of UNSET, ANALYZED, or FACTORED.

Specified by:

getState in interface DirectSolver

Returns:

state of this solver

getErrorMessage

public java.lang.String getErrorMessage()

Returns a message describing the reason for the failure of the most recent call to analyze() or factor(), or null if the method succeeded.

Specified by:

getErrorMessage in interface DirectSolver

Returns:

most recent error message, if any

getNumNonZerosInFactors

public long getNumNonZerosInFactors()

If possible, returns the number of non-zero elements in the factorization. If the factorization has not yet been performed, this may be the number estimated by the most recent call to analyze(). If the solver does not report this quantity, -1 is returned.

Umfpack does not report this quantity, so -1 is returned.

Specified by:

getNumNonZerosInFactors in interface DirectSolver

Returns:

number of non-zero elements in the factorization, or -1 if not supported

solve

public void solve(double[] x,
                  double[] b)

Description copied from interface: DirectSolver

Solves the system

  M x = b
 

where the solution and right hand side are supplied using double[] objects.

Specified by:

solve in interface DirectSolver

Parameters:

x - vector in which result is returned

b - right hand vector of matrix equation

main

public static void main(java.lang.String[] args)

dispose

public void dispose()

Description copied from interface: DirectSolver

Releases all internal resources allocated by this solver.

Specified by:

dispose in interface DirectSolver