ResidualStopCriterionT Class

Defines an IIterationStopCriterionT that monitors residuals as stop criterion.

Inheritance Hierarchy

SystemObject
Altaxo.Calc.LinearAlgebra.SolversResidualStopCriterionT

Namespace: Altaxo.Calc.LinearAlgebra.Solvers
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

public sealed class ResidualStopCriterion<T> : IIterationStopCriterion<T>
where T : struct, new(), IEquatable<T>, IFormattable

T: [Missing <typeparam name="T"/> documentation for "T:Altaxo.Calc.LinearAlgebra.Solvers.ResidualStopCriterion`1"]

The ResidualStopCriterionT type exposes the following members.

Constructors

	Name	Description
	ResidualStopCriterionT	Initializes a new instance of the ResidualStopCriterionT class with the specified maximum residual and minimum number of iterations.

Properties

	Name	Description
	Maximum	Gets or sets the maximum value for the residual below which the calculation is considered converged.
	MinimumIterationsBelowMaximum	Gets or sets the minimum number of iterations for which the residual has to be below the maximum before the calculation is considered converged.
	Status	Gets the current calculation status.

Methods

	Name	Description
	Clone	Clones the current ResidualStopCriterionT and its settings.
	DetermineStatus	Determines the status of the iterative calculation based on the stop criteria stored by the current IIterationStopCriterionT. Result is set into Status field.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Reset	Resets the IIterationStopCriterionT to the pre-calculation state.
	ToString	Returns a string that represents the current object. (Inherited from Object)