edu.northwestern.at.utils.math.rootfinders

Class StandardRootFinderConvergenceTest

java.lang.Object

edu.northwestern.at.utils.math.rootfinders.StandardRootFinderConvergenceTest

All Implemented Interfaces:

RootFinderConvergenceTest

public class StandardRootFinderConvergenceTest
extends java.lang.Object
implements RootFinderConvergenceTest

Standard test for convergence in root finders.

Constructor Summary

Constructors

Constructor and Description
StandardRootFinderConvergenceTest() Create StandardRootFinderConvergenceTest.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	converged(double xNow, double xPrev, double fxNow, double xTolerance, double fxTolerance) Interface for testing for convergence in root finders.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardRootFinderConvergenceTest

public StandardRootFinderConvergenceTest()

Create StandardRootFinderConvergenceTest.

Method Detail

converged

public boolean converged(double xNow,
                double xPrev,
                double fxNow,
                double xTolerance,
                double fxTolerance)

Description copied from interface: RootFinderConvergenceTest

Interface for testing for convergence in root finders.

Specified by:

converged in interface RootFinderConvergenceTest

Parameters:

xNow - Current root estimate.

xPrev - Previous root estimate.

fxNow - Function value at xNow.

xTolerance - Convergence tolerance for estimates.

fxTolerance - Convergence tolerance for function values.

Returns:

true if convergence achieved.