Class Floats
- java.lang.Object
-
- com.google.common.primitives.Floats
-
@GwtCompatible(emulated=true) @Deprecated(since="2022-12-01") public final class Floats extends java.lang.Object
Deprecated.The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023Static utility methods pertaining tofloat
primitives, that are not already found in eitherFloat
orArrays
.See the Guava User Guide article on primitive utilities.
- Since:
- 1.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
BYTES
Deprecated.The number of bytes required to represent a primitivefloat
value.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.util.List<java.lang.Float>
asList(float... backingArray)
Deprecated.Returns a fixed-size list backed by the specified array, similar toArrays.asList(Object[])
.static int
compare(float a, float b)
Deprecated.Compares the two specifiedfloat
values usingFloat.compare(float, float)
.static float[]
concat(float[]... arrays)
Deprecated.Returns the values from each provided array combined into a single array.static boolean
contains(float[] array, float target)
Deprecated.Returnstrue
iftarget
is present as an element anywhere inarray
.static float[]
ensureCapacity(float[] array, int minLength, int padding)
Deprecated.Returns an array containing the same values asarray
, but guaranteed to be of a specified minimum length.static int
hashCode(float value)
Deprecated.Returns a hash code forvalue
; equal to the result of invoking((Float) value).hashCode()
.static int
indexOf(float[] array, float target)
Deprecated.Returns the index of the first appearance of the valuetarget
inarray
.static int
indexOf(float[] array, float[] target)
Deprecated.Returns the start position of the first occurrence of the specifiedtarget
withinarray
, or-1
if there is no such occurrence.static boolean
isFinite(float value)
Deprecated.Returnstrue
ifvalue
represents a real number.static java.lang.String
join(java.lang.String separator, float... array)
Deprecated.Returns a string containing the suppliedfloat
values, converted to strings as specified byFloat.toString(float)
, and separated byseparator
.static int
lastIndexOf(float[] array, float target)
Deprecated.Returns the index of the last appearance of the valuetarget
inarray
.static java.util.Comparator<float[]>
lexicographicalComparator()
Deprecated.Returns a comparator that compares twofloat
arrays lexicographically.static float
max(float... array)
Deprecated.Returns the greatest value present inarray
, using the same rules of comparison asMath.min(float, float)
.static float
min(float... array)
Deprecated.Returns the least value present inarray
, using the same rules of comparison asMath.min(float, float)
.static float[]
toArray(java.util.Collection<? extends java.lang.Number> collection)
Deprecated.Returns an array containing each value ofcollection
, converted to afloat
value in the manner ofNumber.floatValue()
.static java.lang.Float
tryParse(java.lang.String string)
Deprecated.Parses the specified string as a single-precision floating point value.
-
-
-
Field Detail
-
BYTES
public static final int BYTES
Deprecated.The number of bytes required to represent a primitivefloat
value.- Since:
- 10.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
hashCode
public static int hashCode(float value)
Deprecated.Returns a hash code forvalue
; equal to the result of invoking((Float) value).hashCode()
.- Parameters:
value
- a primitivefloat
value- Returns:
- a hash code for the value
-
compare
public static int compare(float a, float b)
Deprecated.Compares the two specifiedfloat
values usingFloat.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
- the firstfloat
to compareb
- the secondfloat
to compare- Returns:
- the result of invoking
Float.compare(float, float)
-
isFinite
public static boolean isFinite(float value)
Deprecated.Returnstrue
ifvalue
represents a real number. This is equivalent to, but not necessarily implemented as,!(Float.isInfinite(value) || Float.isNaN(value))
.- Since:
- 10.0
-
contains
public static boolean contains(float[] array, float target)
Deprecated.Returnstrue
iftarget
is present as an element anywhere inarray
. Note that this always returnsfalse
whentarget
isNaN
.- Parameters:
array
- an array offloat
values, possibly emptytarget
- a primitivefloat
value- Returns:
true
ifarray[i] == target
for some value ofi
-
indexOf
public static int indexOf(float[] array, float target)
Deprecated.Returns the index of the first appearance of the valuetarget
inarray
. Note that this always returns-1
whentarget
isNaN
.- Parameters:
array
- an array offloat
values, possibly emptytarget
- a primitivefloat
value- Returns:
- the least index
i
for whicharray[i] == target
, or-1
if no such index exists.
-
indexOf
public static int indexOf(float[] array, float[] target)
Deprecated.Returns the start position of the first occurrence of the specifiedtarget
withinarray
, or-1
if there is no such occurrence.More formally, returns the lowest index
i
such thatjava.util.Arrays.copyOfRange(array, i, i + target.length)
contains exactly the same elements astarget
.Note that this always returns
-1
whentarget
containsNaN
.- Parameters:
array
- the array to search for the sequencetarget
target
- the array to search for as a sub-sequence ofarray
-
lastIndexOf
public static int lastIndexOf(float[] array, float target)
Deprecated.Returns the index of the last appearance of the valuetarget
inarray
. Note that this always returns-1
whentarget
isNaN
.- Parameters:
array
- an array offloat
values, possibly emptytarget
- a primitivefloat
value- Returns:
- the greatest index
i
for whicharray[i] == target
, or-1
if no such index exists.
-
min
public static float min(float... array)
Deprecated.Returns the least value present inarray
, using the same rules of comparison asMath.min(float, float)
.- Parameters:
array
- a nonempty array offloat
values- Returns:
- the value present in
array
that is less than or equal to every other value in the array - Throws:
java.lang.IllegalArgumentException
- ifarray
is empty
-
max
public static float max(float... array)
Deprecated.Returns the greatest value present inarray
, using the same rules of comparison asMath.min(float, float)
.- Parameters:
array
- a nonempty array offloat
values- Returns:
- the value present in
array
that is greater than or equal to every other value in the array - Throws:
java.lang.IllegalArgumentException
- ifarray
is empty
-
concat
public static float[] concat(float[]... arrays)
Deprecated.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 morefloat
arrays- Returns:
- a single array containing all the values from the source arrays, in order
-
ensureCapacity
public static float[] ensureCapacity(float[] array, int minLength, int padding)
Deprecated.Returns an array containing the same values asarray
, but guaranteed to be of a specified minimum length. Ifarray
already has a length of at leastminLength
, it is returned directly. Otherwise, a new array of sizeminLength + padding
is returned, containing the values ofarray
, and zeroes in the remaining places.- Parameters:
array
- the source arrayminLength
- the minimum length the returned array must guaranteepadding
- an extra amount to "grow" the array by if growth is necessary- Returns:
- an array containing the values of
array
, with guaranteed minimum lengthminLength
- Throws:
java.lang.IllegalArgumentException
- ifminLength
orpadding
is negative
-
join
public static java.lang.String join(java.lang.String separator, float... array)
Deprecated.Returns a string containing the suppliedfloat
values, converted to strings as specified byFloat.toString(float)
, and separated byseparator
. For example,join("-", 1.0f, 2.0f, 3.0f)
returns the string"1.0-2.0-3.0"
.Note that
Float.toString(float)
formatsfloat
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 offloat
values, possibly empty
-
lexicographicalComparator
public static java.util.Comparator<float[]> lexicographicalComparator()
Deprecated.Returns a comparator that compares twofloat
arrays lexicographically. That is, it compares, usingcompare(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 withArrays.equals(float[], float[])
.- Since:
- 2.0
- See Also:
- Lexicographical order article at Wikipedia
-
toArray
public static float[] toArray(java.util.Collection<? extends java.lang.Number> collection)
Deprecated.Returns an array containing each value ofcollection
, converted to afloat
value in the manner ofNumber.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 ofNumber
instances- Returns:
- an array containing the same values as
collection
, in the same order, converted to primitives - Throws:
java.lang.NullPointerException
- ifcollection
or any of its elements is null- Since:
- 1.0 (parameter was
Collection<Float>
before 12.0)
-
asList
public static java.util.List<java.lang.Float> asList(float... backingArray)
Deprecated.Returns a fixed-size list backed by the specified array, similar toArrays.asList(Object[])
. The list supportsList.set(int, Object)
, but any attempt to set a value tonull
will result in aNullPointerException
.The returned list maintains the values, but not the identities, of
Float
objects written to or read from it. For example, whetherlist.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 ifNaN
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
-
tryParse
@GwtIncompatible("regular expressions") @Nullable @Beta public static java.lang.Float tryParse(java.lang.String string)
Deprecated.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 returnsnull
instead of throwing an exception if parsing fails. Valid inputs are exactly those accepted byFloat.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
- the string representation of afloat
value- Returns:
- the floating point value represented by
string
, ornull
ifstring
has a length of zero or cannot be parsed as afloat
value - Since:
- 14.0
-
-