Structure

SparseOpaqueFactorization_Double

A structure representing the factorization of a matrix of double-precision, floating-point values.

Declaration

struct SparseOpaqueFactorization_Double

Overview

Use the SparseCleanup(_:) function to free resources held by these objects.

An object can be in one of the following states:

Something went wrong with symbolic factorization, nothing is valid

Indicated by symbolicFactorization.status < 0

Symbolic factorization was good, but failed in numeric factorization initialization

Indicated by symbolicFactorization.status >= 0 && status < 0 && numericFactorization == NULL

Symbolic factorization may be used for future calls

Symbolic factorization was good, factor allocated/initialized correctly, but numeric factorization failed

(For example, a Cholesky factorization of an indefinite matrix was attempted)

Indicated by symbolicFactorization.status >= 0 && status < 0 && numericFactorization not NULL

You may pass this object to SparseRefactor(_:_:) with a modified matrix

Symbolic and numeric factorizations are both good

Indicated by status >= 0

Topics

Instance Properties

var attributes: SparseAttributes_t

Attributes of factorization object.

var numericFactorization: UnsafeMutableRawPointer?

Pointer to private internal representation of numeric factor.

var solveWorkspaceRequiredPerRHS: Int

The required size of the per right hand side workspace for a call to a sparse solve function.

var solveWorkspaceRequiredStatic: Int

The required size of the static workspace for a call to a sparse solve function.

var status: SparseStatus_t

The status of the factorization object.

var symbolicFactorization: SparseOpaqueSymbolicFactorization

Symbolic factorization upon which this numeric factorization depends.

var userFactorStorage: Bool

Boolean indicating if user provided storage backs this object.

See Also

Supporting Types

struct SparseFactorization_t

A structure that defines the factorization type.

struct SparseSymbolicFactorOptions

A structure that contains options that affect the symbolic stage of a sparse factorization.

struct SparseNumericFactorOptions

A structure that contains options that affect the numerical stage of a sparse factorization.

struct SparseOpaqueFactorization_Float

A structure representing the factorization of a matrix of single-precision, floating-point values.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software