Represents a collection of convergence tests for an IterativeAlgorithm.
Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public NotInheritable Class ConvergenceTestCollection _ Inherits ConvergenceTest _ Implements ICollection, ICollection(Of ConvergenceTest), IEnumerable(Of ConvergenceTest), IEnumerable |
| C# |
|---|
public sealed class ConvergenceTestCollection : ConvergenceTest, ICollection, ICollection<ConvergenceTest>, IEnumerable<ConvergenceTest>, IEnumerable |
| C++ |
|---|
public ref class ConvergenceTestCollection sealed : public ConvergenceTest, ICollection, ICollection<ConvergenceTest^>, IEnumerable<ConvergenceTest^>, IEnumerable |
Methods
| Icon | Type | Description |
|---|---|---|
 | Add(ConvergenceTest) |
Adds a ConvergenceTest to the collection.
|
| Clear() |
Removes all tests in the collection.
|
| Contains(ConvergenceTest) |
Determines whether the ConvergenceTestCollection contains a specific item.
|
| CopyTo(ConvergenceTest[](), Int32) |
Copies the members of the collection to the specified array.
|
| Equals(Object) | |
 | Finalize() | |
| GetEnumerator() |
Gets an IEnumerator object that can iterate over the tests in the collection.
|
| 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. |
| Remove(ConvergenceTest) |
Removes the first occurrence of the specified item from the ConvergenceTestCollection.
|
| TestConvergence() |
Performs the convergence test.
|
| ToString() |
Constructors
| Icon | Type | Description |
|---|---|---|
| ConvergenceTestCollectionNew() |
Constructs a new ConvergenceTestCollection.
|
| ConvergenceTestCollectionNew(ConvergenceTestQuantifier, ConvergenceTest[]()) |
Constructs a new ConvergenceTestCollection.
|
| ConvergenceTestCollectionNew(ConvergenceTest[]()) |
Constructs a new ConvergenceTestCollection.
|
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.
|
| Count |
Gets the number of tests in the ConvergenceTestCollection |
| Error |
Gets the estimated error associated with the convergence test.
|
| IsReadOnly |
Gets a value indicating whether the ConvergenceTestCollection is read-only.
|
| Quantifier |
Gets or sets a value that indicates how the tests in the collection are to be combined.
|
| Tolerance |
Gets or sets the tolerance used in the convergence test.
|
Remarks
Use the ConvergenceTestCollection to specify a convergence test that
consists of several criteria. Depending on the value of the Quantifier property,
the test succeeds if any one of the member tests succeed, or only if all of the
tests succeed. Only tests whose Active property
is true are included in the test.
Inheritance Hierarchy
See Also
