Partager via


Float.CompareTo(Float) Method

Definition

Compares two Float objects numerically.

[Android.Runtime.Register("compareTo", "(Ljava/lang/Float;)I", "")]
public int CompareTo (Java.Lang.Float anotherFloat);
[<Android.Runtime.Register("compareTo", "(Ljava/lang/Float;)I", "")>]
member this.CompareTo : Java.Lang.Float -> int

Parameters

anotherFloat
Float

the Float to be compared.

Returns

the value 0 if anotherFloat is numerically equal to this Float; a value less than 0 if this Float is numerically less than anotherFloat; and a value greater than 0 if this Float is numerically greater than anotherFloat.

Attributes

Remarks

Compares two Float objects numerically.

This method imposes a total order on Float objects with two differences compared to the incomplete order defined by the Java language numerical comparison operators (<, <=, ==, >=, >) on float values.

<ul><li> A NaN is <em>unordered</em> with respect to other values and unequal to itself under the comparison operators. This method chooses to define Float.NaN to be equal to itself and greater than all other double values (including Float.POSITIVE_INFINITY).

<li> Positive zero and negative zero compare equal numerically, but are distinct and distinguishable values. This method chooses to define positive zero (+0.0f), to be greater than negative zero (-0.0f). </ul>

This ensures that the natural ordering of Float objects imposed by this method is consistent with equals; see this discussion for details of floating-point comparison and ordering.

Added in 1.2.

Java documentation for java.lang.Float.compareTo(java.lang.Float).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

See also