belt_SetString.mli

# 1 "set.cppo.mli"
(* Copyright (C) 2017 Authors of BuckleScript
 * 
 * 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. *)

(** This module is {!Belt.Set} specialized with value type to be a primitive type.
    It is more efficient in general, the  API is the same with {!Belt_Set} except its value type is fixed,
    and identity is not needed(using the built-in one)

    {b See} {!Belt.Set}
*)

# 33
type value = string
# 39
(** The type of the set elements. *)


type t
(** The type of sets. *)

val empty: t


val ofArray: value array -> t
[@@ocaml.deprecated "Use fromArray instead"]
val ofSortedArrayUnsafe: value array -> t     
[@@ocaml.deprecated "Use fromSortedArrayUnsafe instead"]

val fromArray: value array -> t
val fromSortedArrayUnsafe: value array -> t     
val isEmpty: t -> bool
val has: t -> value -> bool
  
val add:  t -> value -> t
(** If [x] was already in [s], [s] is returned unchanged. *)
val mergeMany: t -> value array -> t 
val remove:  t -> value -> t
(**  If [x] was not in [s], [s] is returned unchanged. *)
val removeMany: t -> value array -> t
  
val union: t -> t -> t
val intersect: t -> t -> t
val diff: t -> t -> t
val subset: t -> t -> bool
(** [subset s1 s2] tests whether the set [s1] is a subset of
   the set [s2]. *)
  
val cmp: t -> t -> int
(** Total ordering between sets. Can be used as the ordering function
   for doing sets of sets. *)

val eq: t -> t -> bool
(** [eq s1 s2] tests whether the sets [s1] and [s2] are
   equal, that is, contain equal elements. *)


val forEachU: t -> (value -> unit [@bs]) ->  unit
val forEach: t -> (value -> unit ) ->  unit  
(** In increasing order*)

val reduceU: t -> 'a -> ('a -> value ->  'a [@bs]) ->  'a
val reduce: t -> 'a -> ('a -> value ->  'a ) ->  'a  
(** Iterate in increasing order. *)

val everyU: t -> (value -> bool [@bs]) ->  bool
val every: t -> (value -> bool ) ->  bool  
(** [every p s] checks if all elements of the set
   satisfy the predicate [p]. Order unspecified. *)

val someU: t -> (value -> bool [@bs]) ->  bool
val some: t -> (value -> bool ) ->  bool  
(** [some p s] checks if at least one element of
   the set satisfies the predicate [p]. Oder unspecified. *)

val keepU: t -> (value -> bool [@bs]) ->  t
val keep: t -> (value -> bool ) ->  t  
(** [keep p s] returns the set of all elements in [s]
   that satisfy predicate [p]. *)

val partitionU: t -> (value -> bool [@bs]) ->  t * t
val partition: t -> (value -> bool ) ->  t * t
(** [partition p s] returns a pair of sets [(s1, s2)], where
   [s1] is the set of all the elements of [s] that satisfy the
   predicate [p], and [s2] is the set of all the elements of
   [s] that do not satisfy [p]. *)

val size: t -> int
val toList: t -> value list
(** In increasing order with respect *)
val toArray: t -> value array


val minimum: t -> value option
val minUndefined: t -> value Js.undefined
val maximum: t -> value option
val maxUndefined: t -> value Js.undefined



val get:  t -> value -> value option
val getUndefined:  t -> value -> value Js.undefined
val getExn: t -> value -> value    
val split:  t -> value -> (t * t) * bool  
(** [split x s] returns a triple [(l, present, r)], where
      [l] is the set of elements of [s] that are
      strictly less than [x];
      [r] is the set of elements of [s] that are
      strictly greater than [x];
      [present] is [false] if [s] contains no element equal to [x],
      or [true] if [s] contains an element equal to [x]. *)



val checkInvariantInternal: t -> unit
(**
   {b raise} when invariant is not held
*)