VectorConvergenceTestT Class

public class VectorConvergenceTest<T> : SimpleConvergenceTest<T>

Public Class VectorConvergenceTest(Of T)
	Inherits SimpleConvergenceTest(Of T)

generic<typename T>
public ref class VectorConvergenceTest : public SimpleConvergenceTest<T>

type VectorConvergenceTest<'T> =  
    class
        inherit SimpleConvergenceTest<'T>
    end

Type Parameters

T

The VectorConvergenceTestT type exposes the following members.

	Name	Description
	VectorConvergenceTestT	Constructs a new VectorConvergenceTestT.
	VectorConvergenceTestT(VectorT)	Constructs a new VectorConvergenceTestT.
	VectorConvergenceTestT(VectorT, T)	Constructs a new VectorConvergenceTestT.
	VectorConvergenceTestT(VectorT, T, VectorConvergenceNorm)	Constructs a new VectorConvergenceTestT.

	Name	Description
	AbsoluteTolerance	Gets or sets the absolute tolerance used in the convergence test. (Inherited from ConvergenceTestT.)
	ConvergenceCriterion	Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm. (Inherited from ConvergenceTestT.)
	Enabled	Gets or sets whether a ConvergenceTestT is enabled. (Inherited from ConvergenceTestT.)
	Error	Gets the estimated error associated with the convergence test. (Inherited from ConvergenceTestT.)
	ErrorEvaluator	Gets or sets a delegate that evaluates the error estimate. (Inherited from SimpleConvergenceTestT.)
	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 ConvergenceTestT.)
	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 ConvergenceTestT.)
	RunBeforeIteration	Gets or sets whether the convergence test should be run before the first actual iteration. (Inherited from ConvergenceTestT.)
	Tolerance	Gets or sets the tolerance used in the convergence test. (Inherited from ConvergenceTestT.)
	Value	Gets the value used in the computation of the relative error. (Inherited from SimpleConvergenceTestT.)
	ValueEvaluator	Gets or sets a delegate that evaluates the value. (Inherited from SimpleConvergenceTestT.)
	ValueVector	Gets or sets the vector used to calculate the relative error.

	Name	Description
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	TestConvergence	Performs the convergence test. (Inherited from ConvergenceTestT.)
	TestConvergenceCore	Returns whether the convergence conditions have been met. (Overrides SimpleConvergenceTestTTestConvergenceCore(Boolean).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Use the VectorConvergenceTestT 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.

Reference