Structure

SparseOpaqueSymbolicFactorization

A semi-opaque type representing symbolic matrix factorization.

Declaration

struct SparseOpaqueSymbolicFactorization

Overview

Represents a symbolic matrix factorization (i.e. the pattern of the factors without the values). A single symbolic factorization may be the basis for multiple numerical factorizations of matrices with the same pattern but different nonzero values.

Use the SparseCleanup(_:) function to free resources held by these objects. The internal factorization pointer is reference counted, so it is safe to destroy this object even if numeric factorizations exist that still depend on it.

Topics

Instance Properties

var status: SparseStatus_t

The status of the factorization.

struct SparseStatus_t

Constants that describe the status of a factorization.

var type: SparseFactorization_t

The factorization type.

var factorization: UnsafeMutableRawPointer?

Pointer to private internal representation of symbolic factor.

struct SparseFactorization_t

A structure that defines the factorization type.

Inspecting a Factorization's Structure

var attributes: SparseAttributes_t

The attributes of the factorization.

struct SparseAttributes_t

A structure that represents the attributes of a matrix.

var blockSize: UInt8

The block size.

var columnCount: Int32

The number of columns.

var rowCount: Int32

The number of rows.

var workspaceSize_Double: Int

Size, in bytes, of workspace required to perform numerical factorization in Double.

var workspaceSize_Float: Int

Size, in bytes, of workspace required to perform numerical factorization in Float.

var factorSize_Double: Int

Minimum size, in bytes, required to store numerical factors in Double.

var factorSize_Float: Int

Minimum size, in bytes, required to store numerical factors in Float.

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.

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