com.numericalmethod.suanshu.analysis.uniroot

Class NoRootFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.numericalmethod.suanshu.analysis.uniroot.NoRootFoundException

All Implemented Interfaces:

java.io.Serializable

public class NoRootFoundException
extends java.lang.Exception

This is the Exception thrown when it fails to find a root. It may contain some information about the state before it throws the exception. It may be be useful in situations where an (approximate) root is needed at the sacrifice of accuracy.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoRootFoundException(double x, double fx) Construct a NoRootFoundException.

Method Summary

Modifier and Type	Method and Description
double	fx() Get f(x).
double	x() the best approximate root found so far

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NoRootFoundException

public NoRootFoundException(double x,
                            double fx)

Construct a NoRootFoundException. This object gives a snapshot/information of the uniroot algorithm before it throws the exception.

Parameters:

x - the best approximate root found before throwing exception

fx - the function value f(x)

Method Detail

x

public double x()

the best approximate root found so far

Returns:

a root

fx

public double fx()

Get f(x).

Returns:

f(x)