VectorConvergenceTest<T> Class

Represents a convergence test based on the size of a vector.

Definition

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
public class VectorConvergenceTest<T> : SimpleConvergenceTest<T>
Inheritance
Object  →  ConvergenceTest<T>  →  SimpleConvergenceTest<T>  →  VectorConvergenceTest<T>
Derived

Type Parameters

T

Remarks

Use the VectorConvergenceTest<T> class to represent a convergence test based on the size of a vector.

The Norm property specifies which norm is to be used when calculating the size of the vector. It is of type VectorConvergenceNorm. The ErrorMeasure property specifies how the error is to be calculated. It is of type VectorConvergenceErrorMeasure. A value of VectorConvergenceErrorMeasure.Norm indicates that the norm of the vector is used as the measure. A value of VectorConvergenceErrorMeasure.Element-wise indicates that the error of each component is calculated separately, and the norm of the vector of all error components is used.

Constructors

VectorConvergenceTest<T>() Constructs a new VectorConvergenceTest<T>.
VectorConvergenceTest<T>(Vector<T>) Constructs a new VectorConvergenceTest<T>.
VectorConvergenceTest<T>(Vector<T>, T) Constructs a new VectorConvergenceTest<T>.
VectorConvergenceTest<T>(Vector<T>, T, VectorConvergenceNorm) Constructs a new VectorConvergenceTest<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>)
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>)
ErrorEvaluator Gets or sets a delegate that evaluates the error estimate.
(Inherited from SimpleConvergenceTest<T>)
ErrorMeasure Gets or sets whether the error should be calculated using the vector components, or using the vector norm.
ErrorVector Gets or sets the vector that contains the error value.
Norm Gets or sets a value that indicates which vector norm is to be used to evaluate the error.
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>)
Value Gets the value used in the computation of the relative error.
(Inherited from SimpleConvergenceTest<T>)
ValueEvaluator Gets or sets a delegate that evaluates the value.
(Inherited from SimpleConvergenceTest<T>)
ValueVector Gets or sets the vector used to calculate the relative error.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
TestConvergence Performs the convergence test.
(Inherited from ConvergenceTest<T>)
TestConvergenceCore Returns whether the convergence conditions have been met.
(Overrides SimpleConvergenceTest<T>.TestConvergenceCore(Boolean))
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also