Vector
Represents a convergence test based on the size of a real vector.
Definition
Namespace: Numerics.NET.Algorithms
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
C#
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
public class VectorConvergenceTest : VectorConvergenceTest<double>- Inheritance
- Object → ConvergenceTest<Double> → SimpleConvergenceTest<Double> → VectorConvergenceTest<Double> → VectorConvergenceTest
Remarks
Use the VectorConvergenceTest class to represent a convergence test based on the size of a real 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
| Vector | Constructs a new VectorConvergenceTest<T>. |
| Vector | Constructs a new VectorConvergenceTest<T>. |
| Vector | Constructs a new VectorConvergenceTest<T>. |
| Vector | Constructs a new VectorConvergenceTest<T>. |
Properties
| Absolute |
Gets or sets the absolute tolerance used in the
convergence test.
(Inherited from ConvergenceTest<T>) |
| Convergence |
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>) |
| Error |
Gets or sets a delegate that evaluates the error estimate.
(Inherited from SimpleConvergenceTest<T>) |
| Error |
Gets or sets whether the error should be calculated using the vector components,
or using the vector norm.
(Inherited from VectorConvergenceTest<T>) |
| Error |
Gets or sets the vector that contains the error value.
(Inherited from VectorConvergenceTest<T>) |
| Norm |
Gets or sets a value that indicates which vector norm is to be used
to evaluate the error.
(Inherited from VectorConvergenceTest<T>) |
| Relative |
Gets or sets the relative tolerance used in the
convergence test.
(Inherited from ConvergenceTest<T>) |
| Required |
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>) |
| Run |
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>) |
| Value |
Gets or sets a delegate that evaluates the value.
(Inherited from SimpleConvergenceTest<T>) |
| Value |
Gets or sets the vector used to calculate the relative error.
(Inherited from VectorConvergenceTest<T>) |
Methods
| 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) |
| Get | Serves as the default hash function. (Inherited from Object) |
| Get | Gets the Type of the current instance. (Inherited from Object) |
| Memberwise | Creates a shallow copy of the current Object. (Inherited from Object) |
| Test |
Performs the convergence test.
(Inherited from ConvergenceTest<T>) |
| Test |
Returns whether the convergence conditions have been met.
(Inherited from VectorConvergenceTest<T>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |