SystemObject Extreme.Mathematics.AlgorithmsConvergenceTestT Extreme.Mathematics.AlgorithmsConvergenceTestCollectionT Extreme.Mathematics.AlgorithmsSimpleConvergenceTestT
Namespace:
Extreme.Mathematics.Algorithms
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public abstract class ConvergenceTest<T>
Public MustInherit Class ConvergenceTest(Of T)
generic<typename T>
public ref class ConvergenceTest abstract
[<AbstractClassAttribute>]
type ConvergenceTest<'T> = class end
Type Parameters
- T
The ConvergenceTestT type exposes the following members.
| Name | Description |
---|
 | ConvergenceTestT | Initializes a new instance of the ConvergenceTestT class |
Top
| Name | Description |
---|
 | 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 ConvergenceTestT 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.
|
Top
| Name | Description |
---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
 | GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
 | TestConvergence |
Performs the convergence test.
|
 | TestConvergenceCore |
Performs the convergence test.
|
 | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Use the ConvergenceTestT class as the base class for a class that implements a convergence
test for an algorithm or group of algorithms.
ConvergenceTestT is an abstract class and cannot be instantiated directly. Instead,
derive your own class from ConvergenceTestT, 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(Boolean)
method.
Reference