ConvergenceTest Class

Members See Also

Represents a convergence test for a IterativeAlgorithm.

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public abstract class ConvergenceTest

Visual Basic (Declaration)
Public MustInherit Class ConvergenceTest

Visual C++
public ref class ConvergenceTest abstract

F#
[<AbstractClassAttribute>] type ConvergenceTest = class end

Remarks

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

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

Class	Description
SimpleConvergenceTest	A convergence test that tests the value of a quantity.
VectorConvergenceTest	A convergence test that tests the size of a vector.
ConvergenceTestCollection	A convergence test that combines one or more convergence tests.

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

Inheritance Hierarchy

System..::..Object
  Extreme.Mathematics.Algorithms..::..ConvergenceTest
    Extreme.Mathematics.Algorithms..::..ConvergenceTestCollection
    Extreme.Mathematics.Algorithms..::..SimpleConvergenceTest