ThresholdIncompleteLUPreconditioner<T> Constructor

public ThresholdIncompleteLUPreconditioner(
	SparseMatrix<T> matrix,
	T dropTolerance,
	int maximumFillPerRow
)

Public Sub New ( 
	matrix As SparseMatrix(Of T),
	dropTolerance As T,
	maximumFillPerRow As Integer
)

public:
ThresholdIncompleteLUPreconditioner(
	SparseMatrix<T>^ matrix, 
	T dropTolerance, 
	int maximumFillPerRow
)

new : 
        matrix : SparseMatrix<'T> * 
        dropTolerance : 'T * 
        maximumFillPerRow : int -> ThresholdIncompleteLUPreconditioner

Parameters

matrix  SparseMatrix<T>

A non-null square sparse matrix with finite logical coefficients.

dropTolerance  T

A finite nonnegative real dropping tolerance. Zero disables magnitude dropping of nonzero entries.

maximumFillPerRow  Int32

The nonnegative maximum number of retained entries in each strict L and strict U row. The diagonal is additional. Values beyond matrix order minus one are effectively clamped.

public ThresholdIncompleteLUPreconditioner(
	SparseMatrix<T> matrix,
	T dropTolerance,
	int maximumFillPerRow,
	T relativePivotTolerance,
	T relativeDiagonalShift,
	bool equilibrateRows = false,
	Permutation? ordering = null
)

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

public:
ThresholdIncompleteLUPreconditioner(
	SparseMatrix<T>^ matrix, 
	T dropTolerance, 
	int maximumFillPerRow, 
	T relativePivotTolerance, 
	T relativeDiagonalShift, 
	bool equilibrateRows = false, 
	Permutation^ ordering = nullptr
)

new : 
        matrix : SparseMatrix<'T> * 
        dropTolerance : 'T * 
        maximumFillPerRow : int * 
        relativePivotTolerance : 'T * 
        relativeDiagonalShift : 'T * 
        ?equilibrateRows : bool * 
        ?ordering : Permutation 
(* Defaults:
        let _equilibrateRows = defaultArg equilibrateRows false
        let _ordering = defaultArg ordering null
*)
-> ThresholdIncompleteLUPreconditioner

Parameters

matrix  SparseMatrix<T>

A non-null square sparse matrix with finite logical coefficients.

dropTolerance  T

A finite nonnegative real dropping tolerance. Zero disables magnitude dropping of nonzero entries.

maximumFillPerRow  Int32

The nonnegative maximum number of retained entries in each strict L and strict U row. The diagonal is additional. Values beyond matrix order minus one are effectively clamped.

relativePivotTolerance  T

A finite real value in [0,1). Pivot magnitudes relative to the shifted row maximum must exceed this value.

relativeDiagonalShift  T

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

equilibrateRows  Boolean  (Optional)

Whether to divide each shifted row by its maximum magnitude before factorization.

ordering  Permutation  (Optional)

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

Reference