Package org.apache.commons.math

Class FunctionEvaluationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.math.MathException

org.apache.commons.math.FunctionEvaluationException

All Implemented Interfaces:

Serializable, MathThrowable

Direct Known Subclasses:

ArgumentOutsideDomainException

public class FunctionEvaluationException
extends MathException

Exception thrown when an error occurs evaluating a function.

Maintains an argument property holding the input value that caused the function evaluation to fail.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FunctionEvaluationException(double argument)	Construct an exception indicating the argument value that caused the function evaluation to fail.
FunctionEvaluationException(double[] argument)	Construct an exception indicating the argument value that caused the function evaluation to fail.
FunctionEvaluationException(double[] argument, String pattern, Object... arguments)	Constructs an exception with specified formatted detail message.
FunctionEvaluationException(double[] argument, Localizable pattern, Object... arguments)	Constructs an exception with specified formatted detail message.
FunctionEvaluationException(double argument, String pattern, Object... arguments)	Constructs an exception with specified formatted detail message.
FunctionEvaluationException(double argument, Localizable pattern, Object... arguments)	Constructs an exception with specified formatted detail message.
FunctionEvaluationException(Throwable cause, double argument)	Constructs an exception with specified root cause.
FunctionEvaluationException(Throwable cause, double[] argument)	Constructs an exception with specified root cause.
FunctionEvaluationException(Throwable cause, double[] argument, String pattern, Object... arguments)	Constructs an exception with specified formatted detail message and root cause.
FunctionEvaluationException(Throwable cause, double[] argument, Localizable pattern, Object... arguments)	Constructs an exception with specified formatted detail message and root cause.
FunctionEvaluationException(Throwable cause, double argument, String pattern, Object... arguments)	Constructs an exception with specified formatted detail message and root cause.
FunctionEvaluationException(Throwable cause, double argument, Localizable pattern, Object... arguments)	Constructs an exception with specified formatted detail message and root cause.

Method Summary

Modifier and Type	Method	Description
double[]	getArgument()	Returns the function argument that caused this exception.

Methods inherited from class org.apache.commons.math.MathException

getArguments, getGeneralPattern, getLocalizedMessage, getMessage, getMessage, getPattern, getSpecificPattern, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionEvaluationException

public FunctionEvaluationException(double argument)

Construct an exception indicating the argument value that caused the function evaluation to fail.

Parameters:

argument - the failing function argument

FunctionEvaluationException

public FunctionEvaluationException(double[] argument)

Construct an exception indicating the argument value that caused the function evaluation to fail.

Parameters:

argument - the failing function argument

Since:

2.0

FunctionEvaluationException

public FunctionEvaluationException(double argument,
 String pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

1.2

FunctionEvaluationException

public FunctionEvaluationException(double argument,
 Localizable pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.2

FunctionEvaluationException

public FunctionEvaluationException(double[] argument,
 String pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.0

FunctionEvaluationException

public FunctionEvaluationException(double[] argument,
 Localizable pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.2

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double argument)

Constructs an exception with specified root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

Since:

1.2

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double[] argument)

Constructs an exception with specified root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

Since:

2.0

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double argument,
 String pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message and root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

1.2

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double argument,
 Localizable pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message and root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.2

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double[] argument,
 String pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message and root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.0

FunctionEvaluationException

public FunctionEvaluationException(Throwable cause,
 double[] argument,
 Localizable pattern,
 Object... arguments)

Constructs an exception with specified formatted detail message and root cause. Message formatting is delegated to MessageFormat.

Parameters:

cause - the exception or error that caused this exception to be thrown

argument - the failing function argument

pattern - format specifier

arguments - format arguments

Since:

2.2

Method Details

getArgument

public double[] getArgument()

Returns the function argument that caused this exception.

Returns:

argument that caused function evaluation to fail