mirror of
https://github.com/dart-lang/sdk
synced 2024-09-16 00:39:49 +00:00
Update num.compareTo
documentation.
Fixes #27924 BUG= http://dartbug.com/27924 R=lrn@google.com Review URL: https://codereview.chromium.org/2537813002 .
This commit is contained in:
parent
e0d350aa27
commit
db8782f6e6
|
@ -66,16 +66,40 @@ abstract class num implements Comparable<num> {
|
||||||
* but integers are equal to doubles if they have the same numerical
|
* but integers are equal to doubles if they have the same numerical
|
||||||
* value.
|
* value.
|
||||||
*
|
*
|
||||||
* For ordering, the double NaN value is considered equal to itself, and
|
* For doubles, the `compareTo` operation is different from the partial
|
||||||
* greater than any numeric value (unlike its behavior in `operator==`).
|
* ordering given by [operator==], [operator<] and [operator>]. For example,
|
||||||
|
* IEEE doubles impose that `0.0 == -0.0` and all comparison operations on
|
||||||
|
* NaN return false.
|
||||||
*
|
*
|
||||||
* The double value -0.0 is considered less than 0.0 (and the integer 0), but
|
* This function imposes a complete ordering for doubles. When using
|
||||||
* greater than any non-zero negative value.
|
* `compareTo` the following properties hold:
|
||||||
*
|
*
|
||||||
* Positive infinity is greater than any finite value (any value apart from
|
* - All NaN values are considered equal, and greater than any numeric value.
|
||||||
* itself and NaN), and negative infinity is less than any other value.
|
* - -0.0 is less than 0.0 (and the integer 0), but greater than any non-zero
|
||||||
|
* negative value.
|
||||||
|
* - Negative infinity is less than all other values and positive infinity is
|
||||||
|
* greater than all non-NaN values.
|
||||||
|
* - All other values are compared using their numeric value.
|
||||||
*
|
*
|
||||||
* All other values are compared using their numeric value.
|
* Examples:
|
||||||
|
* ```
|
||||||
|
* print(1.compareTo(2)); // => -1
|
||||||
|
* print(2.compareTo(1)); // => 1
|
||||||
|
* print(1.compareTo(1)); // => 0
|
||||||
|
*
|
||||||
|
* // The following comparisons yield different results than the
|
||||||
|
* // corresponding comparison operators.
|
||||||
|
* print((-0.0).compareTo(0.0)); // => -1
|
||||||
|
* print(double.NAN.compareTo(double.NAN)); // => 0
|
||||||
|
* print(double.INFINITY.compareTo(double.NAN)); // => -1
|
||||||
|
*
|
||||||
|
* // -0.0, and NaN comparison operators have rules imposed by the IEEE
|
||||||
|
* // standard.
|
||||||
|
* print(-0.0 == 0.0); // => true
|
||||||
|
* print(double.NAN == double.NAN); // => false
|
||||||
|
* print(double.INFINITY < double.NAN); // => false
|
||||||
|
* print(double.NAN < double.INFINITY); // => false
|
||||||
|
* print(double.NAN == double.INFINITY); // => false
|
||||||
*/
|
*/
|
||||||
int compareTo(num other);
|
int compareTo(num other);
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue