Click or drag to resize

IteratorT Class

An iterator that is used to check if an iterative calculation should continue or stop.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.LinearAlgebra.SolversIteratorT

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

Type Parameters

T

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

The IteratorT type exposes the following members.

Constructors
 NameDescription
Public methodIteratorT Initializes a new instance of the IteratorT class with the default stop criteria.
Public methodIteratorT(IEnumerableIIterationStopCriterionT) Initializes a new instance of the IteratorT class with the specified stop criteria.
Public methodIteratorT(IIterationStopCriterionT) Initializes a new instance of the IteratorT class with the specified stop criteria.
Top
Properties
 NameDescription
Public propertyStatus Gets the current calculation status.
Top
Methods
 NameDescription
Public methodCancel Indicates to the iterator that the iterative process has been cancelled.
Public methodClone Creates a deep clone of the current iterator.
Public methodDetermineStatus Determines the status of the iterative calculation based on the stop criteria stored by the current IteratorT. 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 IteratorT to the pre-calculation state.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also