base

Full standard library replacement for OCaml
package base
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library base
Module Base . Map . Using_comparator
type nonrec ('k, +'v, 'cmp) t = ( 'k, 'v, 'cmp ) t
val sexp_of_t : ( 'k -> Sexp.t ) -> ( 'v -> Sexp.t ) -> ( 'cmp -> Sexp.t ) -> ( 'k, 'v, 'cmp ) t -> Sexp.t
val t_of_sexp_direct : comparator:( 'k, 'cmp ) Comparator.t -> ( Sexp.t -> 'k ) -> ( Sexp.t -> 'v ) -> Sexp.t -> ( 'k, 'v, 'cmp ) t
module Tree : sig ... end
val invariants : ( _, _, _ ) t -> bool
val is_empty : ( _, _, _ ) t -> bool
val length : ( _, _, _ ) t -> int
val add : ( 'a, 'b, 'cmp ) t -> key:'a -> data:'b -> [ `Ok of ( 'a, 'b, 'cmp ) t | `Duplicate ]
val add_exn : ( 'a, 'b, 'cmp ) t -> key:'a -> data:'b -> ( 'a, 'b, 'cmp ) t
val set : ( 'a, 'b, 'cmp ) t -> key:'a -> data:'b -> ( 'a, 'b, 'cmp ) t
val add_multi : ( 'a, 'b list, 'cmp ) t -> key:'a -> data:'b -> ( 'a, 'b list, 'cmp ) t
val remove_multi : ( 'a, 'b list, 'cmp ) t -> 'a -> ( 'a, 'b list, 'cmp ) t
val find_multi : ( 'a, 'b list, 'cmp ) t -> 'a -> 'b list
val change : ( 'a, 'b, 'cmp ) t -> 'a -> f:( 'b option -> 'b option ) -> ( 'a, 'b, 'cmp ) t
val update : ( 'a, 'b, 'cmp ) t -> 'a -> f:( 'b option -> 'b ) -> ( 'a, 'b, 'cmp ) t
val find : ( 'a, 'b, 'cmp ) t -> 'a -> 'b option
val find_exn : ( 'a, 'b, 'cmp ) t -> 'a -> 'b
val remove : ( 'a, 'b, 'cmp ) t -> 'a -> ( 'a, 'b, 'cmp ) t
val mem : ( 'a, 'b, 'cmp ) t -> 'a -> bool
val iter_keys : ( 'a, _, 'cmp ) t -> f:( 'a -> unit ) -> unit
val iter : ( _, 'b, 'cmp ) t -> f:( 'b -> unit ) -> unit
val iteri : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> unit ) -> unit
val iteri_until : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> Base__Map_intf.Continue_or_stop.t ) -> Base__Map_intf.Finished_or_unfinished.t
val iter2 : ( 'a, 'b, 'cmp ) t -> ( 'a, 'c, 'cmp ) t -> f: ( key:'a -> data:[ `Left of 'b | `Right of 'c | `Both of 'b * 'c ] -> unit ) -> unit
val map : ( 'a, 'b, 'cmp ) t -> f:( 'b -> 'c ) -> ( 'a, 'c, 'cmp ) t
val mapi : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> 'c ) -> ( 'a, 'c, 'cmp ) t
val fold : ( 'a, 'b, _ ) t -> init:'c -> f:( key:'a -> data:'b -> 'c -> 'c ) -> 'c
val fold_right : ( 'a, 'b, _ ) t -> init:'c -> f:( key:'a -> data:'b -> 'c -> 'c ) -> 'c
val fold2 : ( 'a, 'b, 'cmp ) t -> ( 'a, 'c, 'cmp ) t -> init:'d -> f: ( key:'a -> data:[ `Left of 'b | `Right of 'c | `Both of 'b * 'c ] -> 'd -> 'd ) -> 'd
val filter_keys : ( 'a, 'b, 'cmp ) t -> f:( 'a -> bool ) -> ( 'a, 'b, 'cmp ) t
val filter : ( 'a, 'b, 'cmp ) t -> f:( 'b -> bool ) -> ( 'a, 'b, 'cmp ) t
val filteri : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> bool ) -> ( 'a, 'b, 'cmp ) t
val filter_map : ( 'a, 'b, 'cmp ) t -> f:( 'b -> 'c option ) -> ( 'a, 'c, 'cmp ) t
val filter_mapi : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> 'c option ) -> ( 'a, 'c, 'cmp ) t
val partition_mapi : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> ( 'c, 'd ) Either.t ) -> ( 'a, 'c, 'cmp ) t * ( 'a, 'd, 'cmp ) t
val partition_map : ( 'a, 'b, 'cmp ) t -> f:( 'b -> ( 'c, 'd ) Either.t ) -> ( 'a, 'c, 'cmp ) t * ( 'a, 'd, 'cmp ) t
val partitioni_tf : ( 'a, 'b, 'cmp ) t -> f:( key:'a -> data:'b -> bool ) -> ( 'a, 'b, 'cmp ) t * ( 'a, 'b, 'cmp ) t
val partition_tf : ( 'a, 'b, 'cmp ) t -> f:( 'b -> bool ) -> ( 'a, 'b, 'cmp ) t * ( 'a, 'b, 'cmp ) t
val combine_errors : ( 'a, 'b Or_error.t, 'cmp ) t -> ( 'a, 'b, 'cmp ) t Or_error.t
val compare_direct : ( 'b -> 'b -> int ) -> ( 'a, 'b, 'cmp ) t -> ( 'a, 'b, 'cmp ) t -> int
val equal : ( 'b -> 'b -> bool ) -> ( 'a, 'b, 'cmp ) t -> ( 'a, 'b, 'cmp ) t -> bool
val keys : ( 'a, _, _ ) t -> 'a list
val data : ( _, 'b, _ ) t -> 'b list
val to_alist : ?key_order:[ `Increasing | `Decreasing ] -> ( 'a, 'b, _ ) t -> ('a * 'b) list
val validate : name:( 'a -> string ) -> 'b Validate.check -> ( 'a, 'b, _ ) t Validate.check
val validatei : name:( 'a -> string ) -> ('a * 'b) Validate.check -> ( 'a, 'b, _ ) t Validate.check
val merge : ( 'a, 'b, 'cmp ) t -> ( 'a, 'c, 'cmp ) t -> f: ( key:'a -> [ `Left of 'b | `Right of 'c | `Both of 'b * 'c ] -> 'd option ) -> ( 'a, 'd, 'cmp ) t
val symmetric_diff : ( 'a, 'b, 'cmp ) t -> ( 'a, 'b, 'cmp ) t -> data_equal:( 'b -> 'b -> bool ) -> ('a * [ `Left of 'b | `Right of 'b | `Unequal of 'b * 'b ]) Sequence.t
val fold_symmetric_diff : ( 'a, 'b, 'cmp ) t -> ( 'a, 'b, 'cmp ) t -> data_equal:( 'b -> 'b -> bool ) -> init:'c -> f:( 'c -> ('a * [ `Left of 'b | `Right of 'b | `Unequal of 'b * 'b ]) -> 'c ) -> 'c
val min_elt : ( 'a, 'b, 'cmp ) t -> ('a * 'b) option
val min_elt_exn : ( 'a, 'b, 'cmp ) t -> 'a * 'b
val max_elt : ( 'a, 'b, 'cmp ) t -> ('a * 'b) option
val max_elt_exn : ( 'a, 'b, 'cmp ) t -> 'a * 'b
val for_all : ( _, 'b, _ ) t -> f:( 'b -> bool ) -> bool
val for_alli : ( 'a, 'b, _ ) t -> f:( key:'a -> data:'b -> bool ) -> bool
val exists : ( _, 'b, _ ) t -> f:( 'b -> bool ) -> bool
val existsi : ( 'a, 'b, _ ) t -> f:( key:'a -> data:'b -> bool ) -> bool
val count : ( _, 'b, _ ) t -> f:( 'b -> bool ) -> int
val counti : ( 'a, 'b, _ ) t -> f:( key:'a -> data:'b -> bool ) -> int
val split : ( 'k, 'v, 'cmp ) t -> 'k -> ( 'k, 'v, 'cmp ) t * ('k * 'v) option * ( 'k, 'v, 'cmp ) t
val append : lower_part:( 'k, 'v, 'cmp ) t -> upper_part:( 'k, 'v, 'cmp ) t -> [ `Ok of ( 'k, 'v, 'cmp ) t | `Overlapping_key_ranges ]
val subrange : ( 'k, 'v, 'cmp ) t -> lower_bound:'k Maybe_bound.t -> upper_bound:'k Maybe_bound.t -> ( 'k, 'v, 'cmp ) t
val fold_range_inclusive : ( 'a, 'b, _ ) t -> min:'a -> max:'a -> init:'c -> f:( key:'a -> data:'b -> 'c -> 'c ) -> 'c
val range_to_alist : ( 'a, 'b, _ ) t -> min:'a -> max:'a -> ('a * 'b) list
val closest_key : ( 'a, 'b, _ ) t -> [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] -> 'a -> ('a * 'b) option
val nth : ( 'a, 'b, _ ) t -> int -> ('a * 'b) option
val nth_exn : ( 'a, 'b, _ ) t -> int -> 'a * 'b
val rank : ( 'a, _, _ ) t -> 'a -> int option
val to_tree : ( 'a, 'b, 'cmp ) t -> ( 'a, 'b, 'cmp ) Tree.t
val to_sequence : ?order:[ `Increasing_key | `Decreasing_key ] -> ?keys_greater_or_equal_to:'a -> ?keys_less_or_equal_to:'a -> ( 'a, 'b, _ ) t -> ('a * 'b) Sequence.t
val binary_search_segmented : ( 'k, 'v, _ ) t -> segment_of:( key:'k -> data:'v -> [ `Left | `Right ] ) -> [ `Last_on_left | `First_on_right ] -> ('k * 'v) option
val empty : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, _, 'cmp ) t
val singleton : comparator:( 'a, 'cmp ) Comparator.t -> 'a -> 'b -> ( 'a, 'b, 'cmp ) t
val of_alist : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> [ `Ok of ( 'a, 'b, 'cmp ) t | `Duplicate_key of 'a ]
val of_alist_or_error : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> ( 'a, 'b, 'cmp ) t Or_error.t
val of_alist_exn : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> ( 'a, 'b, 'cmp ) t
val of_alist_multi : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> ( 'a, 'b list, 'cmp ) t
val of_alist_fold : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> init:'c -> f:( 'c -> 'b -> 'c ) -> ( 'a, 'c, 'cmp ) t
val of_alist_reduce : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) list -> f:( 'b -> 'b -> 'b ) -> ( 'a, 'b, 'cmp ) t
val of_sorted_array : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) array -> ( 'a, 'b, 'cmp ) t Or_error.t
val of_sorted_array_unchecked : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) array -> ( 'a, 'b, 'cmp ) t
val of_increasing_iterator_unchecked : comparator:( 'a, 'cmp ) Comparator.t -> len:int -> f:( int -> 'a * 'b ) -> ( 'a, 'b, 'cmp ) t
val of_increasing_sequence : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> ( 'a, 'b, 'cmp ) t Or_error.t
val of_sequence : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> [ `Ok of ( 'a, 'b, 'cmp ) t | `Duplicate_key of 'a ]
val of_sequence_or_error : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> ( 'a, 'b, 'cmp ) t Or_error.t
val of_sequence_exn : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> ( 'a, 'b, 'cmp ) t
val of_sequence_multi : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> ( 'a, 'b list, 'cmp ) t
val of_sequence_fold : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> init:'c -> f:( 'c -> 'b -> 'c ) -> ( 'a, 'c, 'cmp ) t
val of_sequence_reduce : comparator:( 'a, 'cmp ) Comparator.t -> ('a * 'b) Sequence.t -> f:( 'b -> 'b -> 'b ) -> ( 'a, 'b, 'cmp ) t
val of_iteri : comparator:( 'a, 'cmp ) Comparator.t -> iteri:( f:( key:'a -> data:'b -> unit ) -> unit ) -> [ `Ok of ( 'a, 'b, 'cmp ) t | `Duplicate_key of 'a ]
val of_tree : comparator:( 'a, 'cmp ) Comparator.t -> ( 'a, 'b, 'cmp ) Tree.t -> ( 'a, 'b, 'cmp ) t
val comparator : ( 'a, _, 'cmp ) t -> ( 'a, 'cmp ) Comparator.t
val hash_fold_direct : 'k Hash.folder -> 'v Hash.folder -> ( 'k, 'v, 'cmp ) t Hash.folder

To get around the value restriction, apply the functor and include it. You can see an example of this in the Poly submodule below.