sdk/lib/math/base.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.

// A part of the dart:math library.

/**
 * Base of the natural logarithms.
 */
final double E = 2.718281828459045;

/**
 * Natural logarithm of 10.
 */
final double LN10 =  2.302585092994046;

/**
 * Natural logarithm of 2.
 */
final double LN2 =  0.6931471805599453;

/**
 * Base-2 logarithm of E.
 */
final double LOG2E = 1.4426950408889634;

/**
 * Base-10 logarithm of E.
 */
final double LOG10E = 0.4342944819032518;

/**
 * The PI constant.
 */
final double PI = 3.1415926535897932;

/**
 * Square root of 1/2.
 */
final double SQRT1_2 = 0.7071067811865476;

/**
 * Square root of 2.
 */
final double SQRT2 = 1.4142135623730951;

/**
 * Parses a [String] representation of an [int], and returns an [int]. Throws a
 * [FormatException] if [str] cannot be parsed as an [int].
 */
external int parseInt(String str);

/**
 * Parses a [String] representation of a [double], and returns a [double].
 * Throws a [FormatException] if [str] cannot be parsed as a [double].
 */
external double parseDouble(String str);

/**
  * Returns the minimum of two numbers. If either argument is NaN returns NaN.
  * The minimum of [:-0.0:] and [:0.0:] is [:-0.0:]. If both arguments are
  * equal (int and doubles with the same mathematical value are equal) then
  * it is unspecified which of the two arguments is returned.
  */
num min(num a, num b) {
  if (a is num) {
    // TODO(floitsch): merge this if into the previous one, once dart2js
    // correctly propagates types for logical ands.
    if (b is num) {
      if (a > b) return b;
      if (a < b) return a;
      if (b is double) {
        // Special case for NaN and -0.0. If one argument is NaN return NaN.
        // [min] must also distinguish between -0.0 and 0.0.
        if (a is double) {
          if (a == 0.0) {
            // a is either 0.0 or -0.0. b is either 0.0, -0.0 or NaN.
            // The following returns -0.0 if either a or b is -0.0, and it
            // returns NaN if b is NaN.
            return (a + b) * a * b;
          }
        }
        // Check for NaN and b == -0.0.
        if (a == 0 && b.isNegative() || b.isNaN()) return b;
        return a;
      }
      return a;
    }
    throw new IllegalArgumentException(b);
  }
  throw new IllegalArgumentException(a);
}

/**
  * Returns the maximum of two numbers. If either argument is NaN returns NaN.
  * The maximum of [:-0.0:] and [:0.0:] is [:0.0:]. If both arguments are
  * equal (int and doubles with the same mathematical value are equal) then
  * it is unspecified which of the two arguments is returned.
  */
num max(num a, num b) {
  if (a is num) {
    // TODO(floitsch): merge this if into the previous one, once dart2js
    // correctly propagates types for logical ands.
    if (b is num) {
      if (a > b) return a;
      if (a < b) return b;
      if (b is double) {
        // Special case for NaN and -0.0. If one argument is NaN return NaN.
        // [max] must also distinguish between -0.0 and 0.0.
        if (a is double) {
          if (a == 0.0) {
            // a is either 0.0 or -0.0. b is either 0.0, -0.0, or NaN.
            // The following returns 0.0 if either a or b is 0.0, and it
            // returns NaN if b is NaN.
            return a + b;
          }
        }
        // Check for NaN.
        if (b.isNaN()) return b;
        return a;
      }
      // max(-0.0, 0) must return 0.
      if (b == 0 && a.isNegative()) return b;
      return a;
    }
    throw new IllegalArgumentException(b);
  }
  throw new IllegalArgumentException(a);
}

/**
 * Returns the arc tangent of [a]/[b] with sign according to quadrant.
 */
external double atan2(num a, num b);

/**
 * If the [exponent] is an integer the result is of the same type as [x].
 * Otherwise it is a [double].
 */
external num pow(num x, num exponent);

// TODO(4512): Add documentation.
external double sin(num x);
external double cos(num x);
external double tan(num x);
external double acos(num x);
external double asin(num x);
external double atan(num x);
external double sqrt(num x);
external double exp(num x);
external double log(num x);