Structure

SparseSymbolicFactorOptions

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

Declaration

struct SparseSymbolicFactorOptions

Overview

SparseSymbolicFactorOptions supports the following ordering algorithms:

SparseOrderDefault

Default ordering (SparseOrderAMD for symmetric and SparseOrderCOLAMD for unsymmetric factorizations, but this may change in the future).

SparseOrderUser

User-supplied ordering, or identity if order is null.

SparseOrderAMD

Approximate Minimum Degree (AMD) ordering. Large overhead cost if used for QR-based factorization due to explicit formation of AᵀA.

SparseOrderMetis

METIS Nested Dissection ordering. Large overhead cost if used for QR-based factorization due to explicit formation of AᵀA.

SparseOrderCOLAMD

Column AMD ordering for AᵀA. Not valid for symmetric factorizations (use SparseOrderAMD instead).

Topics

Inspecting Symbolic Factor Options

var control: SparseControl_t

Flags controlling the computation.

struct SparseControl_t

Options that control the computation.

var reportError: ((UnsafePointer<Int8>) -> Void)?

Function to use to report parameter errors.

var orderMethod: SparseOrder_t

Ordering algorithm to use.

struct SparseOrder_t

Options that define which ordering algorithm to use.

var order: UnsafeMutablePointer<Int32>?

User-supplied array for ordering.

var malloc: (Int) -> UnsafeMutableRawPointer?

Function to use to allocate any storage needed.

var free: (UnsafeMutableRawPointer?) -> Void

Function to use to free allocated storage.

var ignoreRowsAndColumns: UnsafeMutablePointer<Int32>?

An array containing row and column indices to ignore.

See Also

Supporting Types

struct SparseFactorization_t

A structure that defines the factorization type.

struct SparseNumericFactorOptions

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

struct SparseOpaqueFactorization_Double

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

struct SparseOpaqueFactorization_Float

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