ModifiedIncompleteCholeskyPreconditioner<T> Constructor

public ModifiedIncompleteCholeskyPreconditioner(
	SparseMatrix<T> matrix
)

Public Sub New ( 
	matrix As SparseMatrix(Of T)
)

public:
ModifiedIncompleteCholeskyPreconditioner(
	SparseMatrix<T>^ matrix
)

new : 
        matrix : SparseMatrix<'T> -> ModifiedIncompleteCholeskyPreconditioner

Parameters

matrix  SparseMatrix<T>

A square sparse matrix with finite real symmetric logical coefficients. General, symmetric, Hermitian and diagonal structures are supported.

public ModifiedIncompleteCholeskyPreconditioner(
	SparseMatrix<T> matrix,
	T relativePivotTolerance,
	T relativeDiagonalShift,
	bool equilibrate = false,
	Permutation? ordering = null
)

Public Sub New ( 
	matrix As SparseMatrix(Of T),
	relativePivotTolerance As T,
	relativeDiagonalShift As T,
	Optional equilibrate As Boolean = false,
	Optional ordering As Permutation = Nothing
)

public:
ModifiedIncompleteCholeskyPreconditioner(
	SparseMatrix<T>^ matrix, 
	T relativePivotTolerance, 
	T relativeDiagonalShift, 
	bool equilibrate = false, 
	Permutation^ ordering = nullptr
)

new : 
        matrix : SparseMatrix<'T> * 
        relativePivotTolerance : 'T * 
        relativeDiagonalShift : 'T * 
        ?equilibrate : bool * 
        ?ordering : Permutation 
(* Defaults:
        let _equilibrate = defaultArg equilibrate false
        let _ordering = defaultArg ordering null
*)
-> ModifiedIncompleteCholeskyPreconditioner

Parameters

matrix  SparseMatrix<T>

A square sparse matrix with finite real symmetric logical coefficients. General, symmetric, Hermitian and diagonal structures are supported.

relativePivotTolerance  T

A finite real value in [0,1). Each pivot before taking its square root, divided by its original shifted row maximum magnitude, must exceed this value.

relativeDiagonalShift  T

A finite nonnegative real value. Adds this value times the original row maximum magnitude to that diagonal, using unit scale for an empty row. Only the preconditioner target is shifted.

equilibrate  Boolean  (Optional)

Whether to divide each coefficient by the square roots of its shifted row and column maxima. Applications undo this symmetric scaling on both sides. Constant-vector preservation applies in scaled coordinates.

ordering  Permutation  (Optional)

An optional copied permutation mapping factor coordinates to original coordinates. Null uses natural ordering.

Reference