ConvergenceTest<T> Class

Represents a convergence test for a IterativeAlgorithm.


Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
public abstract class ConvergenceTest<T>
Object  →  ConvergenceTest<T>

Type Parameters



Use the ConvergenceTest<T> class as the base class for a class that implements a convergence test for an algorithm or group of algorithms.

ConvergenceTest<T> is an abstract class and cannot be instantiated directly. Instead, derive your own class from ConvergenceTest<T>, or use one of the following derived classes:

SimpleConvergenceTestA convergence test that tests the value of a quantity.
VectorConvergenceTestA convergence test that tests the size of a vector.
ConvergenceTestCollectionA convergence test that combines one or more convergence tests.

Note to inheritors: You must override the TestConvergence(Boolean) method.


ConvergenceTest<T>Initializes a new instance of the ConvergenceTest<T> class


AbsoluteTolerance Gets or sets the absolute tolerance used in the convergence test.
ConvergenceCriterion Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.
Enabled Gets or sets whether a ConvergenceTest<T> is enabled.
Error Gets the estimated error associated with the convergence test.
RelativeTolerance Gets or sets the relative tolerance used in the convergence test.
RequiredSuccessivePasses Gets or sets a value that indicates the number of times the test criteria must be fulfilled before the test is considered successful.
RunBeforeIteration Gets or sets whether the convergence test should be run before the first actual iteration.
Tolerance Gets or sets the tolerance used in the convergence test.


EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
TestConvergence Performs the convergence test.
TestConvergenceCore Performs the convergence test.
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also