Represents a convergence test.

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

Syntax

Visual Basic (Declaration)
Public Class SimpleConvergenceTest _
	Inherits ConvergenceTest
C#
public class SimpleConvergenceTest : ConvergenceTest
C++
public ref class SimpleConvergenceTest : public ConvergenceTest

Methods

IconTypeDescription
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

IconTypeDescription
SimpleConvergenceTestNew()
Constructs a new SimpleConvergenceTest object.
SimpleConvergenceTestNew(DoubleEvaluator, ConvergenceCriterion)
Constructs a new SimpleConvergenceTest object.
SimpleConvergenceTestNew(DoubleEvaluator, DoubleEvaluator, ConvergenceCriterion)
Constructs a new SimpleConvergenceTest object.

Properties

IconTypeDescription
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.
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.

Remarks

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

Inheritance Hierarchy

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