JacobiPreconditioner<T> Constructor

Definition

Namespace: Numerics.NET.LinearAlgebra.IterativeSolvers.Preconditioners
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

JacobiPreconditioner<T>(Matrix<T>)	Constructs a Jacobi preconditioner with an optional diagonal magnitude floor.
JacobiPreconditioner<T>(Matrix<T>, T)	Constructs a Jacobi preconditioner with an optional diagonal magnitude floor.

Constructs a Jacobi preconditioner with an optional diagonal magnitude floor.

public JacobiPreconditioner(
	Matrix<T> matrix
)

Visual Basic

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

C++/CLI

public:
JacobiPreconditioner(
	Matrix<T>^ matrix
)

new : 
        matrix : Matrix<'T> -> JacobiPreconditioner

ArgumentNullException	matrix is null.
DimensionMismatchException	matrix is not square.
ArgumentOutOfRangeException	The floor is not a finite nonnegative real value.
ArgumentException	A diagonal entry or its reciprocal is nonfinite.

Constructs a Jacobi preconditioner with an optional diagonal magnitude floor.

public JacobiPreconditioner(
	Matrix<T> matrix,
	T minimumDiagonalMagnitude
)

Visual Basic

Public Sub New ( 
	matrix As Matrix(Of T),
	minimumDiagonalMagnitude As T
)

C++/CLI

public:
JacobiPreconditioner(
	Matrix<T>^ matrix, 
	T minimumDiagonalMagnitude
)

new : 
        matrix : Matrix<'T> * 
        minimumDiagonalMagnitude : 'T -> JacobiPreconditioner

matrix Matrix<T>: A non-null square matrix.
minimumDiagonalMagnitude T: A finite nonnegative real value. Zero retains the identity fallback for exact-zero diagonal entries. A positive value floors diagonal magnitudes, preserving the phase of nonzero entries and assigning the positive floor to exact zeros.

ArgumentNullException	matrix is null.
DimensionMismatchException	matrix is not square.
ArgumentOutOfRangeException	The floor is not a finite nonnegative real value.
ArgumentException	A diagonal entry or its reciprocal is nonfinite.