SparseSolverTransformation<T>.Create Method

Creates a permutation-only snapshot of a sparse linear system.

Definition

Namespace: Numerics.NET.LinearAlgebra.IterativeSolvers
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0
C#
public static SparseSolverTransformation<T> Create(
	SparseMatrix<T> matrix,
	int[]? ordering = null
)

Parameters

matrix  SparseMatrix<T>
A square sparse matrix with finite logical coefficients.
ordering  Int32[]  (Optional)
An optional permutation mapping new coordinates to original coordinates. It is copied. Null selects natural ordering.

Return Value

SparseSolverTransformation<T>
A transformation with unit row and column factors.

Exceptions

ArgumentNullExceptionmatrix is null.
DimensionMismatchExceptionThe matrix is not square or the ordering length is incorrect.
ArgumentExceptionThe ordering is invalid or a logical coefficient is nonfinite.
NotSupportedExceptionThe sparse matrix structure is unsupported.

See Also