Iteration |
Defines an IIterationStopCriterionT that monitors the numbers of iteration
steps as stop criterion.
Inheritance HierarchyNamespace: Altaxo.Calc.LinearAlgebra.Solvers
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3261.0 (4.8.3261.0)
SyntaxC#
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| Name | Description | |
|---|---|---|
 | IterationCountStopCriterionT | Initializes a new instance of the IterationCountStopCriterionT class with the default maximum number of iterations. |
| IterationCountStopCriterionT(Int32) | Initializes a new instance of the IterationCountStopCriterionT class with the specified maximum number of iterations. |
Properties| Name | Description | |
|---|---|---|
 | MaximumNumberOfIterations | Gets or sets the maximum number of iterations the calculation is allowed to perform. |
| Status | Gets the current calculation status. |
Methods| Name | Description | |
|---|---|---|
| Clone | Clones the current IterationCountStopCriterionT and its settings. |
| DetermineStatus | Determines the status of the iterative calculation based on the stop criteria stored by the current IterationCountStopCriterionT. 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 IterationCountStopCriterionT to the pre-calculation state. |
| ResetMaximumNumberOfIterationsToDefault | Returns the maximum number of iterations to the default. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
  | DefaultMaximumNumberOfIterations | The default value for the maximum number of iterations the process is allowed to perform. |
See Also