@tellahq/rescript 10.1.0-alpha.2 → 10.1.4-republish-2

package/lib/ocaml/arrayLabels.mli

@@ -1,276 +0,0 @@
-(**************************************************************************)
-(*                                                                        *)
-(*                                 OCaml                                  *)
-(*                                                                        *)
-(*             Xavier Leroy, projet Cristal, INRIA Rocquencourt           *)
-(*                                                                        *)
-(*   Copyright 1996 Institut National de Recherche en Informatique et     *)
-(*     en Automatique.                                                    *)
-(*                                                                        *)
-(*   All rights reserved.  This file is distributed under the terms of    *)
-(*   the GNU Lesser General Public License version 2.1, with the          *)
-(*   special exception on linking described in the file LICENSE.          *)
-(*                                                                        *)
-(**************************************************************************)
-
-(** Array operations. *)
-
-external length : 'a array -> int = "%array_length"
-(** Return the length (number of elements) of the given array. *)
-
-external get : 'a array -> int -> 'a = "%array_safe_get"
-(** [Array.get a n] returns the element number [n] of array [a].
-   The first element has number 0.
-   The last element has number [Array.length a - 1].
-   You can also write [a.(n)] instead of [Array.get a n].
-
-   Raise [Invalid_argument "index out of bounds"]
-   if [n] is outside the range 0 to [(Array.length a - 1)]. *)
-
-external set : 'a array -> int -> 'a -> unit = "%array_safe_set"
-(** [Array.set a n x] modifies array [a] in place, replacing
-   element number [n] with [x].
-   You can also write [a.(n) <- x] instead of [Array.set a n x].
-
-   Raise [Invalid_argument "index out of bounds"]
-   if [n] is outside the range 0 to [Array.length a - 1]. *)
-
-external make : int -> 'a -> 'a array = "?make_vect"
-(** [Array.make n x] returns a fresh array of length [n],
-   initialized with [x].
-   All the elements of this new array are initially
-   physically equal to [x] (in the sense of the [==] predicate).
-   Consequently, if [x] is mutable, it is shared among all elements
-   of the array, and modifying [x] through one of the array entries
-   will modify all other entries at the same time.
-
-   Raise [Invalid_argument] if [n < 0] or [n > Sys.max_array_length].
-   If the value of [x] is a floating-point number, then the maximum
-   size is only [Sys.max_array_length / 2].*)
-
-external create : int -> 'a -> 'a array = "?make_vect"
-  [@@ocaml.deprecated "Use Array.make instead."]
-(** @deprecated [Array.create] is an alias for {!Array.make}. *)
-
-val init : int -> f:(int -> 'a) -> 'a array
-(** [Array.init n f] returns a fresh array of length [n],
-   with element number [i] initialized to the result of [f i].
-   In other terms, [Array.init n f] tabulates the results of [f]
-   applied to the integers [0] to [n-1].
-
-   Raise [Invalid_argument] if [n < 0] or [n > Sys.max_array_length].
-   If the return type of [f] is [float], then the maximum
-   size is only [Sys.max_array_length / 2].*)
-
-val make_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
-(** [Array.make_matrix dimx dimy e] returns a two-dimensional array
-   (an array of arrays) with first dimension [dimx] and
-   second dimension [dimy]. All the elements of this new matrix
-   are initially physically equal to [e].
-   The element ([x,y]) of a matrix [m] is accessed
-   with the notation [m.(x).(y)].
-
-   Raise [Invalid_argument] if [dimx] or [dimy] is negative or
-   greater than {!Sys.max_array_length}.
-   If the value of [e] is a floating-point number, then the maximum
-   size is only [Sys.max_array_length / 2]. *)
-
-val create_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
-  [@@ocaml.deprecated "Use Array.make_matrix instead."]
-(** @deprecated [Array.create_matrix] is an alias for
-   {!Array.make_matrix}. *)
-
-val append : 'a array -> 'a array -> 'a array
-(** [Array.append v1 v2] returns a fresh array containing the
-   concatenation of the arrays [v1] and [v2]. *)
-
-val concat : 'a array list -> 'a array
-(** Same as {!Array.append}, but concatenates a list of arrays. *)
-
-val sub : 'a array -> pos:int -> len:int -> 'a array
-(** [Array.sub a start len] returns a fresh array of length [len],
-   containing the elements number [start] to [start + len - 1]
-   of array [a].
-
-   Raise [Invalid_argument "Array.sub"] if [start] and [len] do not
-   designate a valid subarray of [a]; that is, if
-   [start < 0], or [len < 0], or [start + len > Array.length a]. *)
-
-val copy : 'a array -> 'a array
-(** [Array.copy a] returns a copy of [a], that is, a fresh array
-   containing the same elements as [a]. *)
-
-val fill : 'a array -> pos:int -> len:int -> 'a -> unit
-(** [Array.fill a ofs len x] modifies the array [a] in place,
-   storing [x] in elements number [ofs] to [ofs + len - 1].
-
-   Raise [Invalid_argument "Array.fill"] if [ofs] and [len] do not
-   designate a valid subarray of [a]. *)
-
-val blit :
-  src:'a array -> src_pos:int -> dst:'a array -> dst_pos:int -> len:int ->
-    unit
-(** [Array.blit v1 o1 v2 o2 len] copies [len] elements
-   from array [v1], starting at element number [o1], to array [v2],
-   starting at element number [o2]. It works correctly even if
-   [v1] and [v2] are the same array, and the source and
-   destination chunks overlap.
-
-   Raise [Invalid_argument "Array.blit"] if [o1] and [len] do not
-   designate a valid subarray of [v1], or if [o2] and [len] do not
-   designate a valid subarray of [v2]. *)
-
-val to_list : 'a array -> 'a list
-(** [Array.to_list a] returns the list of all the elements of [a]. *)
-
-val of_list : 'a list -> 'a array
-(** [Array.of_list l] returns a fresh array containing the elements
-   of [l]. *)
-
-val iter : f:('a -> unit) -> 'a array -> unit
-(** [Array.iter f a] applies function [f] in turn to all
-   the elements of [a].  It is equivalent to
-   [f a.(0); f a.(1); ...; f a.(Array.length a - 1); ()]. *)
-
-val map : f:('a -> 'b) -> 'a array -> 'b array
-(** [Array.map f a] applies function [f] to all the elements of [a],
-   and builds an array with the results returned by [f]:
-   [[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |]]. *)
-
-val iteri : f:(int -> 'a -> unit) -> 'a array -> unit
-(** Same as {!Array.iter}, but the
-   function is applied to the index of the element as first argument,
-   and the element itself as second argument. *)
-
-val mapi : f:(int -> 'a -> 'b) -> 'a array -> 'b array
-(** Same as {!Array.map}, but the
-   function is applied to the index of the element as first argument,
-   and the element itself as second argument. *)
-
-val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b array -> 'a
-(** [Array.fold_left f x a] computes
-   [f (... (f (f x a.(0)) a.(1)) ...) a.(n-1)],
-   where [n] is the length of the array [a]. *)
-
-val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'a
-(** [Array.fold_right f a x] computes
-   [f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...))],
-   where [n] is the length of the array [a]. *)
-
-
-(** {6 Iterators on two arrays} *)
-
-
-val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unit
-(** [Array.iter2 f a b] applies function [f] to all the elements of [a]
-   and [b].
-   Raise [Invalid_argument] if the arrays are not the same size.
-   @since 4.05.0 *)
-
-val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array
-(** [Array.map2 f a b] applies function [f] to all the elements of [a]
-   and [b], and builds an array with the results returned by [f]:
-   [[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|]].
-   Raise [Invalid_argument] if the arrays are not the same size.
-   @since 4.05.0 *)
-
-
-(** {6 Array scanning} *)
-
-
-val exists : f:('a -> bool) -> 'a array -> bool
-(** [Array.exists p [|a1; ...; an|]] checks if at least one element of
-    the array satisfies the predicate [p]. That is, it returns
-    [(p a1) || (p a2) || ... || (p an)].
-    @since 4.03.0 *)
-
-val for_all : f:('a -> bool) -> 'a array -> bool
-(** [Array.for_all p [|a1; ...; an|]] checks if all elements of the array
-   satisfy the predicate [p]. That is, it returns
-   [(p a1) && (p a2) && ... && (p an)].
-   @since 4.03.0 *)
-
-val mem : 'a -> set:'a array -> bool
-(** [mem x a] is true if and only if [x] is equal
-   to an element of [a].
-   @since 4.03.0 *)
-
-val memq : 'a -> set:'a array -> bool
-(** Same as {!Array.mem}, but uses physical equality instead of structural
-   equality to compare list elements.
-   @since 4.03.0 *)
-
-external create_float: int -> float array = "?make_float_vect"
-(** [Array.create_float n] returns a fresh float array of length [n],
-    with uninitialized data.
-    @since 4.03 *)
-
-val make_float: int -> float array
-  [@@ocaml.deprecated "Use Array.create_float instead."]
-(** @deprecated [Array.make_float] is an alias for
-    {!Array.create_float}. *)
-
-
-(** {1 Sorting} *)
-
-
-val sort : cmp:('a -> 'a -> int) -> 'a array -> unit
-(** Sort an array in increasing order according to a comparison
-   function.  The comparison function must return 0 if its arguments
-   compare as equal, a positive integer if the first is greater,
-   and a negative integer if the first is smaller (see below for a
-   complete specification).  For example, {!Pervasives.compare} is
-   a suitable comparison function, provided there are no floating-point
-   NaN values in the data.  After calling [Array.sort], the
-   array is sorted in place in increasing order.
-   [Array.sort] is guaranteed to run in constant heap space
-   and (at most) logarithmic stack space.
-
-   The current implementation uses Heap Sort.  It runs in constant
-   stack space.
-
-   Specification of the comparison function:
-   Let [a] be the array and [cmp] the comparison function.  The following
-   must be true for all x, y, z in a :
--   [cmp x y] > 0 if and only if [cmp y x] < 0
--   if [cmp x y] >= 0 and [cmp y z] >= 0 then [cmp x z] >= 0
-
-   When [Array.sort] returns, [a] contains the same elements as before,
-   reordered in such a way that for all i and j valid indices of [a] :
--   [cmp a.(i) a.(j)] >= 0 if and only if i >= j
-*)
-
-val stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
-(** Same as {!Array.sort}, but the sorting algorithm is stable (i.e.
-   elements that compare equal are kept in their original order) and
-   not guaranteed to run in constant heap space.
-
-   The current implementation uses Merge Sort. It uses [n/2]
-   words of heap space, where [n] is the length of the array.
-   It is usually faster than the current implementation of {!Array.sort}.
-*)
-
-val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
-(** Same as {!Array.sort} or {!Array.stable_sort}, whichever is
-    faster on typical input.
-*)
-
-
-(**/**)
-
-(** {1 Undocumented functions} *)
-
-(* The following is for system use only. Do not call directly. *)
-
-external unsafe_get : 'a array -> int -> 'a = "%array_unsafe_get"
-external unsafe_set : 'a array -> int -> 'a -> unit = "%array_unsafe_set"
-
-module Floatarray : sig
-  external create : int -> floatarray = "?floatarray_create"
-  external length : floatarray -> int = "%floatarray_length"
-  external get : floatarray -> int -> float = "%floatarray_safe_get"
-  external set : floatarray -> int -> float -> unit = "%floatarray_safe_set"
-  external unsafe_get : floatarray -> int -> float = "%floatarray_unsafe_get"
-  external unsafe_set : floatarray -> int -> float -> unit
-      = "%floatarray_unsafe_set"
-end

package/lib/ocaml/belt.ml

@@ -1,352 +0,0 @@
-(* 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. *)
-
-(** The ReScript standard library.
-
-Belt is currently mostly covering collection types. It has no string or date functions yet, although Belt.String is in the works. In the meantime, use [Js.String](js/string) for string functions and [Js.Date](js/date) for date functions.
-
-## Motivation
-
-Belt provides:
-
-- The **highest quality** immutable data structures in JavaScript.
-- Safety by default: A Belt function will never throw exceptions, unless it is
-  indicated explicitly in the function name (suffix "Exn").
-- Better performance and smaller code size running on the JS platform.
-- Ready for [Tree Shaking](https://webpack.js.org/guides/tree-shaking/).
-
-## Usage
-
-To use modules from Belt, either refer to them by their fully qualified name (`Belt.List`, `Belt.Array` etc.) or open the `Belt` module by putting
-
-```
-open Belt
-```
-
-at the top of your source files. After opening Belt this way, `Array` will refer to `Belt.Array`, `List` will refer to `Belt.List` etc. in the subsequent code.
-
-If you want to open Belt globally for all files in your project instead, you can put
-
-```json
-  "bsc-flags": ["-open Belt"],
-```
-
-into your `bsconfig.json`.
-
-**Note**: this is the **only** `open` we encourage.
-
-Example usage:
-
-```
-let someNumbers = [1, 1, 4, 2, 3, 6, 3, 4, 2]
-
-let greaterThan2UniqueAndSorted =
-  someNumbers
-  ->Belt.Array.keep(x => x > 2)
-  // convert to and from set to make values unique
-  ->Belt.Set.Int.fromArray
-  ->Belt.Set.Int.toArray // output is already sorted
-
-Js.log2("result", greaterThan2UniqueAndSorted)
-```
-
-## Curried vs. Uncurried Callbacks
-
-For functions taking a callback parameter, there are usually two versions
-available:
-
-- curried (no suffix)
-- uncurried (suffixed with `U`)
-
-E.g.:
-
-```
-let forEach: (t<'a>, 'a => unit) => unit
-
-let forEachU: (t<'a>, (. 'a) => unit) => unit
-```
-
-The uncurried version will be faster in some cases, but for simplicity we recommend to stick with the curried version unless you need the extra performance.
-
-The two versions can be invoked as follows:
-
-```
-["a", "b", "c"]->Belt.Array.forEach(x => Js.log(x))
-
-["a", "b", "c"]->Belt.Array.forEachU((. x) => Js.log(x))
-```
-
-## Specialized Collections
-
-For collections types like set or map, Belt provides both a generic module as well as specialized, more efficient implementations for string and int keys.
-
-For example, Belt has the following set modules:
-
-- [Belt.Set](belt/set)
-- [Belt.Set.Int](belt/set-int)
-- [Belt.Set.String](belt/set-string)
-
-## Implementation Details
-
-### Array access runtime safety
-
-One common confusion comes from the way Belt handles array access. It differs from than the default standard library's.
-
-```
-let letters = ["a", "b", "c"]
-let a = letters[0] // a == "a"
-let capitalA = Js.String.toUpperCase(a)
-let k = letters[10] // Raises an exception! The 10th index doesn't exist.
-```
-
-Because Belt avoids exceptions and returns `options` instead, this code behaves differently:
-
-```
-open Belt
-let letters = ["a", "b", "c"]
-let a = letters[0] // a == Some("a")
-let captialA = Js.String.toUpperCase(a) // Type error! This code will not compile.
-let k = letters[10] // k == None
-```
-
-Although we've fixed the problem where `k` raises an exception, we now have a type error when trying to capitalize `a`. There are a few things going on here:
-
-- Reason transforms array index access to the function `Array.get`. So `letters[0]` is the same as `Array.get(letters, 0)`.
-- The compiler uses whichever `Array` module is in scope. If you `open Belt`, then it uses `Belt.Array`.
-- `Belt.Array.get` returns values wrapped in options, so `letters[0] == Some("a")`.
-
-Fortunately, this is easy to fix:
-
-```res example
-open Belt
-let letters = ["a", "b", "c"]
-let a = letters[0]
-
-// Use a switch statement:
-let capitalA =
-  switch a {
-  | Some(a) => Some(Js.String.toUpperCase(a))
-  | None => None
-  }
-
-let k = letters[10] // k == None
-```
-
-With that little bit of tweaking, our code now compiles successfully and is 100% free of runtime errors!
-
-### A Special Encoding for Collection Safety
-
-When we create a collection library for a custom data type we need a way to provide a comparator function. Take Set for example, suppose its element type is a pair of ints, it needs a custom compare function that takes two tuples and returns their order. The Set could not just be typed as Set.t (int \* int) , its customized compare function needs to manifest itself in the signature, otherwise, if the user creates another customized compare function, the two collection could mix which would result in runtime error.
-
-We use a phantom type to solve the problem:
-
-```
-module Comparable1 =
-  Belt.Id.MakeComparable(
-    {
-      type t = (int, int)
-      let cmp = ((a0, a1), (b0, b1)) =>
-        switch Pervasives.compare(a0, b0) {
-        | 0 => Pervasives.compare(a1, b1)
-        | c => c
-        }
-    }
-  )
-
-let mySet1 = Belt.Set.make(~id=module(Comparable1))
-
-module Comparable2 =
-  Belt.Id.MakeComparable(
-    {
-      type t = (int, int)
-      let cmp = ((a0, a1), (b0, b1)) =>
-        switch Pervasives.compare(a0, b0) {
-        | 0 => Pervasives.compare(a1, b1)
-        | c => c
-        }
-    }
-  )
-
-let mySet2 = Belt.Set.make(~id=module(Comparable2))
-```
-
-Here, the compiler would infer `mySet1` and `mySet2` having different type, so e.g. a `merge` operation that tries to merge these two sets will correctly fail.
-
-```
-let mySet1: t<(int, int), Comparable1.identity>
-let mySet2: t<(int, int), Comparable2.identity>
-```
-
-`Comparable1.identity` and `Comparable2.identity` are not the same using our encoding scheme.
-
-*)
-
-[@@@warning "-49"]
-
-(** [`Belt.Id`]()
-
-  Provide utilities to create identified comparators or hashes for
-  data structures used below.
-
-  It create a unique identifier per module of
-  functions so that different data structures with slightly different
-  comparison functions won't mix
-*)
-module Id = Belt_Id
-
-(** [`Belt.Array`]()
-
-  **mutable array**: Utilities functions
-*)
-module Array = Belt_Array
-
-(** [`Belt.SortArray`]()
-
-  The top level provides some generic sort related utilities.
-
-  It also has two specialized inner modules
-  [`Belt.SortArray.Int`]() and [`Belt.SortArray.String`]()
-*)
-module SortArray = Belt_SortArray
-
-(** [`Belt.MutableQueue`]()
-
-  An FIFO(first in first out) queue data structure
-*)
-module MutableQueue = Belt_MutableQueue
-
-(** [`Belt.MutableStack`]()
-
-  An FILO(first in last out) stack data structure
-*)
-module MutableStack = Belt_MutableStack
-
-(** [`Belt.List`]()
-
-  Utilities for List data type
-*)
-module List = Belt_List
-
-(** [`Belt.Range`]()
-
-  Utilities for a closed range `(from, start)`
-*)
-module Range = Belt_Range
-
-(** [`Belt.Set`]()
-
-  The top level provides generic **immutable** set operations.
-
-  It also has three specialized inner modules
-  [`Belt.Set.Int`](), [`Belt.Set.String`]() and
-
-  [`Belt.Set.Dict`](): This module separates data from function
-  which is more verbose but slightly more efficient
-
-*)
-module Set = Belt_Set
-
-
-(** [`Belt.Map`](),
-
-  The top level provides generic **immutable** map operations.
-
-  It also has three specialized inner modules
-  [`Belt.Map.Int`](), [`Belt.Map.String`]() and
-
-  [`Belt.Map.Dict`](): This module separates data from function
-  which  is more verbose but slightly more efficient
-*)
-module Map = Belt_Map
-
-
-(** [`Belt.MutableSet`]()
-
-  The top level provides generic **mutable** set operations.
-
-  It also has two specialized inner modules
-  [`Belt.MutableSet.Int`]() and [`Belt.MutableSet.String`]()
-*)
-module MutableSet = Belt_MutableSet
-
-(** [`Belt.MutableMap`]()
-
-  The top level provides generic **mutable** map operations.
-
-  It also has two specialized inner modules
-  [`Belt.MutableMap.Int`]() and [`Belt.MutableMap.String`]()
-
-*)
-module MutableMap = Belt_MutableMap
-
-
-(** [`Belt.HashSet`]()
-
-  The top level provides generic **mutable** hash set operations.
-
-  It also has two specialized inner modules
-  [`Belt.HashSet.Int`]() and [`Belt.HashSet.String`]()
-*)
-module HashSet = Belt_HashSet
-
-
-(** [`Belt.HashMap`]()
-
-  The top level provides generic **mutable** hash map operations.
-
-  It also has two specialized inner modules
-  [`Belt.HashMap.Int`]() and [`Belt.HashMap.String`]()
-*)
-module HashMap = Belt_HashMap
-
-
-(** [`Belt.Option`]()
-
-  Utilities for option data type.
-*)
-module Option = Belt_Option
-
-
-(** [`Belt.Result`]()
-
-  Utilities for result data type.
-*)
-
-module Result = Belt_Result
-
-(** [`Belt.Int`]()
-
-  Utilities for Int.
-*)
-
-module Int = Belt_Int
-
-(** [`Belt.Float`]()
-
-  Utilities for Float.
-*)
-
-module Float = Belt_Float
-
-