SimpleConvergenceTest Constructor

Definition

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

Overload List

SimpleConvergenceTest

Constructs a new SimpleConvergenceTest<T> object.
C#
public SimpleConvergenceTest()

SimpleConvergenceTest(Func<Double>, ConvergenceCriterion)

Constructs a new SimpleConvergenceTest<T> object.
C#
public SimpleConvergenceTest(
	Func<double> errorEvaluator,
	ConvergenceCriterion convergenceCriterion
)

Parameters

errorEvaluator  Func<Double>
A delegate that takes no arguments and returns the estimated error.
convergenceCriterion  ConvergenceCriterion
A ConvergenceCriterion value that specifies the type of convergence condition.

Exceptions

ArgumentNullExceptionerrorEvaluator is null.

SimpleConvergenceTest(Func<Double>, Func<Double>, ConvergenceCriterion)

Constructs a new SimpleConvergenceTest<T> object.
C#
public SimpleConvergenceTest(
	Func<double> errorEvaluator,
	Func<double> valueEvaluator,
	ConvergenceCriterion convergenceCriterion
)

Parameters

errorEvaluator  Func<Double>
A delegate with no arguments that returns a real number that returns the estimated error.
valueEvaluator  Func<Double>
A delegate with no arguments that returns a real number that returns the estimated value.
convergenceCriterion  ConvergenceCriterion
A ConvergenceCriterion value that specifies the type of convergence condition.

Exceptions

ArgumentNullExceptionerrorEvaluator is null.

See Also