Represents a convergence test for a IterativeAlgorithm.
Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public MustInherit Class ConvergenceTest |
| C# |
|---|
public abstract class ConvergenceTest |
| C++ |
|---|
public ref class ConvergenceTest abstract |
Methods
| Icon | Type | Description |
|---|---|---|
 | Equals(Object) | |
 | Finalize() | |
| GetHashCode() | Serves as a hash function for a particular type. |
| GetType() | Gets the Type of the current instance. |
| MemberwiseClone() | Creates a shallow copy of the current Object. |
| TestConvergence() |
Performs the convergence test.
|
| ToString() |
Constructors
| Icon | Type | Description |
|---|---|---|
| ConvergenceTestNew() |
Properties
| Icon | Type | Description |
|---|---|---|
 | Active |
Gets or sets a value that indicates whether a ConvergenceTest is active.
|
| ConvergenceCriterion |
Gets or sets a value specifying the criterion that is
to be used in the convergence test for the algorithm.
|
| Error |
Gets the estimated error associated with the convergence test.
|
| Tolerance |
Gets or sets the tolerance used in the convergence test.
|
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
