org.apache.commons.math.exception
Class NonMonotonousSequenceException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
java.lang.IllegalArgumentException
org.apache.commons.math.exception.MathIllegalArgumentException
org.apache.commons.math.exception.MathIllegalNumberException
org.apache.commons.math.exception.NonMonotonousSequenceException
- All Implemented Interfaces:
- java.io.Serializable, MathThrowable
public class NonMonotonousSequenceException
- extends MathIllegalNumberException
Exception to be thrown when the a sequence of values is not monotonously
increasing or decreasing.
- Since:
- 2.2
- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
NonMonotonousSequenceException
public NonMonotonousSequenceException(java.lang.Number wrong,
java.lang.Number previous,
int index)
- 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.
NonMonotonousSequenceException
public NonMonotonousSequenceException(java.lang.Number wrong,
java.lang.Number previous,
int index,
MathUtils.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.
getDirection
public MathUtils.OrderDirection getDirection()
- Returns:
- the order direction.
getStrict
public boolean getStrict()
- Returns:
true
is the sequence should be strictly monotonous.
getIndex
public int getIndex()
- Get the index of the wrong value.
- Returns:
- the current index.
getPrevious
public java.lang.Number getPrevious()
- Returns:
- the previous value.
Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.