package base

You can search for identifiers within the package.

in-package search v0.2.0

Full standard library replacement for OCaml

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (19)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

base-v0.14.0.tar.gz

sha256=e89c4b898d9e93527f1c84f6784f9a92a1dfa86877f39ac4450a6cb69e866de6

md5=5a00382c724e97b6768aaa27481dd3cc

doc/base/Base/Hash_set/index.html

Module `Base.Hash_set`

type 'a t

val sexp_of_t : ('a -> Sexp.t) -> 'a t -> Sexp.t

We use [@@deriving sexp_of] but not [@@deriving sexp] because we want people to be explicit about the hash and comparison functions used when creating hashtables. One can use Hash_set.Poly.t, which does have [@@deriving sexp], to use polymorphic comparison and hashing.

module Key : sig ... end

module type Creators = sig ... end

module type Creators_generic = sig ... end

type nonrec ('key, 'z) create_options =
  ?growth_allowed:bool ->
  ?size:int ->
  (module Base__.Hashtbl_intf.Key.S with type t = 'key) ->
  'z

include Creators with type 'a t := 'a t

val create : 
  ?growth_allowed:bool ->
  ?size:int ->
  (module Base__.Hash_set_intf.Key.S with type t = 'a) ->
  'a t

val of_list : 
  ?growth_allowed:bool ->
  ?size:int ->
  (module Base__.Hash_set_intf.Key.S with type t = 'a) ->
  'a list ->
  'a t

module type Accessors = sig ... end

include Accessors with type 'a t := 'a t with type 'a elt = 'a

include Container.Generic with type 'a t := 'a t with type 'a elt = 'a

type 'a elt = 'a

val length : _ t -> int

val is_empty : _ t -> bool

val iter : 'a t -> f:('a elt -> unit) -> unit

val fold : 'a t -> init:'accum -> f:('accum -> 'a elt -> 'accum) -> 'accum

val fold_result : 
  'a t ->
  init:'accum ->
  f:('accum -> 'a elt -> ('accum, 'e) Result.t) ->
  ('accum, 'e) Result.t

val fold_until : 
  'a t ->
  init:'accum ->
  f:
    ('accum ->
      'a elt ->
      ('accum, 'final) Base__.Container_intf.Export.Continue_or_stop.t) ->
  finish:('accum -> 'final) ->
  'final

val exists : 'a t -> f:('a elt -> bool) -> bool

val for_all : 'a t -> f:('a elt -> bool) -> bool

val count : 'a t -> f:('a elt -> bool) -> int

val sum : 
  (module Base__.Container_intf.Summable with type t = 'sum) ->
  'a t ->
  f:('a elt -> 'sum) ->
  'sum

val find : 'a t -> f:('a elt -> bool) -> 'a elt option

val find_map : 'a t -> f:('a elt -> 'b option) -> 'b option

val to_list : 'a t -> 'a elt list

val to_array : 'a t -> 'a elt array

val min_elt : 'a t -> compare:('a elt -> 'a elt -> int) -> 'a elt option

val max_elt : 'a t -> compare:('a elt -> 'a elt -> int) -> 'a elt option

val mem : 'a t -> 'a -> bool

override Container.Generic.mem

val copy : 'a t -> 'a t

preserves the equality function

val add : 'a t -> 'a -> unit

val strict_add : 'a t -> 'a -> unit Or_error.t

strict_add t x returns Ok () if the x was not in t, or an Error if it was.

val strict_add_exn : 'a t -> 'a -> unit

val remove : 'a t -> 'a -> unit

val strict_remove : 'a t -> 'a -> unit Or_error.t

strict_remove t x returns Ok () if the x was in t, or an Error if it was not.

val strict_remove_exn : 'a t -> 'a -> unit

val clear : 'a t -> unit

val equal : 'a t -> 'a t -> bool

val filter : 'a t -> f:('a -> bool) -> 'a t

val filter_inplace : 'a t -> f:('a -> bool) -> unit

val inter : 'key t -> 'key t -> 'key t

inter t1 t2 computes the set intersection of t1 and t2. Runs in O(min(length t1, length t2)). Behavior is undefined if t1 and t2 don't have the same equality function.

val union : 'a t -> 'a t -> 'a t

val diff : 'a t -> 'a t -> 'a t

val of_hashtbl_keys : ('a, _) Hashtbl.t -> 'a t

val to_hashtbl : 'key t -> f:('key -> 'data) -> ('key, 'data) Hashtbl.t

val hashable_s : 'key t -> 'key Key.t

type nonrec ('key, 'z) create_options_without_first_class_module =
  ?growth_allowed:bool ->
  ?size:int ->
  'z

module Poly : sig ... end

A hash set that uses polymorphic comparison

module M (Elt : T.T) : sig ... end

M is meant to be used in combination with OCaml applicative functor types:

module type Sexp_of_m = sig ... end

module type M_of_sexp = sig ... end

val sexp_of_m__t : (module Sexp_of_m with type t = 'elt) -> 'elt t -> Sexp.t

val m__t_of_sexp : (module M_of_sexp with type t = 'elt) -> Sexp.t -> 'elt t

module Creators (Elt : sig ... end) : sig ... end