DivergenceStopCriterionT Class

Monitors an iterative calculation for signs of divergence.

Inheritance Hierarchy

SystemObject
Altaxo.Calc.LinearAlgebra.SolversDivergenceStopCriterionT

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

Syntax

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

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

The DivergenceStopCriterionT type exposes the following members.

Constructors

	Name	Description
	DivergenceStopCriterionT	Initializes a new instance of the DivergenceStopCriterionT class with the specified maximum relative increase and the specified minimum number of tracking iterations.

Properties

	Name	Description
	MaximumRelativeIncrease	Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.
	MinimumNumberOfIterations	Gets or sets the minimum number of iterations over which the residual must grow before issuing a divergence warning.
	Status	Gets the current calculation status.

Methods

	Name	Description
	Clone	Clones the current DivergenceStopCriterionT 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)