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

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Class VectorConvergenceTest _ Inherits SimpleConvergenceTest

C#
public class VectorConvergenceTest : SimpleConvergenceTest

C++
public ref class VectorConvergenceTest : public SimpleConvergenceTest

Methods

Icon	Type	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object.
	Finalize()	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage 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.
	TestConvergence()	Returns a value that indicates whether the convergence conditions have been met.
	ToString()	Returns a String that represents the current Object.

Constructors

Icon	Type	Description
	VectorConvergenceTestNew()	Constructs a new VectorConvergenceTest.
	VectorConvergenceTestNew(Vector, Double, VectorConvergenceNorm)	Constructs a new VectorConvergenceTest.
	VectorConvergenceTestNew(Vector, Double)	Constructs a new VectorConvergenceTest.
	VectorConvergenceTestNew(Vector)	Constructs a new VectorConvergenceTest.

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.
	Error	Gets the estimated error associated with the convergence test.
	ErrorEvaluator	Gets or sets a delegate that evaluates the _error estimate.
	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.
	Tolerance	Gets or sets the tolerance used in the convergence test.
	Value	Gets the value used in the computation of the relative error.
	ValueEvaluator	Gets or sets a delegate that evaluates the value.
	ValueVector	Gets or sets the Vector used to calculate the relative error.

Remarks

Use the VectorConvergenceTest 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.Componentwise indicates that the error of each component is calculated separately, and the norm of the vector of all error components is used.

Inheritance Hierarchy

System.Object
  Extreme.Mathematics.ConvergenceTest
    Extreme.Mathematics.SimpleConvergenceTest
      Extreme.Mathematics.VectorConvergenceTest