Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (C) 2008 The Guava Authors
   *
   * Licensed 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 com.google.common.primitives;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkElementIndex;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkPositionIndexes;
 import static java.lang.Float.NEGATIVE_INFINITY;
 import static java.lang.Float.POSITIVE_INFINITY;
 
 
 import java.util.List;
Static utility methods pertaining to float primitives, that are not already found in either java.lang.Float or Arrays.

See the Guava User Guide article on primitive utilities.

Author(s):
Kevin Bourrillion
Since:
1.0
 
 @GwtCompatible(emulated = true)
 public final class Floats {
   private Floats() {}

  
The number of bytes required to represent a primitive float value.

Since:
10.0
 
   public static final int BYTES = . / .;

  
Returns a hash code for value; equal to the result of invoking ((Float) value).hashCode().

Parameters:
value a primitive float value
Returns:
a hash code for the value
 
   public static int hashCode(float value) {
     // TODO(kevinb): is there a better way, that's still gwt-safe?
     return ((Floatvalue).hashCode();
   }

  
Compares the two specified float values using java.lang.Float.compare(float,float). You may prefer to invoke that method directly; this method exists only for consistency with the other utilities in this package.

Note: this method simply delegates to the JDK method java.lang.Float.compare(float,float). It is provided for consistency with the other primitive types, whose compare methods were not added to the JDK until JDK 7.

Parameters:
a the first float to compare
b the second float to compare
Returns:
the result of invoking java.lang.Float.compare(float,float)
 
   public static int compare(float afloat b) {
     return Float.compare(ab);
   }

  
Returns true if value represents a real number. This is equivalent to, but not necessarily implemented as, !(Float.isInfinite(value) || Float.isNaN(value)).

Since:
10.0
 
   public static boolean isFinite(float value) {
     return  < value & value < ;
  }

  
Returns true if target is present as an element anywhere in array. Note that this always returns false when target is NaN.

Parameters:
array an array of float values, possibly empty
target a primitive float value
Returns:
true if array[i] == target for some value of i
  public static boolean contains(float[] arrayfloat target) {
    for (float value : array) {
      if (value == target) {
        return true;
      }
    }
    return false;
  }

  
Returns the index of the first appearance of the value target in array. Note that this always returns -1 when target is NaN.

Parameters:
array an array of float values, possibly empty
target a primitive float value
Returns:
the least index i for which array[i] == target, or -1 if no such index exists.
  public static int indexOf(float[] arrayfloat target) {
    return indexOf(arraytarget, 0, array.length);
  }
  // TODO(kevinb): consider making this public
  private static int indexOf(
      float[] arrayfloat targetint startint end) {
    for (int i = starti < endi++) {
      if (array[i] == target) {
        return i;
      }
    }
    return -1;
  }

  
Returns the start position of the first occurrence of the specified target within array, or -1 if there is no such occurrence.

More formally, returns the lowest index i such that java.util.Arrays.copyOfRange(array, i, i + target.length) contains exactly the same elements as target.

Note that this always returns -1 when target contains NaN.

Parameters:
array the array to search for the sequence target
target the array to search for as a sub-sequence of array
  public static int indexOf(float[] arrayfloat[] target) {
    checkNotNull(array"array");
    checkNotNull(target"target");
    if (target.length == 0) {
      return 0;
    }
    outer:
    for (int i = 0; i < array.length - target.length + 1; i++) {
      for (int j = 0; j < target.lengthj++) {
        if (array[i + j] != target[j]) {
          continue outer;
        }
      }
      return i;
    }
    return -1;
  }

  
Returns the index of the last appearance of the value target in array. Note that this always returns -1 when target is NaN.

Parameters:
array an array of float values, possibly empty
target a primitive float value
Returns:
the greatest index i for which array[i] == target, or -1 if no such index exists.
  public static int lastIndexOf(float[] arrayfloat target) {
    return lastIndexOf(arraytarget, 0, array.length);
  }
  // TODO(kevinb): consider making this public
  private static int lastIndexOf(
      float[] arrayfloat targetint startint end) {
    for (int i = end - 1; i >= starti--) {
      if (array[i] == target) {
        return i;
      }
    }
    return -1;
  }

  
Returns the least value present in array, using the same rules of comparison as java.lang.Math.min(float,float).

Parameters:
array a nonempty array of float values
Returns:
the value present in array that is less than or equal to every other value in the array
Throws:
java.lang.IllegalArgumentException if array is empty
  public static float min(float... array) {
    checkArgument(array.length > 0);
    float min = array[0];
    for (int i = 1; i < array.lengthi++) {
      min = Math.min(minarray[i]);
    }
    return min;
  }

  
Returns the greatest value present in array, using the same rules of comparison as java.lang.Math.min(float,float).

Parameters:
array a nonempty array of float values
Returns:
the value present in array that is greater than or equal to every other value in the array
Throws:
java.lang.IllegalArgumentException if array is empty
  public static float max(float... array) {
    checkArgument(array.length > 0);
    float max = array[0];
    for (int i = 1; i < array.lengthi++) {
      max = Math.max(maxarray[i]);
    }
    return max;
  }

  
Returns the values from each provided array combined into a single array. For example, concat(new float[] {a, b, new float[] {}, new float[] {c}} returns the array {a, b, c}.

Parameters:
arrays zero or more float arrays
Returns:
a single array containing all the values from the source arrays, in order
  public static float[] concat(float[]... arrays) {
    int length = 0;
    for (float[] array : arrays) {
      length += array.length;
    }
    float[] result = new float[length];
    int pos = 0;
    for (float[] array : arrays) {
      System.arraycopy(array, 0, resultposarray.length);
      pos += array.length;
    }
    return result;
  }
  private static final class FloatConverter
      extends Converter<StringFloatimplements Serializable {
    static final FloatConverter INSTANCE = new FloatConverter();
    @Override
    protected Float doForward(String value) {
      return Float.valueOf(value);
    }
    @Override
    protected String doBackward(Float value) {
      return value.toString();
    }
    @Override
    public String toString() {
      return "Floats.stringConverter()";
    }
    private Object readResolve() {
      return ;
    }
    private static final long serialVersionUID = 1;
  }

  
Returns a serializable converter object that converts between strings and floats using java.lang.Float.valueOf(java.lang.String) and java.lang.Float.toString().

Since:
16.0
  @Beta
  public static Converter<StringFloatstringConverter() {
    return .;
  }

  
Returns an array containing the same values as array, but guaranteed to be of a specified minimum length. If array already has a length of at least minLength, it is returned directly. Otherwise, a new array of size minLength + padding is returned, containing the values of array, and zeroes in the remaining places.

Parameters:
array the source array
minLength the minimum length the returned array must guarantee
padding an extra amount to "grow" the array by if growth is necessary
Returns:
an array containing the values of array, with guaranteed minimum length minLength
Throws:
java.lang.IllegalArgumentException if minLength or padding is negative
  public static float[] ensureCapacity(
      float[] arrayint minLengthint padding) {
    checkArgument(minLength >= 0, "Invalid minLength: %s"minLength);
    checkArgument(padding >= 0, "Invalid padding: %s"padding);
    return (array.length < minLength)
        ? copyOf(arrayminLength + padding)
        : array;
  }
  // Arrays.copyOf() requires Java 6
  private static float[] copyOf(float[] originalint length) {
    float[] copy = new float[length];
    System.arraycopy(original, 0, copy, 0, Math.min(original.lengthlength));
    return copy;
  }

  
Returns a string containing the supplied float values, converted to strings as specified by java.lang.Float.toString(float), and separated by separator. For example, join("-", 1.0f, 2.0f, 3.0f) returns the string "1.0-2.0-3.0".

Note that java.lang.Float.toString(float) formats float differently in GWT. In the previous example, it returns the string "1-2-3".

Parameters:
separator the text that should appear between consecutive values in the resulting string (but not at the start or end)
array an array of float values, possibly empty
  public static String join(String separatorfloat... array) {
    checkNotNull(separator);
    if (array.length == 0) {
      return "";
    }
    // For pre-sizing a builder, just get the right order of magnitude
    StringBuilder builder = new StringBuilder(array.length * 12);
    builder.append(array[0]);
    for (int i = 1; i < array.lengthi++) {
      builder.append(separator).append(array[i]);
    }
    return builder.toString();
  }

  
Returns a comparator that compares two float arrays lexicographically. That is, it compares, using compare(float,float)), the first pair of values that follow any common prefix, or when one array is a prefix of the other, treats the shorter array as the lesser. For example, [] < [1.0f] < [1.0f, 2.0f] < [2.0f].

The returned comparator is inconsistent with java.lang.Object.equals(java.lang.Object) (since arrays support only identity equality), but it is consistent with Arrays#equals(float[] , float[] ).

Since:
2.0
See also:
Lexicographical order article at Wikipedia
  public static Comparator<float[]> lexicographicalComparator() {
  }
  private enum LexicographicalComparator implements Comparator<float[]> {
    INSTANCE;
    @Override
    public int compare(float[] leftfloat[] right) {
      int minLength = Math.min(left.lengthright.length);
      for (int i = 0; i < minLengthi++) {
        int result = Floats.compare(left[i], right[i]);
        if (result != 0) {
          return result;
        }
      }
      return left.length - right.length;
    }
  }

  
Returns an array containing each value of collection, converted to a float value in the manner of java.lang.Number.floatValue().

Elements are copied from the argument collection as if by collection.toArray(). Calling this method is as thread-safe as calling that method.

Parameters:
collection a collection of Number instances
Returns:
an array containing the same values as collection, in the same order, converted to primitives
Throws:
java.lang.NullPointerException if collection or any of its elements is null
Since:
1.0 (parameter was Collection<Float> before 12.0)
  public static float[] toArray(Collection<? extends Numbercollection) {
    if (collection instanceof FloatArrayAsList) {
      return ((FloatArrayAsListcollection).toFloatArray();
    }
    Object[] boxedArray = collection.toArray();
    int len = boxedArray.length;
    float[] array = new float[len];
    for (int i = 0; i < leni++) {
      // checkNotNull for GWT (do not optimize)
      array[i] = ((NumbercheckNotNull(boxedArray[i])).floatValue();
    }
    return array;
  }

  
Returns a fixed-size list backed by the specified array, similar to Arrays#asList(Object[] ). The list supports java.util.List.set(int,java.lang.Object), but any attempt to set a value to null will result in a java.lang.NullPointerException.

The returned list maintains the values, but not the identities, of Float objects written to or read from it. For example, whether list.get(0) == list.get(0) is true for the returned list is unspecified.

The returned list may have unexpected behavior if it contains NaN, or if NaN is used as a parameter to any of its methods.

Parameters:
backingArray the array to back the list
Returns:
a list view of the array
  public static List<FloatasList(float... backingArray) {
    if (backingArray.length == 0) {
      return Collections.emptyList();
    }
    return new FloatArrayAsList(backingArray);
  }
  private static class FloatArrayAsList extends AbstractList<Float>
      implements RandomAccessSerializable {
    final float[] array;
    final int start;
    final int end;
    FloatArrayAsList(float[] array) {
      this(array, 0, array.length);
    }
    FloatArrayAsList(float[] arrayint startint end) {
      this. = array;
      this. = start;
      this. = end;
    }
    @Override public int size() {
      return  - ;
    }
    @Override public boolean isEmpty() {
      return false;
    }
    @Override public Float get(int index) {
      checkElementIndex(indexsize());
      return [ + index];
    }
    @Override public boolean contains(Object target) {
      // Overridden to prevent a ton of boxing
      return (target instanceof Float)
          && Floats.indexOf(, (Floattarget) != -1;
    }
    @Override public int indexOf(Object target) {
      // Overridden to prevent a ton of boxing
      if (target instanceof Float) {
        int i = Floats.indexOf(, (Floattarget);
        if (i >= 0) {
          return i - ;
        }
      }
      return -1;
    }
    @Override public int lastIndexOf(Object target) {
      // Overridden to prevent a ton of boxing
      if (target instanceof Float) {
        int i = Floats.lastIndexOf(, (Floattarget);
        if (i >= 0) {
          return i - ;
        }
      }
      return -1;
    }
    @Override public Float set(int indexFloat element) {
      checkElementIndex(indexsize());
      float oldValue = [ + index];
      // checkNotNull for GWT (do not optimize)
      [ + index] = checkNotNull(element);
      return oldValue;
    }
    @Override public List<FloatsubList(int fromIndexint toIndex) {
      int size = size();
      checkPositionIndexes(fromIndextoIndexsize);
      if (fromIndex == toIndex) {
        return Collections.emptyList();
      }
      return new FloatArrayAsList( + fromIndex + toIndex);
    }
    @Override public boolean equals(Object object) {
      if (object == this) {
        return true;
      }
      if (object instanceof FloatArrayAsList) {
        FloatArrayAsList that = (FloatArrayAsListobject;
        int size = size();
        if (that.size() != size) {
          return false;
        }
        for (int i = 0; i < sizei++) {
          if ([ + i] != that.array[that.start + i]) {
            return false;
          }
        }
        return true;
      }
      return super.equals(object);
    }
    @Override public int hashCode() {
      int result = 1;
      for (int i = i < i++) {
        result = 31 * result + Floats.hashCode([i]);
      }
      return result;
    }
    @Override public String toString() {
      StringBuilder builder = new StringBuilder(size() * 12);
      builder.append('[').append([]);
      for (int i =  + 1; i < i++) {
        builder.append(", ").append([i]);
      }
      return builder.append(']').toString();
    }
    float[] toFloatArray() {
      // Arrays.copyOfRange() is not available under GWT
      int size = size();
      float[] result = new float[size];
      System.arraycopy(result, 0, size);
      return result;
    }
    private static final long serialVersionUID = 0;
  }
New to GrepCode? Check out our FAQ X