ager@google.com
9d93351ada
There is a bit of comment duplication in here, but I think it is worth it to have all the methods documented on api.dartlang.org for all the types. R=lrn@google.com BUG=dartbug.com/4668 Review URL: https://codereview.chromium.org//10959067 git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@12773 260f80e4-7a28-3924-810f-c04153c831b5
102 lines
3.1 KiB
Dart
102 lines
3.1 KiB
Dart
// Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
// TODO: Convert this abstract class into a concrete class double
|
|
// that uses the patch class functionality to account for the
|
|
// different platform implementations.
|
|
|
|
/**
|
|
* Representation of Dart doubles containing double specific constants
|
|
* and operations and specializations of operations inherited from
|
|
* [num].
|
|
*
|
|
* The [double] type is contagious. Operations on [double]s return
|
|
* [double] results.
|
|
*/
|
|
abstract class double extends num {
|
|
static const double NAN = 0.0 / 0.0;
|
|
static const double INFINITY = 1.0 / 0.0;
|
|
static const double NEGATIVE_INFINITY = -INFINITY;
|
|
|
|
/** Return the remainder from dividing this [double] by [other]. */
|
|
abstract double remainder(num other);
|
|
|
|
/** Addition operator. */
|
|
abstract double operator +(num other);
|
|
|
|
/** Subtraction operator. */
|
|
abstract double operator -(num other);
|
|
|
|
/** Multiplication operator. */
|
|
abstract double operator *(num other);
|
|
|
|
/** Euclidean modulo operator. */
|
|
abstract double operator %(num other);
|
|
|
|
/** Division operator. */
|
|
abstract double operator /(num other);
|
|
|
|
/**
|
|
* Truncating division operator.
|
|
*
|
|
* The result of the truncating division [:a ~/ b:] is equivalent to
|
|
* [:(a / b).truncate():].
|
|
*/
|
|
abstract double operator ~/(num other);
|
|
|
|
/** Negate operator. */
|
|
abstract double operator -();
|
|
|
|
/** Returns the absolute value of this [double]. */
|
|
abstract double abs();
|
|
|
|
/**
|
|
* Returns the integer value closest to this [double].
|
|
*
|
|
* Rounds away from zero when there is no closest integer:
|
|
* [:(3.5).round() == 4:] and [:(-3.5).round() == -4:].
|
|
*/
|
|
abstract double round();
|
|
|
|
/** Returns the greatest integer value no greater than this [double]. */
|
|
abstract double floor();
|
|
|
|
/** Returns the least integer value that is no smaller than this [double]. */
|
|
abstract double ceil();
|
|
|
|
/**
|
|
* Returns the integer value obtained by discarding any fractional
|
|
* digits from this [double].
|
|
*/
|
|
abstract double truncate();
|
|
|
|
/**
|
|
* Provide a representation of this [double] value.
|
|
*
|
|
* The representation is a number literal such that the closest double value
|
|
* to the representation's mathematical value is this [double].
|
|
*
|
|
* Returns "NaN" for the Not-a-Number value.
|
|
* Returns "Infinity" and "-Infinity" for positive and negative Infinity.
|
|
* Returns "-0.0" for negative zero.
|
|
*
|
|
* It should always be the case that if [:d:] is a [double], then
|
|
* [:d == double.parse(d.toString()):].
|
|
*/
|
|
abstract String toString();
|
|
|
|
/**
|
|
* Parse [source] as an double literal and return its value.
|
|
*
|
|
* Accepts the same format as double literals:
|
|
* [: ['+'|'-'] [digit* '.'] digit+ [('e'|'E') ['+'|'-'] digit+] :]
|
|
*
|
|
* Also recognizes "NaN", "Infinity" and "-Infinity" as inputs and
|
|
* returns the corresponding double value.
|
|
*
|
|
* Throws a [FormatException] if [source] is not a valid double literal.
|
|
*/
|
|
external static double parse(String source);
|
|
}
|