Click or drag to resize

IterationCountStopCriterionT Class

Defines an IIterationStopCriterionT that monitors the numbers of iteration steps as stop criterion.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.LinearAlgebra.SolversIterationCountStopCriterionT

Namespace: Altaxo.Calc.LinearAlgebra.Solvers
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public sealed class IterationCountStopCriterion<T> : IIterationStopCriterion<T>
where T : struct, new(), IEquatable<T>, IFormattable

Type Parameters

T

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

The IterationCountStopCriterionT type exposes the following members.

Constructors
 NameDescription
Public methodIterationCountStopCriterionT Initializes a new instance of the IterationCountStopCriterionT class with the default maximum number of iterations.
Public methodIterationCountStopCriterionT(Int32) Initializes a new instance of the IterationCountStopCriterionT class with the specified maximum number of iterations.
Top
Properties
 NameDescription
Public propertyMaximumNumberOfIterations Gets or sets the maximum number of iterations the calculation is allowed to perform.
Public propertyStatus Gets the current calculation status.
Top
Methods
 NameDescription
Public methodClone Clones the current IterationCountStopCriterionT and its settings.
Public methodDetermineStatus Determines the status of the iterative calculation based on the stop criteria stored by the current IterationCountStopCriterionT. 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 IterationCountStopCriterionT to the pre-calculation state.
Public methodResetMaximumNumberOfIterationsToDefault Returns the maximum number of iterations to the default.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberDefaultMaximumNumberOfIterations The default value for the maximum number of iterations the process is allowed to perform.
Top
See Also