Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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.
  */
 package org.apache.commons.lang.math;
 

FloatRange represents an inclusive range of floats.

Author(s):
Stephen Colebourne
Version:
$Id: FloatRange.java 437554 2006-08-28 06:21:41Z bayard $
Since:
2.0
 
 public final class FloatRange extends Range implements Serializable {
    
    
Required for serialization support.

 
     private static final long serialVersionUID = 71849363892750L;

    
The minimum number in this range (inclusive).
 
     private final float min;
    
The maximum number in this range (inclusive).
 
     private final float max;
    
    
Cached output minObject (class is immutable).
 
     private transient Float minObject = null;
    
Cached output maxObject (class is immutable).
 
     private transient Float 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 FloatRange using the specified number as both the minimum and maximum in this range.

Parameters:
number the number to use for this range
Throws:
java.lang.IllegalArgumentException if the number is NaN
 
     public FloatRange(float number) {
         super();
         if (Float.isNaN(number)) {
             throw new IllegalArgumentException("The number must not be NaN");
         }
         this.min = number;
         this.max = number;
     }

    

Constructs a new FloatRange using the specified number as both the minimum and maximum in this range.

Parameters:
number the number to use for this range, must not be null
Throws:
java.lang.IllegalArgumentException if the number is null
java.lang.IllegalArgumentException if the number is NaN
 
     public FloatRange(Number number) {
         super();
         if (number == null) {
             throw new IllegalArgumentException("The number must not be null");
         }
         this.min = number.floatValue();
         this.max = number.floatValue();
         if (Float.isNaN(min) || Float.isNaN(max)) {
             throw new IllegalArgumentException("The number must not be NaN");
         }
         if (number instanceof Float) {
             this.minObject = (Float) number;
            this.maxObject = (Float) number;
        }
    }

    

Constructs a new FloatRange 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.

Parameters:
number1 first number that defines the edge of the range, inclusive
number2 second number that defines the edge of the range, inclusive
Throws:
java.lang.IllegalArgumentException if either number is NaN
    public FloatRange(float number1float number2) {
        super();
        if (Float.isNaN(number1) || Float.isNaN(number2)) {
            throw new IllegalArgumentException("The numbers must not be NaN");
        }
        if (number2 < number1) {
            this.min = number2;
            this.max = number1;
        } else {
            this.min = number1;
            this.max = number2;
        }
    }

    

Constructs a new FloatRange 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.

Parameters:
number1 first number that defines the edge of the range, inclusive
number2 second number that defines the edge of the range, inclusive
Throws:
java.lang.IllegalArgumentException if either number is null
java.lang.IllegalArgumentException if either number is NaN
    public FloatRange(Number number1Number number2) {
        super();
        if (number1 == null || number2 == null) {
            throw new IllegalArgumentException("The numbers must not be null");
        }
        float number1val = number1.floatValue();
        float number2val = number2.floatValue();
        if (Float.isNaN(number1val) || Float.isNaN(number2val)) {
            throw new IllegalArgumentException("The numbers must not be NaN");
        }
        if (number2val < number1val) {
            this.min = number2val;
            this.max = number1val;
            if (number2 instanceof Float) {
                this.minObject = (Float) number2;
            }
            if (number1 instanceof Float) {
                this.maxObject = (Float) number1;
            }
        } else {
            this.min = number1val;
            this.max = number2val;
            if (number1 instanceof Float) {
                this.minObject = (Float) number1;
            }
            if (number2 instanceof Float) {
                this.maxObject = (Float) number2;
            }
        }
    }
    // Accessors
    //--------------------------------------------------------------------

    

Returns the minimum number in this range.

Returns:
the minimum number in this range
    public Number getMinimumNumber() {
        if (minObject == null) {
            minObject = new Float(min);            
        }
        return minObject;
    }

    

Gets the minimum number in this range as a long.

This conversion can lose information for large values or decimals.

Returns:
the minimum number in this range
    public long getMinimumLong() {
        return (long) min;
    }

    

Gets the minimum number in this range as a int.

This conversion can lose information for large values or decimals.

Returns:
the minimum number in this range
    public int getMinimumInteger() {
        return (int) min;
    }

    

Gets the minimum number in this range as a double.

Returns:
the minimum number in this range
    public double getMinimumDouble() {
        return min;
    }

    

Gets the minimum number in this range as a float.

Returns:
the minimum number in this range
    public float getMinimumFloat() {
        return min;
    }

    

Returns the maximum number in this range.

Returns:
the maximum number in this range
    public Number getMaximumNumber() {
        if (maxObject == null) {
            maxObject = new Float(max);            
        }
        return maxObject;
    }

    

Gets the maximum number in this range as a long.

This conversion can lose information for large values or decimals.

Returns:
the maximum number in this range
    public long getMaximumLong() {
        return (long) max;
    }

    

Gets the maximum number in this range as a int.

This conversion can lose information for large values or decimals.

Returns:
the maximum number in this range
    public int getMaximumInteger() {
        return (int) max;
    }

    

Gets the maximum number in this range as a double.

Returns:
the maximum number in this range
    public double getMaximumDouble() {
        return max;
    }

    

Gets the maximum number in this range as a float.

Returns:
the maximum number in this range
    public float getMaximumFloat() {
        return max;
    }
    // Tests
    //--------------------------------------------------------------------
    
    

Tests whether the specified number occurs within this range using float comparison.

null is handled and returns false.

Parameters:
number the number to test, may be null
Returns:
true if the specified number occurs within this range
    public boolean containsNumber(Number number) {
        if (number == null) {
            return false;
        }
        return containsFloat(number.floatValue());
    }

    

Tests whether the specified float occurs within this range using float comparison.

This implementation overrides the superclass for performance as it is the most common case.

Parameters:
value the float to test
Returns:
true if the specified number occurs within this range by float comparison
    public boolean containsFloat(float value) {
        return value >= min && value <= max;
    }
    // Range tests
    //--------------------------------------------------------------------

    

Tests whether the specified range occurs entirely within this range using float comparison.

null is handled and returns false.

Parameters:
range the range to test, may be null
Returns:
true if the specified range occurs entirely within this range
Throws:
java.lang.IllegalArgumentException if the range is not of this type
    public boolean containsRange(Range range) {
        if (range == null) {
            return false;
        }
        return containsFloat(range.getMinimumFloat()) &&
               containsFloat(range.getMaximumFloat());
    }

    

Tests whether the specified range overlaps with this range using float comparison.

null is handled and returns false.

Parameters:
range the range to test, may be null
Returns:
true if the specified range overlaps with this range
    public boolean overlapsRange(Range range) {
        if (range == null) {
            return false;
        }
        return range.containsFloat(min) ||
               range.containsFloat(max) || 
               containsFloat(range.getMinimumFloat());
    }
    // Basics
    //--------------------------------------------------------------------

    

Compares this range to another object to test if they are equal.

.

To be equal, the class, minimum and maximum must be equal.

Parameters:
obj the reference object with which to compare
Returns:
true if this object is equal
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (obj instanceof FloatRange == false) {
            return false;
        }
        FloatRange range = (FloatRange) obj;
        return (Float.floatToIntBits(min) == Float.floatToIntBits(range.min) &&
                Float.floatToIntBits(max) == Float.floatToIntBits(range.max));
    }

    

Gets a hashCode for the range.

Returns:
a hash code value for this object
    public int hashCode() {
        if (hashCode == 0) {
            hashCode = 17;
            hashCode = 37 * hashCode + getClass().hashCode();
            hashCode = 37 * hashCode + Float.floatToIntBits(min);
            hashCode = 37 * hashCode + Float.floatToIntBits(max);
        }
        return hashCode;
    }

    

Gets the range as a String.

The format of the String is 'Range[min,max]'.

Returns:
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;
    }
New to GrepCode? Check out our FAQ X