Types in MathNet.Numerics.LinearAlgebra.Solvers

Type IIterationStopCriterion<T>

Namespace MathNet.Numerics.LinearAlgebra.Solvers

The base interface for classes that provide stop criteria for iterative calculations.



Public Methods

IIterationStopCriterion<T> Clone()

IterationStatus DetermineStatus(int iterationNumber, Vector<T> solutionVector, Vector<T> sourceVector, Vector<T> residualVector)

Determines the status of the iterative calculation based on the stop criteria stored by the current IIterationStopCriterion. Status is set to Status field of current object.
The individual stop criteria may internally track the progress of the calculation based on the invocation of this method. Therefore this method should only be called if the calculation has moved forwards at least one step.
int iterationNumber

The number of iterations that have passed so far.

Vector<T> solutionVector

The vector containing the current solution values.

Vector<T> sourceVector

The right hand side vector.

Vector<T> residualVector

The vector containing the current residual vectors.

void Reset()

Resets the IIterationStopCriterion to the pre-calculation state.
To implementers: Invoking this method should not clear the user defined property values, only the state that is used to track the progress of the calculation.

Public Properties

IterationStatus Status get;

Gets the current calculation status.
is not a legal value. Status should be set in DetermineStatus implementation.