/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.Serializable;
/**
* IntRange represents an inclusive range of ints.
*
* @author Stephen Colebourne
* @since 2.0
* @version $Id: IntRange.java 594398 2007-11-13 02:43:10Z bayard $
*/
public final class IntRange extends Range implements Serializable {
/**
* Required for serialization support.
*
* @see java.io.Serializable
*/
private static final long serialVersionUID = 71849363892730L;
/**
* The minimum number in this range (inclusive).
*/
private final int min;
/**
* The maximum number in this range (inclusive).
*/
private final int max;
/**
* Cached output minObject (class is immutable).
*/
private transient Integer minObject = null;
/**
* Cached output maxObject (class is immutable).
*/
private transient Integer maxObject = null;
/**
* Cached output hashCode (class is immutable).
*/
private transient int hashCode = 0;
/**
* Cached output toString (class is immutable).
*/
private transient String toString = null;
/**
* Constructs a new IntRange using the specified
* number as both the minimum and maximum in this range.
*
* @param number the number to use for this range
*/
public IntRange(int number) {
super();
this.min = number;
this.max = number;
}
/**
* Constructs a new IntRange using the specified
* number as both the minimum and maximum in this range.
*
* @param number the number to use for this range, must not be null
* @throws IllegalArgumentException if the number is null
*/
public IntRange(Number number) {
super();
if (number == null) {
throw new IllegalArgumentException("The number must not be null");
}
this.min = number.intValue();
this.max = number.intValue();
if (number instanceof Integer) {
this.minObject = (Integer) number;
this.maxObject = (Integer) number;
}
}
/**
* Constructs a new IntRange with the specified
* minimum and maximum numbers (both inclusive).
*
* The arguments may be passed in the order (min,max) or (max,min). The
* getMinimum and getMaximum methods will return the correct values.
*
* @param number1 first number that defines the edge of the range, inclusive
* @param number2 second number that defines the edge of the range, inclusive
*/
public IntRange(int number1, int number2) {
super();
if (number2 < number1) {
this.min = number2;
this.max = number1;
} else {
this.min = number1;
this.max = number2;
}
}
/**
* Constructs a new IntRange with the specified
* minimum and maximum numbers (both inclusive).
*
* The arguments may be passed in the order (min,max) or (max,min). The
* getMinimum and getMaximum methods will return the correct values.
*
* @param number1 first number that defines the edge of the range, inclusive
* @param number2 second number that defines the edge of the range, inclusive
* @throws IllegalArgumentException if either number is null
*/
public IntRange(Number number1, Number number2) {
super();
if (number1 == null || number2 == null) {
throw new IllegalArgumentException("The numbers must not be null");
}
int number1val = number1.intValue();
int number2val = number2.intValue();
if (number2val < number1val) {
this.min = number2val;
this.max = number1val;
if (number2 instanceof Integer) {
this.minObject = (Integer) number2;
}
if (number1 instanceof Integer) {
this.maxObject = (Integer) number1;
}
} else {
this.min = number1val;
this.max = number2val;
if (number1 instanceof Integer) {
this.minObject = (Integer) number1;
}
if (number2 instanceof Integer) {
this.maxObject = (Integer) number2;
}
}
}
// Accessors
//--------------------------------------------------------------------
/**
* Returns the minimum number in this range.
*
* @return the minimum number in this range
*/
public Number getMinimumNumber() {
if (minObject == null) {
minObject = new Integer(min);
}
return minObject;
}
/**
* Gets the minimum number in this range as a long.
*
* @return the minimum number in this range
*/
public long getMinimumLong() {
return min;
}
/**
* Gets the minimum number in this range as a int.
*
* @return the minimum number in this range
*/
public int getMinimumInteger() {
return min;
}
/**
* Gets the minimum number in this range as a double.
*
* @return the minimum number in this range
*/
public double getMinimumDouble() {
return min;
}
/**
* Gets the minimum number in this range as a float.
*
* @return the minimum number in this range
*/
public float getMinimumFloat() {
return min;
}
/**
* Returns the maximum number in this range.
*
* @return the maximum number in this range
*/
public Number getMaximumNumber() {
if (maxObject == null) {
maxObject = new Integer(max);
}
return maxObject;
}
/**
* Gets the maximum number in this range as a long.
*
* @return the maximum number in this range
*/
public long getMaximumLong() {
return max;
}
/**
* Gets the maximum number in this range as a int.
*
* @return the maximum number in this range
*/
public int getMaximumInteger() {
return max;
}
/**
* Gets the maximum number in this range as a double.
*
* @return the maximum number in this range
*/
public double getMaximumDouble() {
return max;
}
/**
* Gets the maximum number in this range as a float.
*
* @return the maximum number in this range
*/
public float getMaximumFloat() {
return max;
}
// Tests
//--------------------------------------------------------------------
/**
* Tests whether the specified number occurs within
* this range using int comparison.
*
* null is handled and returns false.
*
* @param number the number to test, may be null
* @return true if the specified number occurs within this range
*/
public boolean containsNumber(Number number) {
if (number == null) {
return false;
}
return containsInteger(number.intValue());
}
/**
* Tests whether the specified int occurs within
* this range using int comparison.
*
* This implementation overrides the superclass for performance as it is
* the most common case.
*
* @param value the int to test
* @return true if the specified number occurs within this
* range by int comparison
*/
public boolean containsInteger(int value) {
return value >= min && value <= max;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range
* using int comparison.
*
* null is handled and returns false.
*
* @param range the range to test, may be null
* @return true if the specified range occurs entirely within this range
* @throws IllegalArgumentException if the range is not of this type
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsInteger(range.getMinimumInteger()) &&
containsInteger(range.getMaximumInteger());
}
/**
* Tests whether the specified range overlaps with this range
* using int comparison.
*
* null is handled and returns false.
*
* @param range the range to test, may be null
* @return true if the specified range overlaps with this range
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsInteger(min) ||
range.containsInteger(max) ||
containsInteger(range.getMinimumInteger());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
.
*
* To be equal, the class, minimum and maximum must be equal.
*
* @param obj the reference object with which to compare
* @return true if this object is equal
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof IntRange == false) {
return false;
}
IntRange range = (IntRange) obj;
return min == range.min && max == range.max;
}
/**
* Gets a hashCode for the range.
*
* @return a hash code value for this object
*/
public int hashCode() {
if (hashCode == 0) {
hashCode = 17;
hashCode = 37 * hashCode + getClass().hashCode();
hashCode = 37 * hashCode + min;
hashCode = 37 * hashCode + max;
}
return hashCode;
}
/**
* Gets the range as a String.
*
* The format of the String is 'Range[min,max]'.
*
* @return the String representation of this range
*/
public String toString() {
if (toString == null) {
StringBuffer buf = new StringBuffer(32);
buf.append("Range[");
buf.append(min);
buf.append(',');
buf.append(max);
buf.append(']');
toString = buf.toString();
}
return toString;
}
/**
* Returns an array containing all the integer values in the range.
*
* @return the int[] representation of this range
* @since 2.4
*/
public int[] toArray() {
int[] array = new int[max - min + 1];
for (int i = 0; i < array.length; i++) {
array[i] = min + i;
}
return array;
}
}
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Range represents a range of numbers of the same type.
*
* Specific subclasses hold the range values as different types. Each
* subclass should be immutable and {@link java.io.Serializable Serializable}
* if possible.
*
* @author Stephen Colebourne
* @since 2.0
* @version $Id: Range.java 437554 2006-08-28 06:21:41Z bayard $
*/
abstract class Range {
/**
* Constructs a new range.
*/
public Range() {
super();
}
// Accessors
//--------------------------------------------------------------------
/**
* Gets the minimum number in this range.
*
* @return the minimum number in this range
*/
public abstract Number getMinimumNumber();
/**
* Gets the minimum number in this range as a long.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public long getMinimumLong() {
return getMinimumNumber().longValue();
}
/**
* Gets the minimum number in this range as a int.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public int getMinimumInteger() {
return getMinimumNumber().intValue();
}
/**
* Gets the minimum number in this range as a double.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public double getMinimumDouble() {
return getMinimumNumber().doubleValue();
}
/**
* Gets the minimum number in this range as a float.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public float getMinimumFloat() {
return getMinimumNumber().floatValue();
}
/**
* Gets the maximum number in this range.
*
* @return the maximum number in this range
*/
public abstract Number getMaximumNumber();
/**
* Gets the maximum number in this range as a long.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public long getMaximumLong() {
return getMaximumNumber().longValue();
}
/**
* Gets the maximum number in this range as a int.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public int getMaximumInteger() {
return getMaximumNumber().intValue();
}
/**
* Gets the maximum number in this range as a double.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public double getMaximumDouble() {
return getMaximumNumber().doubleValue();
}
/**
* Gets the maximum number in this range as a float.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public float getMaximumFloat() {
return getMaximumNumber().floatValue();
}
// Include tests
//--------------------------------------------------------------------
/**
* Tests whether the specified Number occurs within
* this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare using
* int comparison.
*
* null is handled and returns false.
*
* @param number the number to test, may be null
* @return true if the specified number occurs within this range
* @throws IllegalArgumentException if the Number cannot be compared
*/
public abstract boolean containsNumber(Number number);
/**
* Tests whether the specified Number occurs within
* this range using long comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsLong(long)} method.
*
* @param value the long to test, may be null
* @return true if the specified number occurs within this
* range by long comparison
*/
public boolean containsLong(Number value) {
if (value == null) {
return false;
}
return containsLong(value.longValue());
}
/**
* Tests whether the specified long occurs within
* this range using long comparison.
*
* This implementation uses the {@link #getMinimumLong()} and
* {@link #getMaximumLong()} methods and should be good for most uses.
*
* @param value the long to test
* @return true if the specified number occurs within this
* range by long comparison
*/
public boolean containsLong(long value) {
return value >= getMinimumLong() && value <= getMaximumLong();
}
/**
* Tests whether the specified Number occurs within
* this range using int comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsInteger(int)} method.
*
* @param value the integer to test, may be null
* @return true if the specified number occurs within this
* range by int comparison
*/
public boolean containsInteger(Number value) {
if (value == null) {
return false;
}
return containsInteger(value.intValue());
}
/**
* Tests whether the specified int occurs within
* this range using int comparison.
*
* This implementation uses the {@link #getMinimumInteger()} and
* {@link #getMaximumInteger()} methods and should be good for most uses.
*
* @param value the int to test
* @return true if the specified number occurs within this
* range by int comparison
*/
public boolean containsInteger(int value) {
return value >= getMinimumInteger() && value <= getMaximumInteger();
}
/**
* Tests whether the specified Number occurs within
* this range using double comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsDouble(double)} method.
*
* @param value the double to test, may be null
* @return true if the specified number occurs within this
* range by double comparison
*/
public boolean containsDouble(Number value) {
if (value == null) {
return false;
}
return containsDouble(value.doubleValue());
}
/**
* Tests whether the specified double occurs within
* this range using double comparison.
*
* This implementation uses the {@link #getMinimumDouble()} and
* {@link #getMaximumDouble()} methods and should be good for most uses.
*
* @param value the double to test
* @return true if the specified number occurs within this
* range by double comparison
*/
public boolean containsDouble(double value) {
int compareMin = compare(getMinimumDouble(), value);
int compareMax = compare(getMaximumDouble(), value);
return compareMin <= 0 && compareMax >= 0;
}
/**
* Tests whether the specified Number occurs within
* this range using float comparison.
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsFloat(float)} method.
*
* @param value the float to test, may be null
* @return true if the specified number occurs within this
* range by float comparison
*/
public boolean containsFloat(Number value) {
if (value == null) {
return false;
}
return containsFloat(value.floatValue());
}
/**
* Tests whether the specified float occurs within
* this range using float comparison.
*
* This implementation uses the {@link #getMinimumFloat()} and
* {@link #getMaximumFloat()} methods and should be good for most uses.
*
* @param value the float to test
* @return true if the specified number occurs within this
* range by float comparison
*/
public boolean containsFloat(float value) {
int compareMin = compare(getMinimumFloat(), value);
int compareMax = compare(getMaximumFloat(), value);
return compareMin <= 0 && compareMax >= 0;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare using
* int comparison.
*
* null is handled and returns false.
*
* This implementation uses the {@link #containsNumber(Number)} method.
* Subclasses may be able to optimise this.
*
* @param range the range to test, may be null
* @return true if the specified range occurs entirely within
* this range; otherwise, false
* @throws IllegalArgumentException if the Range cannot be compared
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsNumber(range.getMinimumNumber())
&& containsNumber(range.getMaximumNumber());
}
/**
* Tests whether the specified range overlaps with this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare using
* int comparison.
*
* null is handled and returns false.
*
* This implementation uses the {@link #containsNumber(Number)} and
* {@link #containsRange(Range)} methods.
* Subclasses may be able to optimise this.
*
* @param range the range to test, may be null
* @return true if the specified range overlaps with this
* range; otherwise, false
* @throws IllegalArgumentException if the Range cannot be compared
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsNumber(getMinimumNumber())
|| range.containsNumber(getMaximumNumber())
|| containsNumber(range.getMinimumNumber());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
.
*
* To be equal, the class, minimum and maximum must be equal.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @param obj the reference object with which to compare
* @return true if this object is equal
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
} else if (obj == null || obj.getClass() != getClass()) {
return false;
} else {
Range range = (Range) obj;
return getMinimumNumber().equals(range.getMinimumNumber()) &&
getMaximumNumber().equals(range.getMaximumNumber());
}
}
/**
* Gets a hashCode for the range.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @return a hash code value for this object
*/
public int hashCode() {
int result = 17;
result = 37 * result + getClass().hashCode();
result = 37 * result + getMinimumNumber().hashCode();
result = 37 * result + getMaximumNumber().hashCode();
return result;
}
/**
* Gets the range as a String.
*
* The format of the String is 'Range[min,max]'.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @return the String representation of this range
*/
public String toString() {
StringBuffer buf = new StringBuffer(32);
buf.append("Range[");
buf.append(getMinimumNumber());
buf.append(',');
buf.append(getMaximumNumber());
buf.append(']');
return buf.toString();
}
/**
* Compares two doubles for order.
*
* This method is more comprehensive than the standard Java greater
* than, less than and equals operators.
*
* - It returns
-1 if the first value is less than the second.
* - It returns
+1 if the first value is greater than the second.
* - It returns
0 if the values are equal.
*
*
*
* The ordering is as follows, largest to smallest:
*
* - NaN
* - Positive infinity
* - Maximum double
* - Normal positive numbers
* - +0.0
* - -0.0
* - Normal negative numbers
* - Minimum double (
-Double.MAX_VALUE)
* - Negative infinity
*
*
*
* Comparing NaN with NaN will
* return 0.
*
* @param lhs the first double
* @param rhs the second double
* @return -1 if lhs is less, +1 if greater,
* 0 if equal to rhs
*/
public static int compare(double lhs, double rhs) {
if (lhs < rhs) {
return -1;
}
if (lhs > rhs) {
return +1;
}
// Need to compare bits to handle 0.0 == -0.0 being true
// compare should put -0.0 < +0.0
// Two NaNs are also == for compare purposes
// where NaN == NaN is false
long lhsBits = Double.doubleToLongBits(lhs);
long rhsBits = Double.doubleToLongBits(rhs);
if (lhsBits == rhsBits) {
return 0;
}
// Something exotic! A comparison to NaN or 0.0 vs -0.0
// Fortunately NaN's long is > than everything else
// Also negzeros bits < poszero
// NAN: 9221120237041090560
// MAX: 9218868437227405311
// NEGZERO: -9223372036854775808
if (lhsBits < rhsBits) {
return -1;
} else {
return +1;
}
}
/**
* Compares two floats for order.
*
* This method is more comprehensive than the standard Java greater than,
* less than and equals operators.
*
* - It returns
-1 if the first value is less than the second.
* - It returns
+1 if the first value is greater than the second.
* - It returns
0 if the values are equal.
*
*
* The ordering is as follows, largest to smallest:
*
* - NaN
* - Positive infinity
* - Maximum float
* - Normal positive numbers
* - +0.0
* - -0.0
* - Normal negative numbers
* - Minimum float (
-Float.MAX_VALUE)
* - Negative infinity
*
*
* Comparing NaN with NaN will return
* 0.
*
* @param lhs the first float
* @param rhs the second float
* @return -1 if lhs is less, +1 if greater,
* 0 if equal to rhs
*/
public static int compare(float lhs, float rhs) {
if (lhs < rhs) {
return -1;
}
if (lhs > rhs) {
return +1;
}
//Need to compare bits to handle 0.0 == -0.0 being true
// compare should put -0.0 < +0.0
// Two NaNs are also == for compare purposes
// where NaN == NaN is false
int lhsBits = Float.floatToIntBits(lhs);
int rhsBits = Float.floatToIntBits(rhs);
if (lhsBits == rhsBits) {
return 0;
}
//Something exotic! A comparison to NaN or 0.0 vs -0.0
//Fortunately NaN's int is > than everything else
//Also negzeros bits < poszero
//NAN: 2143289344
//MAX: 2139095039
//NEGZERO: -2147483648
if (lhsBits < rhsBits) {
return -1;
} else {
return +1;
}
}
}