ConjugateGradient.SetJacobi Method

ConjugateGradientSetJacobi Method

Defines a Jacobi preconditioner as the preconditioning matrix, that is, M is the diagonal of A.

Namespace: Imsl.Math
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0

Syntax

public void SetJacobi(
	double[] diagonal
)

Public Sub SetJacobi ( 
	diagonal As Double()
)

public:
void SetJacobi(
	array<double>^ diagonal
)

member SetJacobi : 
        diagonal : float[] -> unit

diagonal: Type: SystemDouble
A double vector containing the diagonal of the Jacobi preconditioner M, that is, diagonal[i]= $A_{i,i}$ , A the input matrix.

Exceptions

Exception	Condition
ArgumentException	is thrown if the length of vector diagonal is not equal to the order n of input matrix A.