package bignum

You can search for identifiers within the package.

in-package search v0.2.0

bignum
- Bignum
  - Bigint
    
    Hash_queue
    
    Key
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Hex
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    O
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Bignum0
    
    Hash_queue
    
    Key
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    O
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
    
    V2
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Stable
    
    Bignum
  - Std
  - Zarith_1_4

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Core_kernel.Core_hashtbl_intf.S_plain
  with type ('a, 'b) hashtbl = ('a, 'b) Base.Hashtbl.t
  with type key = t

type key = t

type ('a, 'b) hashtbl = ('a, 'b) Base.Hashtbl.t

type 'b t = (key, 'b) hashtbl

include sig ... end

val sexp_of_t : ('b -> Sexplib.Sexp.t) -> 'b t -> Sexplib.Sexp.t

type ('a, 'b) t_ = 'b t

type 'a key_ = key

val hashable : key Base.Hashtbl_intf.Hashable.t

include Base.Invariant.S1 with type 'b t := 'b t

val invariant : ('a -> unit) -> 'a t -> unit

include Core_kernel.Core_hashtbl_intf.Creators
  with type ('a, 'b) t := ('a, 'b) t_
  with type 'a key := 'a key_
  with type ('key, 'data, 'z) create_options :=
         ('key, 'data, 'z)
           Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val create : 
  ('a key_, 'b, unit -> ('a, 'b) t_)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val of_alist : 
  ('a key_,
    'b,
    ('a key_ * 'b) list ->
    [ `Ok of ('a, 'b) t_ | `Duplicate_key of 'a key_ ])
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val of_alist_report_all_dups : 
  ('a key_,
    'b,
    ('a key_ * 'b) list ->
    [ `Ok of ('a, 'b) t_ | `Duplicate_keys of 'a key_ list ])
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val of_alist_or_error : 
  ('a key_, 'b, ('a key_ * 'b) list -> ('a, 'b) t_ Base.Or_error.t)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val of_alist_exn : 
  ('a key_, 'b, ('a key_ * 'b) list -> ('a, 'b) t_)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val of_alist_multi : 
  ('a key_, 'b list, ('a key_ * 'b) list -> ('a, 'b list) t_)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val create_mapped : 
  ('a key_,
    'b,
    get_key:('r -> 'a key_) ->
    get_data:('r -> 'b) ->
    'r list ->
    [ `Ok of ('a, 'b) t_ | `Duplicate_keys of 'a key_ list ])
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

create_mapped get_key get_data [x1,...,xn]
= of_alist [get_key x1, get_data x1; ...; get_key xn, get_data xn]

val create_with_key : 
  ('a key_,
    'r,
    get_key:('r -> 'a key_) ->
    'r list ->
    [ `Ok of ('a, 'r) t_ | `Duplicate_keys of 'a key_ list ])
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

create_with_key ~get_key [x1,...,xn]
= of_alist [get_key x1, x1; ...; get_key xn, xn]

val create_with_key_or_error : 
  ('a key_,
    'r,
    get_key:('r -> 'a key_) ->
    'r list ->
    ('a, 'r) t_ Base.Or_error.t)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val create_with_key_exn : 
  ('a key_, 'r, get_key:('r -> 'a key_) -> 'r list -> ('a, 'r) t_)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

val group : 
  ('a key_,
    'b,
    get_key:('r -> 'a key_) ->
    get_data:('r -> 'b) ->
    combine:('b -> 'b -> 'b) ->
    'r list ->
    ('a, 'b) t_)
    Core_kernel.Core_hashtbl_intf.create_options_without_hashable

include Core_kernel.Core_hashtbl_intf.Accessors
  with type ('a, 'b) t := ('a, 'b) t_
  with type 'a key := 'a key_

val sexp_of_key : ('a, _) t_ -> 'a key_ -> Base.Sexp.t

val clear : (_, _) t_ -> unit

val copy : ('a, 'b) t_ -> ('a, 'b) t_

val fold : 
  ('a, 'b) t_ ->
  init:'c ->
  f:(key:'a key_ -> data:'b -> 'c -> 'c) ->
  'c

val iter_keys : ('a, _) t_ -> f:('a key_ -> unit) -> unit

val iter : (_, 'b) t_ -> f:('b -> unit) -> unit

val iteri : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> unit) -> unit

val iter_vals : (_, 'b) t_ -> f:('b -> unit) -> unit

deprecated [since 2016-04] Use iter instead

val existsi : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> bool) -> bool

val exists : (_, 'b) t_ -> f:('b -> bool) -> bool

val for_alli : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> bool) -> bool

val for_all : (_, 'b) t_ -> f:('b -> bool) -> bool

val counti : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> bool) -> int

val count : (_, 'b) t_ -> f:('b -> bool) -> int

val length : (_, _) t_ -> int

val is_empty : (_, _) t_ -> bool

val mem : ('a, _) t_ -> 'a key_ -> bool

val remove : ('a, _) t_ -> 'a key_ -> unit

val replace : ('a, 'b) t_ -> key:'a key_ -> data:'b -> unit

deprecated [since 2015-10] Use set instead

val set : ('a, 'b) t_ -> key:'a key_ -> data:'b -> unit

val add : ('a, 'b) t_ -> key:'a key_ -> data:'b -> [ `Ok | `Duplicate ]

val add_or_error : 
  ('a, 'b) t_ ->
  key:'a key_ ->
  data:'b ->
  unit Base.Or_error.t

val add_exn : ('a, 'b) t_ -> key:'a key_ -> data:'b -> unit

val change : ('a, 'b) t_ -> 'a key_ -> f:('b option -> 'b option) -> unit

change t key ~f changes t's value for key to be f (find t key).

val update : ('a, 'b) t_ -> 'a key_ -> f:('b option -> 'b) -> unit

update t key ~f is change t key ~f:(fun o -> Some (f o)).

val add_multi : ('a, 'b list) t_ -> key:'a key_ -> data:'b -> unit

add_multi t ~key ~data if key is present in the table then cons data on the list, otherwise add key with a single element list.

val remove_multi : ('a, _ list) t_ -> 'a key_ -> unit

remove_multi t key updates the table, removing the head of the list bound to key. If the list has only one element (or is empty) then the binding is removed.

val map : ('a, 'b) t_ -> f:('b -> 'c) -> ('a, 'c) t_

map t f returns new table with bound values replaced by f applied to the bound values

val mapi : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> 'c) -> ('a, 'c) t_

like map, but function takes both key and data as arguments

val filter_map : ('a, 'b) t_ -> f:('b -> 'c option) -> ('a, 'c) t_

returns new map with bound values filtered by f applied to the bound values

val filter_mapi : 
  ('a, 'b) t_ ->
  f:(key:'a key_ -> data:'b -> 'c option) ->
  ('a, 'c) t_

like filter_map, but function takes both key and data as arguments

val filter_keys : ('a, 'b) t_ -> f:('a key_ -> bool) -> ('a, 'b) t_

val filter : ('a, 'b) t_ -> f:('b -> bool) -> ('a, 'b) t_

val filteri : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> bool) -> ('a, 'b) t_

val partition_map : 
  ('a, 'b) t_ ->
  f:('b -> [ `Fst of 'c | `Snd of 'd ]) ->
  ('a, 'c) t_ * ('a, 'd) t_

returns new maps with bound values partitioned by f applied to the bound values

val partition_mapi : 
  ('a, 'b) t_ ->
  f:(key:'a key_ -> data:'b -> [ `Fst of 'c | `Snd of 'd ]) ->
  ('a, 'c) t_ * ('a, 'd) t_

like partition_map, but function takes both key and data as arguments

val partition_tf : ('a, 'b) t_ -> f:('b -> bool) -> ('a, 'b) t_ * ('a, 'b) t_

val partitioni_tf : 
  ('a, 'b) t_ ->
  f:(key:'a key_ -> data:'b -> bool) ->
  ('a, 'b) t_ * ('a, 'b) t_

val find_or_add : ('a, 'b) t_ -> 'a key_ -> default:(unit -> 'b) -> 'b

find_or_add t k ~default returns the data associated with key k if it is in the table t, otherwise it lets d = default() and adds it to the table.

val find : ('a, 'b) t_ -> 'a key_ -> 'b option

find t k returns Some (the current binding) of k in t, or None if no such binding exists

val find_exn : ('a, 'b) t_ -> 'a key_ -> 'b

find_exn t k returns the current binding of k in t, or raises Not_found if no such binding exists.

val find_and_call : 
  ('a, 'b) t_ ->
  'a key_ ->
  if_found:('b -> 'c) ->
  if_not_found:('a key_ -> 'c) ->
  'c

find_and_call t k ~if_found ~if_not_found

is equivalent to:

match find t k with Some v -> if_found v | None -> if_not_found k

except that it doesn't allocate the option.

val find_and_remove : ('a, 'b) t_ -> 'a key_ -> 'b option

find_and_remove t k returns Some (the current binding) of k in t and removes it, or None is no such binding exists

val merge : 
  ('k, 'a) t_ ->
  ('k, 'b) t_ ->
  f:
    (key:'k key_ ->
      [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] ->
      'c option) ->
  ('k, 'c) t_

Merge two hashtables.

The result of merge f h1 h2 has as keys the set of all k in the union of the sets of keys of h1 and h2 for which d(k) is not None, where:

d(k) =

f ~key:k (Some d1) None if k in h1 is to d1, and h2 does not map k;

f ~key:k None (Some d2) if k in h2 is to d2, and h1 does not map k;

f ~key:k (Some d1) (Some d2) otherwise, where k in h1 is to d1 and k in h2 is to d2.

Each key k is mapped to a single piece of data x, where d(k) = Some x.

type 'a merge_into_action =

| Remove
| Set_to of 'a

Every key in src will be removed or set in dst according to the return value of f.

val merge_into : 
  src:('k, 'a) t_ ->
  dst:('k, 'b) t_ ->
  f:(key:'k key_ -> 'a -> 'b option -> 'b merge_into_action) ->
  unit

val keys : ('a, _) t_ -> 'a key_ list

Returns the list of all keys for given hashtable.

val data : (_, 'b) t_ -> 'b list

Returns the list of all data for given hashtable.

val filter_keys_inplace : ('a, _) t_ -> f:('a key_ -> bool) -> unit

filter_inplace t ~f removes all the elements from t that don't satisfy f.

val filter_inplace : (_, 'b) t_ -> f:('b -> bool) -> unit

val filteri_inplace : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> bool) -> unit

val map_inplace : (_, 'b) t_ -> f:('b -> 'b) -> unit

map_inplace t ~f applies f to all elements in t, transforming them in place

val mapi_inplace : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> 'b) -> unit

val filter_map_inplace : (_, 'b) t_ -> f:('b -> 'b option) -> unit

filter_map_inplace combines the effects of map_inplace and filter_inplace

val filter_mapi_inplace : 
  ('a, 'b) t_ ->
  f:(key:'a key_ -> data:'b -> 'b option) ->
  unit

val replace_all : (_, 'b) t_ -> f:('b -> 'b) -> unit

deprecated [since 2016-02] Use map_inplace instead

val replace_alli : ('a, 'b) t_ -> f:(key:'a key_ -> data:'b -> 'b) -> unit

deprecated [since 2016-02] Use mapi_inplace instead

val filter_replace_all : (_, 'b) t_ -> f:('b -> 'b option) -> unit

deprecated [since 2016-02] Use filter_map_inplace instead

val filter_replace_alli : 
  ('a, 'b) t_ ->
  f:(key:'a key_ -> data:'b -> 'b option) ->
  unit

deprecated [since 2016-02] Use filter_mapi_inplace instead

val equal : ('a, 'b) t_ -> ('a, 'b) t_ -> ('b -> 'b -> bool) -> bool

equal t1 t2 f and similar t1 t2 f both return true iff t1 and t2 have the same keys and for all keys k, f (find_exn t1 k) (find_exn t2 k). equal and similar only differ in their types.

val similar : ('a, 'b1) t_ -> ('a, 'b2) t_ -> ('b1 -> 'b2 -> bool) -> bool

val to_alist : ('a, 'b) t_ -> ('a key_ * 'b) list

Returns the list of all (key,data) pairs for given hashtable.

val validate : 
  name:('a key_ -> string) ->
  'b Base.Validate.check ->
  ('a, 'b) t_ Base.Validate.check

val incr : ?by:int -> ?remove_if_zero:bool -> ('a, int) t_ -> 'a key_ -> unit

remove_if_zero's default is false.

val decr : ?by:int -> ?remove_if_zero:bool -> ('a, int) t_ -> 'a key_ -> unit

module Provide_of_sexp (Key : sig ... end) : sig ... end

module Provide_bin_io (Key : sig ... end) : sig ... end

include sig ... end

val t_of_sexp : 
  (Sexplib.Sexp.t -> 'v_x__002_) ->
  Sexplib.Sexp.t ->
  'v_x__002_ t