SimpleConvergenceTest<T> Class

Represents a convergence test.

Definition

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

public class SimpleConvergenceTest<T> : ConvergenceTest<T>

Visual Basic

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

C++/CLI

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

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

Derived: Extreme.Mathematics.Algorithms.SimpleConvergenceTest
Extreme.Mathematics.Algorithms.VectorConvergenceTest<T>

Use the SimpleConvergenceTest<T> class as a convergence test based on whether a value is sufficiently close to another value, or to zero.

SimpleConvergenceTest<T>()	Constructs a new SimpleConvergenceTest<T> object.
SimpleConvergenceTest<T>(Func<T>, ConvergenceCriterion)	Constructs a new SimpleConvergenceTest<T> object.
SimpleConvergenceTest<T>(Func<T>, Func<T>, ConvergenceCriterion)	Constructs a new SimpleConvergenceTest<T> object.

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.
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.
ValueEvaluator	Gets or sets a delegate that evaluates the value.

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 ConvergenceTest<T>)
TestConvergenceCore	Returns whether the convergence conditions have been met. (Overrides ConvergenceTest<T>.TestConvergenceCore(Boolean))
ToString	Returns a string that represents the current object. (Inherited from Object)