Returns a fixed-size list backed by the specified array, similar to Arrays#asList(Object[]). The list supports List#set(int, Object), but any attempt to set a value to null will result in a 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.

The returned list is serializable.

Parameters

backingArray:float[]

the array to back the list

Returns:List<Float>

a list view of the array

Compares the two specified float values using 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.

Parameters

a:float

the first float to compare

b:float

the second float to compare

Returns:int

the result of invoking Float#compare(float, float)

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:float[][]

zero or more float arrays

Returns:float[]

a single array containing all the values from the source arrays, in order

Returns the value nearest to value which is within the closed range [min..max].

If value is within the range [min..max], value is returned unchanged. If value is less than min, min is returned, and if value is greater than max, max is returned.

Parameters

value:float

the float value to constrain

min:float

the lower bound (inclusive) of the range to constrain value to

max:float

the upper bound (inclusive) of the range to constrain value to

Exceptions

IllegalArgumentException:

if min > max

Since

21.0

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

Parameters

array:float[]

an array of float values, possibly empty

target:float

a primitive float value

Returns:boolean

true if array[i] == target for some value of i

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:float[]

the source array

minLength:int

the minimum length the returned array must guarantee

padding:int

an extra amount to "grow" the array by if growth is necessary

Returns:float[]

an array containing the values of array, with guaranteed minimum length minLength

Exceptions

IllegalArgumentException:

if minLength or padding is negative

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

Java 8 users: use Float#hashCode(float) instead.

Parameters

value:float

a primitive float value

Returns:int

a hash code for the value

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:float[]

an array of float values, possibly empty

target:float

a primitive float value

Returns:int

the least index i for which array[i] == target, or -1 if no such index exists.

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 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:float[]

the array to search for the sequence target

target:float[]

the array to search for as a sub-sequence of array

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

Java 8 users: use Float#isFinite(float) instead.

Since

10.0

Returns a string containing the supplied float values, converted to strings as specified by 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 Float#toString(float) formats float differently in GWT. In the previous example, it returns the string "1-2-3".

Parameters

separator:String

the text that should appear between consecutive values in the resulting string (but not at the start or end)

array:float[]

an array of float values, possibly empty

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:float[]

an array of float values, possibly empty

target:float

a primitive float value

Returns:int

the greatest index i for which array[i] == target, or -1 if no such index exists.

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 Object#equals(Object) (since arrays support only identity equality), but it is consistent with Arrays#equals(float[], float[]).

Since

2.0

Returns the greatest value present in array, using the same rules of comparison as Math#max(float, float).

Parameters

array:float[]

a nonempty array of float values

Returns:float

the value present in array that is greater than or equal to every other value in the array

Annotations

@GwtIncompatible:Available in GWT! Annotation is to avoid conflict with GWT specialization of base class.

Exceptions

IllegalArgumentException:

if array is empty

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

Parameters

array:float[]

a nonempty array of float values

Returns:float

the value present in array that is less than or equal to every other value in the array

Annotations

@GwtIncompatible:Available in GWT! Annotation is to avoid conflict with GWT specialization of base class.

Exceptions

IllegalArgumentException:

if array is empty

Reverses the elements of array. This is equivalent to Collections.reverse(Floats.asList(array)), but is likely to be more efficient.

Since

23.1

Reverses the elements of array between fromIndex inclusive and toIndex exclusive. This is equivalent to Collections.reverse(Floats.asList(array).subList(fromIndex, toIndex)), but is likely to be more efficient.

Exceptions

IndexOutOfBoundsException:

if fromIndex < 0, toIndex > array.length, or toIndex > fromIndex

Since

23.1

Performs a right rotation of array of "distance" places, so that the first element is moved to index "distance", and the element at index i ends up at index (distance + i) mod array.length. This is equivalent to Collections.rotate(Floats.asList(array), distance), but is considerably faster and avoids allocation and garbage collection.

The provided "distance" may be negative, which will rotate left.

Since

32.0.0

Performs a right rotation of array between fromIndex inclusive and toIndex exclusive. This is equivalent to Collections.rotate(Floats.asList(array).subList(fromIndex, toIndex), distance), but is considerably faster and avoids allocations and garbage collection.

The provided "distance" may be negative, which will rotate left.

Exceptions

IndexOutOfBoundsException:

if fromIndex < 0, toIndex > array.length, or toIndex > fromIndex

Since

32.0.0

Sorts the elements of array in descending order.

Note that this method uses the total order imposed by Float#compare, which treats all NaN values as equal and 0.0 as greater than -0.0.

Since

23.1

Sorts the elements of array between fromIndex inclusive and toIndex exclusive in descending order.

Note that this method uses the total order imposed by Float#compare, which treats all NaN values as equal and 0.0 as greater than -0.0.

Since

23.1

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

Since

16.0

Returns an array containing each value of collection, converted to a float value in the manner of 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:Collection<? extends Number>

a collection of Number instances

Returns:float[]

an array containing the same values as collection, in the same order, converted to primitives

Exceptions

NullPointerException:

if collection or any of its elements is null

Since

1.0 (parameter was Collection<Float> before 12.0)

Parses the specified string as a single-precision floating point value. The ASCII character '-' ('\u002D') is recognized as the minus sign.

Unlike Float#parseFloat(String), this method returns null instead of throwing an exception if parsing fails. Valid inputs are exactly those accepted by Float#valueOf(String), except that leading and trailing whitespace is not permitted.

This implementation is likely to be faster than Float.parseFloat if many failures are expected.

Parameters

string:String

the string representation of a float value

Returns:Float

the floating point value represented by string, or null if string has a length of zero or cannot be parsed as a float value

Annotations

@J2ktIncompatible

@GwtIncompatible

@CheckForNull

Exceptions

NullPointerException:

if string is null

Since

14.0