Structure

SparseOpaqueSubfactor_Double

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

Declaration

struct SparseOpaqueSubfactor_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

The attributes of the subfactor.

struct SparseAttributes_t

A structure that represents the attributes of a matrix.

var contents: SparseSubfactor_t

The subfactor this object represents, for example, L from LDLᵀ.

struct SparseSubfactor_t

Defines the subfactor of a factorization.

var factor: SparseOpaqueFactorization_Double

The underlying factorization that this object is a part of.

struct SparseOpaqueFactorization_Double

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

var workspaceRequiredPerRHS: Int

Required size of the per-right-hand-side workspace, in bytes, required to perform a solve or multiply operation.

var workspaceRequiredStatic: Int

Required size of the static workspace, in bytes, required to perform a solve or multiply operation.

See Also

Subfactors

struct SparseOpaqueSubfactor_Float

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

struct SparseSubfactor_t

Defines the subfactor of a factorization.

Subfactor Extraction

Extract subfactors of factors.

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