ConvergenceTestCollection<T> Class

Represents a collection of convergence tests for an IterativeAlgorithm.

Definition

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

public sealed class ConvergenceTestCollection<T> : ConvergenceTest<T>, 
	ICollection, IEnumerable, ICollection<ConvergenceTest<T>>, IEnumerable<ConvergenceTest<T>>

Visual Basic

Public NotInheritable Class ConvergenceTestCollection(Of T)
	Inherits ConvergenceTest(Of T)
	Implements ICollection, IEnumerable, ICollection(Of ConvergenceTest(Of T)), 
	IEnumerable(Of ConvergenceTest(Of T))

C++/CLI

generic<typename T>
public ref class ConvergenceTestCollection sealed : public ConvergenceTest<T>, 
	ICollection, IEnumerable, ICollection<ConvergenceTest<T>^>, IEnumerable<ConvergenceTest<T>^>

[<SealedAttribute>]
type ConvergenceTestCollection<'T> = 
    class
        inherit ConvergenceTest<'T>
        interface ICollection
        interface IEnumerable
        interface ICollection<ConvergenceTest<'T>>
        interface IEnumerable<ConvergenceTest<'T>>
    end

Inheritance: Object → ConvergenceTest<T> → ConvergenceTestCollection<T>

Implements: ICollection<ConvergenceTest<T>>, IEnumerable<ConvergenceTest<T>>, ICollection, IEnumerable

Type Parameters

T

Remarks

Use the ConvergenceTestCollection<T> 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 Enabled property is true are included in the test.

Constructors

ConvergenceTestCollection<T>()	Constructs a new ConvergenceTestCollection<T>.
ConvergenceTestCollection<T>(ConvergenceTest<T>[])	Constructs a new ConvergenceTestCollection<T>.
ConvergenceTestCollection<T>(ConvergenceTestQuantifier, ConvergenceTest<T>[])	Constructs a new ConvergenceTestCollection<T>.

Properties

AbsoluteTolerance	Gets or sets the absolute tolerance used in the convergence test. (Inherited from ConvergenceTest<T>)
ConvergenceCriterion	Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm. (Inherited from ConvergenceTest<T>)
Count	Gets the number of tests in the ConvergenceTestCollection<T>
Enabled	Gets or sets whether a ConvergenceTest<T> is enabled. (Inherited from ConvergenceTest<T>)
Error	Gets the estimated error associated with the convergence test. (Inherited from ConvergenceTest<T>)
IsReadOnly	Gets a value indicating whether the ConvergenceTestCollection<T> is read-only.
Quantifier	Gets or sets a value that indicates how the tests in the collection are to be combined.
RelativeTolerance	Gets or sets the relative tolerance used in the convergence test. (Inherited from ConvergenceTest<T>)
RequiredSuccessivePasses	Gets or sets a value that indicates the number of times the test criteria must be fulfilled before the test is considered successful. (Inherited from ConvergenceTest<T>)
RunBeforeIteration	Gets or sets whether the convergence test should be run before the first actual iteration. (Inherited from ConvergenceTest<T>)
Tolerance	Gets or sets the tolerance used in the convergence test. (Inherited from ConvergenceTest<T>)

Methods

Add	Adds a ConvergenceTest<T> to the collection.
Clear	Removes all tests in the collection.
Contains	Determines whether the ConvergenceTestCollection<T> contains a specific item.
CopyTo	Copies the members of the collection to the specified array.
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator	Gets an IEnumerator object that can iterate over the tests in the collection.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Remove	Removes the first occurrence of the specified item from the ConvergenceTestCollection<T>.
TestConvergence	Performs the convergence test. (Inherited from ConvergenceTest<T>)
ToString	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

Group<ConvergenceTest<T>>	Returns a grouping by the unique elements in a sequence. (Defined by Grouping)
Group<ConvergenceTest<T>>	Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality. (Defined by Grouping)
Sum<ConvergenceTest<T>>	Computes the sum of the sequence of values. (Defined by ArrayMath)
Sum<ConvergenceTest<T>, U>	Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence. (Defined by ArrayMath)