Package org.apache.commons.math4.legacy.exception

Class NotFiniteNumberException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.commons.math4.legacy.exception.MathRuntimeException

org.apache.commons.math4.legacy.exception.MathIllegalArgumentException

org.apache.commons.math4.legacy.exception.MathIllegalNumberException

org.apache.commons.math4.legacy.exception.NotFiniteNumberException

All Implemented Interfaces:

Serializable, ExceptionContextProvider

public class NotFiniteNumberException
extends MathIllegalNumberException

Exception to be thrown when a number is not finite.

Since:

3.0

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.commons.math4.legacy.exception.MathIllegalNumberException

INTEGER_ZERO

Constructor Summary

Constructors

Constructor	Description
NotFiniteNumberException(Number wrong, Object... args)	Construct the exception.
NotFiniteNumberException(Localizable specific, Number wrong, Object... args)	Construct the exception with a specific context.

Method Summary

Modifier and Type	Method	Description
static void	check(double x)	Check that the argument is a real number.
static void	check(double[] val)	Check that all the elements are real numbers.

Methods inherited from class org.apache.commons.math4.legacy.exception.MathIllegalNumberException

getArgument

Methods inherited from class org.apache.commons.math4.legacy.exception.MathRuntimeException

getContext, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

NotFiniteNumberException

public NotFiniteNumberException(Number wrong,
                                Object... args)

Construct the exception.

Parameters:

wrong - Value that is infinite or NaN.

args - Optional arguments.

NotFiniteNumberException

public NotFiniteNumberException(Localizable specific,
                                Number wrong,
                                Object... args)

Construct the exception with a specific context.

Parameters:

specific - Specific context pattern.

wrong - Value that is infinite or NaN.

args - Optional arguments.

Method Detail

check

public static void check(double x)

Check that the argument is a real number.

Parameters:

x - Argument.

Throws:

NotFiniteNumberException - if x is not a finite real number.

check

public static void check(double[] val)

Check that all the elements are real numbers.

Parameters:

val - Arguments.

Throws:

NotFiniteNumberException - if any values of the array is not a finite real number.