Click or drag to resize

CancellationStopCriterionT Class

Defines an IIterationStopCriterionT that uses a cancellation token as stop criterion.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.LinearAlgebra.SolversCancellationStopCriterionT

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

Type Parameters

T

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

The CancellationStopCriterionT type exposes the following members.

Constructors
 NameDescription
Public methodCancellationStopCriterionT Initializes a new instance of the IterationCountStopCriterionT class.
Public methodCancellationStopCriterionT(CancellationToken) Initializes a new instance of the IterationCountStopCriterionT class.
Top
Properties
 NameDescription
Public propertyStatus Gets the current calculation status.
Top
Methods
 NameDescription
Public methodCancel 
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 methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also