maspack.matlab

Class MatlabSolver

java.lang.Object

maspack.matlab.MatlabSolver

All Implemented Interfaces:

DirectSolver

public class MatlabSolver
extends java.lang.Object
implements DirectSolver

Nested Class Summary

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

DirectSolver.IterativeMethod

Field Summary

Fields inherited from interface maspack.solvers.DirectSolver

ANALYZED, DEFAULT_ITERATIVE_MAX_SOLVES, DEFAULT_ITERATIVE_TOLERANCE, FACTORED, UNSET

Constructor Summary

Constructors

Constructor and Description
MatlabSolver()

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.
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.
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.
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.
void	incAll(int[] ar)
void	incIndices(double[] ar)
void	int2double(int[] ar, double[] dar)
void	printArray(double[] ar)
void	printArray(int[] ar)
void	printArray(java.lang.String name, double[] ar)
void	printArray(java.lang.String name, int[] ar)
void	printData(double[] rows, double[] cols, double[] vals)
void	printIdxs(double[] rows, double[] cols)
void	queryFullMatrix()
void	querySparseMatrix()
void	solve(double[] x, double[] b) Solves the system
void	solve(VectorNd x, VectorNd b) Solves the system
void	test()
void	write(java.lang.String filename)
void	writeArray(IndentingPrintWriter pw, java.lang.String name, double[] ar)
void	writeArray(IndentingPrintWriter pw, java.lang.String name, int[] ar)

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

Constructor Detail

MatlabSolver

public MatlabSolver()

Method Detail

test

public void test()

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

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

querySparseMatrix

public void querySparseMatrix()

queryFullMatrix

public void queryFullMatrix()

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

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

write

public void write(java.lang.String filename)

writeArray

public void writeArray(IndentingPrintWriter pw,
                       java.lang.String name,
                       double[] ar)

writeArray

public void writeArray(IndentingPrintWriter pw,
                       java.lang.String name,
                       int[] ar)

printData

public void printData(double[] rows,
                      double[] cols,
                      double[] vals)

printIdxs

public void printIdxs(double[] rows,
                      double[] cols)

printArray

public void printArray(java.lang.String name,
                       int[] ar)

printArray

public void printArray(int[] ar)

printArray

public void printArray(java.lang.String name,
                       double[] ar)

printArray

public void printArray(double[] ar)

int2double

public void int2double(int[] ar,
                       double[] dar)

incAll

public void incAll(int[] ar)

incIndices

public void incIndices(double[] ar)

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).

Specified by:

hasIterativeSolves in interface DirectSolver

Returns:

true if iterative solving is available

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.

Not supported by this solver; matrices must be supplied as Matrix objects.

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)

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().

Not supported by this solver; use factor() instead.

Specified by:

factor in interface DirectSolver

Parameters:

vals - non-zero matrix element values

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.

This solver does not record error messages, so null is always returned.

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.

This solver 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

dispose

public void dispose()

Description copied from interface: DirectSolver

Releases all internal resources allocated by this solver.

Specified by:

dispose in interface DirectSolver