@tellahq/rescript 10.1.0-alpha.1

package/lib/ocaml/js_math.ml

@@ -0,0 +1,626 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(**
+  Provide utilities for JS Math. Note: The constants `_E`, `_LN10`, `_LN2`,
+  `_LOG10E`, `_LOG2E`, `_PI`, `_SQRT1_2`, and `_SQRT2` begin with an underscore
+  because ReScript variable names cannot begin with a capital letter. (Module
+  names begin with upper case.)
+*)
+
+(**
+  Euler's number; ≈ 2.718281828459045. See
+  [`Math.E`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/E)
+  on MDN.
+*)
+external _E : float = "E" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Natural logarithm of 2; ≈ 0.6931471805599453. See
+  [`Math.LN2`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/LN2)
+  on MDN.
+*)
+external _LN2 : float = "LN2" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Natural logarithm of 10; ≈ 2.302585092994046. See
+  [`Math.LN10`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/LN10)
+  on MDN.
+*)
+external _LN10 : float = "LN10" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Base 2 logarithm of E; ≈ 1.4426950408889634. See
+  [`Math.LOG2E`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/LOG2E)
+  on MDN.
+*)
+external _LOG2E : float = "LOG2E" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Base 10 logarithm of E; ≈ 0.4342944819032518. See
+  [`Math.LOG10E`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/LOG10E)
+  on MDN.
+*)
+external _LOG10E : float = "LOG10E" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Pi - ratio of the circumference to the diameter of a circle; ≈ 3.141592653589793. See
+  [`Math.PI`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/PI)
+  on MDN.
+*)
+external _PI : float = "PI" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Square root of 1/2; ≈ 0.7071067811865476. See
+  [`Math.SQRT1_2`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/SQRT1_2)
+  on MDN.
+*)
+external _SQRT1_2 : float = "SQRT1_2" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Square root of 2; ≈ 1.4142135623730951. See
+  [`Math.SQRT2`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/SQRT2)
+  on MDN.
+*)
+external _SQRT2 : float = "SQRT2" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Absolute value for integer argument. See
+  [`Math.abs`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/abs)
+  on MDN.
+*)
+external abs_int : int -> int = "abs" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Absolute value for float argument. See
+  [`Math.abs`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/abs)
+  on MDN.
+*)
+external abs_float : float -> float = "abs" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Arccosine (in radians) of argument; returns `NaN` if the argument is outside
+  the range [-1.0, 1.0]. See
+  [`Math.acos`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/acos)
+  on MDN.
+*)
+external acos : float -> float = "acos" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Hyperbolic arccosine (in radians) of argument; returns `NaN` if the argument
+  is less than 1.0. See
+  [`Math.acosh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/acosh)
+  on MDN.
+*)
+external acosh : float -> float = "acosh" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Arcsine (in radians) of argument; returns `NaN` if the argument is outside
+  the range [-1.0, 1.0]. See
+  [`Math.asin`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/asin)
+  on MDN.
+*)
+external asin : float -> float = "asin" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Hyperbolic arcsine (in radians) of argument. See
+  [`Math.asinh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/asinh)
+  on MDN.
+*)
+external asinh : float -> float = "asinh" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Arctangent (in radians) of argument. See
+  [`Math.atan`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atan)
+  on MDN.
+*)
+external atan : float -> float = "atan" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Hyperbolic arctangent (in radians) of argument; returns `NaN` if the argument
+  is is outside the range [-1.0, 1.0]. Returns `-Infinity` and `Infinity` for
+  arguments -1.0 and 1.0. See
+  [`Math.atanh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atanh)
+  on MDN.
+*)
+external atanh : float -> float = "atanh" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the angle (in radians) of the quotient `y /. x`. It is also the angle
+  between the *x*-axis and point (*x*, *y*). See
+  [`Math.atan2`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atan2)
+  on MDN.
+
+  ```res example
+  Js.Math.atan2(~y=0.0, ~x=10.0, ()) == 0.0
+  Js.Math.atan2(~x=5.0, ~y=5.0, ()) == Js.Math._PI /. 4.0
+  Js.Math.atan2(~x=-5.0, ~y=5.0, ())
+  Js.Math.atan2(~x=-5.0, ~y=5.0, ()) == 3.0 *. Js.Math._PI /. 4.0
+  Js.Math.atan2(~x=-0.0, ~y=-5.0, ()) == -.Js.Math._PI /. 2.0
+  ```
+*)
+external atan2 : y:float -> x:float -> unit -> float = "atan2" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Cube root. See
+  [`Math.cbrt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/cbrt)
+  on MDN
+*)
+external cbrt : float -> float = "cbrt" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the smallest integer greater than or equal to the argument. This
+  function may return values not representable by `int`, whose range is
+  -2147483648 to 2147483647. This is because, in JavaScript, there are only
+  64-bit floating point numbers, which can represent integers in the range
+  ±(2<sup>53</sup>-1) exactly. See
+  [`Math.ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil)
+  on MDN.
+
+  ```res example
+  Js.Math.unsafe_ceil_int(3.1) == 4
+  Js.Math.unsafe_ceil_int(3.0) == 3
+  Js.Math.unsafe_ceil_int(-3.1) == -3
+  Js.Math.unsafe_ceil_int(1.0e15) // result is outside range of int datatype
+  ```
+*)
+external unsafe_ceil_int : float -> int = "ceil" [@@bs.val] [@@bs.scope "Math"]
+
+(** Deprecated; please use [`unsafe_ceil_int`](#unsafe_ceil_int) instead. *)
+let unsafe_ceil = unsafe_ceil_int
+[@@deprecated "Please use `unsafe_ceil_int` instead"]
+
+(**
+  Returns the smallest `int` greater than or equal to the argument; the result
+  is pinned to the range of the `int` data type: -2147483648 to 2147483647. See
+  [`Math.ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil)
+  on MDN.
+
+  ```res example
+  Js.Math.ceil_int(3.1) == 4
+  Js.Math.ceil_int(3.0) == 3
+  Js.Math.ceil_int(-3.1) == -3
+  Js.Math.ceil_int(-1.0e15) == -2147483648
+  Js.Math.ceil_int(1.0e15) == 2147483647
+  ```
+*)
+let ceil_int (f : float) : int =
+  if f > Js_int.toFloat Js_int.max then Js_int.max
+  else if f < Js_int.toFloat Js_int.min then Js_int.min
+  else unsafe_ceil_int f
+
+(** Deprecated; please use [`ceil_int`](#ceil_int) instead. *)
+let ceil = ceil_int
+[@@deprecated "Please use `ceil_int` instead"]
+
+(**
+  Returns the smallest integral value greater than or equal to the argument.
+  The result is a `float` and is not restricted to the `int` data type range.
+  See
+  [`Math.ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil)
+  on MDN.
+
+  ```res example
+  Js.Math.ceil_float(3.1) == 4.0
+  Js.Math.ceil_float(3.0) == 3.0
+  Js.Math.ceil_float(-3.1) == -3.0
+  Js.Math.ceil_float(2_150_000_000.3) == 2_150_000_001.0
+  ```
+*)
+external ceil_float : float -> float = "ceil" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Number of leading zero bits of the argument's 32 bit int representation. See
+  [`Math.clz32`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/clz32)
+  on MDN.
+
+  ```res example
+  Js.Math.clz32(0) == 32
+  Js.Math.clz32(-1) == 0
+  Js.Math.clz32(255) == 24
+  ```
+*)
+external clz32 : int -> int = "clz32" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Cosine of argument, which must be specified in radians. See
+  [`Math.cos`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/cos)
+  on MDN.
+*)
+external cos : float -> float = "cos" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Hyperbolic cosine of argument, which must be specified in radians. See
+  [`Math.cosh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/cosh)
+  on MDN.
+*)
+external cosh : float -> float = "cosh" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Natural exponentional; returns *e* (the base of natural logarithms) to the
+  power of the given argument. See
+  [`Math.exp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/exp)
+  on MDN.
+*)
+external exp : float -> float = "exp" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns *e* (the base of natural logarithms) to the power of the given
+  argument minus 1. See
+  [`Math.expm1`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/expm1)
+  on MDN.
+*)
+external expm1 : float -> float = "expm1" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the largest integer less than or equal to the argument. This function
+  may return values not representable by `int`, whose range is -2147483648 to
+  2147483647. This is because, in JavaScript, there are only 64-bit floating
+  point numbers, which can represent integers in the range
+  ±(2<sup>53</sup>-1) exactly. See
+  [`Math.floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor)
+  on MDN.
+
+  ```res example
+  Js.Math.unsafe_floor_int(3.7) == 3
+  Js.Math.unsafe_floor_int(3.0) == 3
+  Js.Math.unsafe_floor_int(-3.7) == -4
+  Js.Math.unsafe_floor_int(1.0e15) // result is outside range of int datatype
+  ```
+*)
+external unsafe_floor_int : float -> int = "floor" [@@bs.val] [@@bs.scope "Math"]
+
+(** Deprecated; please use [`unsafe_floor_int`](#unsafe_floor_int) instead. *)
+let unsafe_floor = unsafe_floor_int
+[@@deprecated "Please use `unsafe_floor_int` instead"]
+
+(**
+  Returns the largest `int` less than or equal to the argument; the result is
+  pinned to the range of the `int` data type: -2147483648 to 2147483647. See
+  [`Math.floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor)
+  on MDN.
+
+  ```res example
+  Js.Math.floor_int(3.7) == 3
+  Js.Math.floor_int(3.0) == 3
+  Js.Math.floor_int(-3.1) == -4
+  Js.Math.floor_int(-1.0e15) == -2147483648
+  Js.Math.floor_int(1.0e15) == 2147483647
+  ```
+*)
+let floor_int f =
+  if f > Js_int.toFloat Js_int.max then Js_int.max
+  else if f < Js_int.toFloat Js_int.min then Js_int.min
+  else unsafe_floor f
+
+(** Deprecated; please use [`floor_int`](#floor_int) instead. *)
+let floor = floor_int
+[@@deprecated "Please use `floor_int` instead"]
+
+(**
+  Returns the largest integral value less than or equal to the argument. The
+  result is a `float` and is not restricted to the `int` data type range. See
+  [`Math.floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor)
+  on MDN.
+
+  ```res example
+  Js.Math.floor_float(3.7) == 3.0
+  Js.Math.floor_float(3.0) == 3.0
+  Js.Math.floor_float(-3.1) == -4.0
+  Js.Math.floor_float(2_150_000_000.3) == 2_150_000_000.0
+  ```
+*)
+external floor_float : float -> float = "floor" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Round to nearest single precision float. See
+  [`Math.fround`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/fround)
+  on MDN.
+
+  ```res example
+  Js.Math.fround(5.5) == 5.5
+  Js.Math.fround(5.05) == 5.050000190734863
+  ```
+*)
+external fround : float -> float = "fround" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the square root of the sum of squares of its two arguments (the
+  Pythagorean formula). See
+  [`Math.hypot`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/hypot)
+  on MDN.
+*)
+external hypot : float -> float -> float = "hypot" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the square root of the sum of squares of the numbers in the array
+  argument (generalized Pythagorean equation). Using an array allows you to
+  have more than two items. See
+  [`Math.hypot`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/hypot)
+  on MDN.
+
+  ```res example
+  Js.Math.hypotMany([3.0, 4.0, 12.0]) == 13.0
+  ```
+*)
+external hypotMany : float array -> float = "hypot" [@@bs.val] [@@bs.splice] [@@bs.scope "Math"]
+
+(**
+  32-bit integer multiplication. Use this only when you need to optimize
+  performance of multiplication of numbers stored as 32-bit integers. See
+  [`Math.imul`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/imul)
+  on MDN.
+*)
+external imul : int -> int -> int = "imul" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the natural logarithm of its argument; this is the number *x* such
+  that *e*<sup>*x*</sup> equals the argument. Returns `NaN` for negative
+  arguments. See
+  [`Math.log`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log)
+  on MDN.
+
+  ```res example
+  Js.Math.log(Js.Math._E) == 1.0
+  Js.Math.log(100.0) == 4.605170185988092
+  ```
+*)
+external log : float -> float = "log" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the natural logarithm of one plus the argument. Returns `NaN` for
+  arguments less than -1. See
+  [`Math.log1p`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log1p)
+  on MDN.
+
+  ```res example
+  Js.Math.log1p(Js.Math._E -. 1.0) == 1.0
+  Js.Math.log1p(99.0) == 4.605170185988092
+  ```
+*)
+external log1p : float -> float = "log1p" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the base 10 logarithm of its argument. Returns `NaN` for negative
+  arguments. See
+  [`Math.log10`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log10)
+  on MDN.
+
+  ```res example
+  Js.Math.log10(1000.0) == 3.0
+  Js.Math.log10(0.01) == -2.0
+  Js.Math.log10(Js.Math.sqrt(10.0)) == 0.5
+  ```
+*)
+external log10 : float -> float = "log10" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the base 2 logarithm of its argument. Returns `NaN` for negative
+  arguments. See
+  [`Math.log2`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log2)
+  on MDN.
+
+  ```res example
+  Js.Math.log2(512.0) == 9.0
+  Js.Math.log2(0.125) == -3.0
+  Js.Math.log2(Js.Math._SQRT2) == 0.5000000000000001 // due to precision
+  ```
+*)
+external log2 : float -> float = "log2" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the maximum of its two integer arguments.  See
+  [`Math.max`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/max)
+  on MDN.
+*)
+external max_int : int -> int -> int = "max" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the maximum of the integers in the given array.  See
+  [`Math.max`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/max)
+  on MDN.
+*)
+external maxMany_int : int array -> int = "max" [@@bs.val] [@@bs.splice] [@@bs.scope "Math"]
+
+(**
+  Returns the maximum of its two floating point arguments. See
+  [`Math.max`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/max)
+  on MDN.
+*)
+external max_float : float -> float -> float = "max" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the maximum of the floating point values in the given array. See
+  [`Math.max`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/max)
+  on MDN.
+*)
+external maxMany_float : float array -> float = "max" [@@bs.val] [@@bs.splice] [@@bs.scope "Math"]
+
+(**
+  Returns the minimum of its two integer arguments. See
+  [`Math.min`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/min)
+  on MDN.
+*)
+external min_int : int -> int -> int = "min" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the minimum of the integers in the given array. See
+  [`Math.min`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/min)
+  on MDN.
+*)
+external minMany_int : int array -> int = "min" [@@bs.val] [@@bs.splice] [@@bs.scope "Math"]
+
+(**
+  Returns the minimum of its two floating point arguments. See
+  [`Math.min`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/min)
+  on MDN.
+*)
+external min_float : float -> float -> float = "min" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the minimum of the floating point values in the given array. See
+  [`Math.min`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/min)
+  on MDN.
+*)
+external minMany_float : float array -> float = "min" [@@bs.val] [@@bs.splice] [@@bs.scope "Math"]
+
+(**
+  Raises the given base to the given exponent. (Arguments and result are
+  integers.) See
+  [`Math.pow`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/pow)
+  on MDN.
+
+  ```res example
+  Js.Math.pow_int(~base=3, ~exp=4) == 81
+  ```
+*)
+external pow_int : base:int -> exp:int -> int = "pow" [@@bs.val] [@@bs.scope "Math"]
+[@@deprecated "use `power_float` instead, the return type may be not int"]
+
+(**
+  Raises the given base to the given exponent. (Arguments and result are
+  floats.) Returns `NaN` if the result would be imaginary. See
+  [`Math.pow`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/pow)
+  on MDN.
+
+  ```res example
+  Js.Math.pow_float(~base=3.0, ~exp=4.0) == 81.0
+  Js.Math.pow_float(~base=4.0, ~exp=-2.0) == 0.0625
+  Js.Math.pow_float(~base=625.0, ~exp=0.5) == 25.0
+  Js.Math.pow_float(~base=625.0, ~exp=-0.5) == 0.04
+  Js.Float.isNaN(Js.Math.pow_float(~base=-2.0, ~exp=0.5)) == true
+  ```
+*)
+external pow_float : base:float -> exp:float -> float = "pow" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns a random number in the half-closed interval [0,1). See
+  [`Math.random`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random)
+  on MDN.
+*)
+external random : unit -> float = "random" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  A call to `random_int(minVal, maxVal)` returns a random number in the
+  half-closed interval [minVal, maxVal). See
+  [`Math.random`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random)
+  on MDN.
+*)
+let random_int min max =
+  floor ((random ()) *. (Js_int.toFloat (max - min))) + min
+
+(**
+  Rounds its argument to nearest integer. For numbers with a fractional portion
+  of exactly 0.5, the argument is rounded to the next integer in the direction
+  of positive infinity. This function may return values not representable by
+  `int`, whose range is -2147483648 to 2147483647. This is because, in
+  JavaScript, there are only 64-bit floating point numbers, which can represent
+  integers in the range ±(2<sup>53</sup>-1) exactly. See
+  [`Math.round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round)
+  on MDN.
+
+  ```res example
+  Js.Math.unsafe_round(3.7) == 4
+  Js.Math.unsafe_round(-3.5) == -3
+  Js.Math.unsafe_round(2_150_000_000_000.3) // out of range for int
+  ```
+*)
+external unsafe_round : float -> int = "round" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Rounds to nearest integral value (expressed as a float). See
+  [`Math.round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round)
+  on MDN.
+*)
+external round : float -> float = "round" [@@bs.val] [@@bs.scope "Math"]
+
+(**
+  Returns the sign of its integer argument: -1 if negative, 0 if zero, 1 if
+  positive. See
+  [`Math.sign`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sign)
+  on MDN.
+*)
+external sign_int : int -> int = "sign" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Returns the sign of its float argument: -1.0 if negative, 0.0 if zero, 1.0 if
+  positive. See
+  [`Math.sign`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sign)
+  on MDN.
+*)
+external sign_float : float -> float = "sign" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Sine of argument, which must be specified in radians. See
+  [`Math.sin`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sin)
+  on MDN.
+*)
+external sin : float -> float = "sin" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Hyperbolic sine of argument, which must be specified in radians. See
+  [`Math.sinh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sinh)
+  on MDN.
+*)
+external sinh : float -> float = "sinh" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Square root. If the argument is negative, this function returns `NaN`. See
+  [`Math.sqrt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sqrt)
+  on MDN.
+*)
+external sqrt : float -> float = "sqrt" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Tangent of argument, which must be specified in radians. Returns `NaN` if the
+  argument is positive infinity or negative infinity. See
+  [`Math.cos`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/cos)
+  on MDN.
+*)
+external tan : float -> float = "tan" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Hyperbolic tangent of argument, which must be specified in radians. See
+  [`Math.tanh`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/tanh)
+  on MDN.
+*)
+external tanh : float -> float = "tanh" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Truncates its argument; i.e., removes fractional digits. This function may
+  return values not representable by `int`, whose range is -2147483648 to
+  2147483647. This is because, in JavaScript, there are only 64-bit floating
+  point numbers, which can represent integers in the range ±(2<sup>53</sup>-1)
+  exactly. See
+  [`Math.trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc)
+  on MDN.
+*)
+external unsafe_trunc : float -> int = "trunc" [@@bs.val][@@bs.scope "Math"]
+
+(**
+  Truncates its argument; i.e., removes fractional digits. See
+  [`Math.trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc)
+  on MDN.
+*)
+external trunc : float -> float = "trunc" [@@bs.val][@@bs.scope "Math"]

package/lib/ocaml/js_null.ml

@@ -0,0 +1,57 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** Provides functionality for dealing with the `'a Js.null` type *)
+
+
+type + 'a t = 'a Js.null
+
+external to_opt : 'a t -> 'a option = "#null_to_opt"
+external toOption : 'a t -> 'a option = "#null_to_opt"
+external return : 'a -> 'a t  = "%identity"
+let test : 'a t -> bool = fun x -> x = Js.null
+external empty : 'a t = "#null" 
+external getUnsafe : 'a t -> 'a = "%identity"
+
+let getExn f =
+  match toOption f with 
+  | None -> Js_exn.raiseError "Js.Null.getExn"
+  | Some x -> x 
+  
+let bind x f =
+  match toOption x with
+  | None -> empty
+  | Some x -> return (f x [@bs])
+
+let iter x f =
+  match toOption x with
+  | None ->  ()
+  | Some x -> f x [@bs]
+
+let fromOption x =
+  match x with
+  | None -> empty
+  | Some x -> return x
+
+let from_opt = fromOption