Class NonMonotonicSequenceException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
java.lang.IllegalArgumentException
org.apache.commons.math3.exception.MathIllegalArgumentException
org.apache.commons.math3.exception.MathIllegalNumberException
org.apache.commons.math3.exception.NonMonotonicSequenceException
- All Implemented Interfaces:
Serializable
,ExceptionContextProvider
Exception to be thrown when the a sequence of values is not monotonically
increasing or decreasing.
- Since:
- 2.2 (name changed to "NonMonotonicSequenceException" in 3.0)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final MathArrays.OrderDirection
Direction (positive for increasing, negative for decreasing).private final int
Index of the wrong value.private final Number
Previous value.private static final long
Serializable version Id.private final boolean
Whether the sequence must be strictly increasing or decreasing.Fields inherited from class org.apache.commons.math3.exception.MathIllegalNumberException
INTEGER_ZERO
-
Constructor Summary
ConstructorsConstructorDescriptionNonMonotonicSequenceException
(Number wrong, Number previous, int index) Construct the exception.NonMonotonicSequenceException
(Number wrong, Number previous, int index, MathArrays.OrderDirection direction, boolean strict) Construct the exception. -
Method Summary
Methods inherited from class org.apache.commons.math3.exception.MathIllegalNumberException
getArgument
Methods inherited from class org.apache.commons.math3.exception.MathIllegalArgumentException
getContext, getLocalizedMessage, getMessage
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerializable version Id.- See Also:
-
direction
Direction (positive for increasing, negative for decreasing). -
strict
private final boolean strictWhether the sequence must be strictly increasing or decreasing. -
index
private final int indexIndex of the wrong value. -
previous
Previous value.
-
-
Constructor Details
-
NonMonotonicSequenceException
Construct the exception. This constructor uses default values assuming that the sequence should have been strictly increasing.- Parameters:
wrong
- Value that did not match the requirements.previous
- Previous value in the sequence.index
- Index of the value that did not match the requirements.
-
NonMonotonicSequenceException
public NonMonotonicSequenceException(Number wrong, Number previous, int index, MathArrays.OrderDirection direction, boolean strict) Construct the exception.- Parameters:
wrong
- Value that did not match the requirements.previous
- Previous value in the sequence.index
- Index of the value that did not match the requirements.direction
- Strictly positive for a sequence required to be increasing, negative (or zero) for a decreasing sequence.strict
- Whether the sequence must be strictly increasing or decreasing.
-
-
Method Details
-
getDirection
- Returns:
- the order direction.
-
getStrict
public boolean getStrict()- Returns:
true
is the sequence should be strictly monotonic.
-
getIndex
public int getIndex()Get the index of the wrong value.- Returns:
- the current index.
-
getPrevious
- Returns:
- the previous value.
-