Click or drag to resize

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.3179.0 (4.8.3179.0)
Syntax
C#
public sealed class DivergenceStopCriterion<T> : IIterationStopCriterion<T>
where T : struct, new(), IEquatable<T>, IFormattable

Type Parameters

T

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

The DivergenceStopCriterionT type exposes the following members.

Constructors
 NameDescription
Public methodDivergenceStopCriterionT Initializes a new instance of the DivergenceStopCriterionT class with the specified maximum relative increase and the specified minimum number of tracking iterations.
Top
Properties
 NameDescription
Public propertyMaximumRelativeIncrease Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.
Public propertyMinimumNumberOfIterations Gets or sets the minimum number of iterations over which the residual must grow before issuing a divergence warning.
Public propertyStatus Gets the current calculation status.
Top
Methods
 NameDescription
Public methodClone Clones the current DivergenceStopCriterionT and its settings.
Public methodDetermineStatus Determines the status of the iterative calculation based on the stop criteria stored by the current IIterationStopCriterionT. Result is set into Status field.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodReset Resets the IIterationStopCriterionT to the pre-calculation state.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also