maspack.solvers

Enum SparseSolverId

java.lang.Object

java.lang.Enum<SparseSolverId>

maspack.solvers.SparseSolverId

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SparseSolverId>

public enum SparseSolverId
extends java.lang.Enum<SparseSolverId>

Identifies the general-purpose sparse solvers available in this package.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Accelerate Sparse LDL^T and LU solver from Apple's Accelerate framework (Arm-based MacOS only).
ConjugateGradient Conjugate gradient
Mumps MUMPS (MUltifrontal Massively Parallel sparse direct Solver), developed by CERFACS, CNRS, ENS Lyon, INP Toulouse, Inria, Mumps Technologies and the University of Bordeaux.
Pardiso Intel MKL implementation of Pardiso, originally developed by Olaf Schenk p
Umfpack Umfpack, from SuiteSparse, developed by Tim Davis et al.

Method Summary

Modifier and Type	Method and Description
DirectSolver	createDirectSolver() Creates and returns the solver for this type, if it represents a direct solver.
IterativeSolver	createIterativeSolver() Creates and returns the solver for this type, if it represents an iterative solver.
static SparseSolverId	findAvailableDirectSolver(java.lang.String name) Finds a direct solver id by name (ignoring case) for the current platform.
static SparseSolverId[]	getAvailableDirectSolvers() Returns all the available direct solvers that should be available for the current platform.
static SparseSolverId	getDefaultDirectSolver() Returns the default direct solver for the current platform.
int	getMatrixType()
boolean	isCompatible(int matrixType) Queries if this solver type is compatible with the indicated matrix type.
boolean	isDirect() Queries whether the solver is direct.
static boolean	isDirectSolverAvailable(SparseSolverId solverId) Queries whether a specified direct solver should be available for the current platform.
static SparseSolverId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SparseSolverId[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Pardiso

public static final SparseSolverId Pardiso

Intel MKL implementation of Pardiso, originally developed by Olaf Schenk p

Mumps

public static final SparseSolverId Mumps

MUMPS (MUltifrontal Massively Parallel sparse direct Solver), developed by CERFACS, CNRS, ENS Lyon, INP Toulouse, Inria, Mumps Technologies and the University of Bordeaux.

Umfpack

public static final SparseSolverId Umfpack

Umfpack, from SuiteSparse, developed by Tim Davis et al.

Accelerate

public static final SparseSolverId Accelerate

Sparse LDL^T and LU solver from Apple's Accelerate framework (Arm-based MacOS only). Unsymmetric matrices require macOS 15.5 or later; on earlier systems, only symmetric matrices are supported.

ConjugateGradient

public static final SparseSolverId ConjugateGradient

Conjugate gradient

Method Detail

values

public static SparseSolverId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SparseSolverId c : SparseSolverId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SparseSolverId valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isDirect

public boolean isDirect()

Queries whether the solver is direct.

Returns:

true if the solver is direct

getMatrixType

public int getMatrixType()

isCompatible

public boolean isCompatible(int matrixType)

Queries if this solver type is compatible with the indicated matrix type.

Parameters:

matrixType - matrix type to check

Returns:

true if the matrix type is compatible

getDefaultDirectSolver

public static SparseSolverId getDefaultDirectSolver()

Returns the default direct solver for the current platform. This is the first solver in the list returned by getAvailableDirectSolvers().

Returns:

default direct solver

createDirectSolver

public DirectSolver createDirectSolver()

Creates and returns the solver for this type, if it represents a direct solver. Otherwise, returns null. If Pardiso is requested but is not available on this platform, and MUMPS is, then a MUMPS solver is returned instead, with a warning printed the first time this happens.

Returns:

new direct solver for this type, or null

createIterativeSolver

public IterativeSolver createIterativeSolver()

Creates and returns the solver for this type, if it represents an iterative solver. Otherwise, returns null.

Returns:

new iterative solver for this type, or null

getAvailableDirectSolvers

public static SparseSolverId[] getAvailableDirectSolvers()

Returns all the available direct solvers that should be available for the current platform. (Note that it is still possible a given solver might not actually be available because of trouble accessingor loading the native libraries.)

findAvailableDirectSolver

public static SparseSolverId findAvailableDirectSolver(java.lang.String name)

Finds a direct solver id by name (ignoring case) for the current platform. Returns null if the solver is not available.

isDirectSolverAvailable

public static boolean isDirectSolverAvailable(SparseSolverId solverId)

Queries whether a specified direct solver should be available for the current platform.