package colibri2

The type of the map keys.

The type of the data (* used for genericity of the interface *)

The type of maps from type key to type 'a.

The empty map.

Test whether a map is empty or not.

mem x m returns true if m contains a binding for x, and false otherwise.

add x y m returns a map containing the same bindings as m, plus a binding of x to y. If x was already bound in m, its previous binding disappears.

singleton x y returns the one-element map that contains a binding y for x.

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map.

merge f m1 m2 computes a map whose keys is a subset of keys of m1 and of m2. The presence of each such binding, and the corresponding value, is determined with the function f.

Total ordering between maps. The first argument is a total ordering used to compare data associated with equal keys in the two maps.

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data. cmp is the equality predicate used to compare the data associated with the keys.

iter f m applies f to all bindings in map m. f receives the key as first argument, and the associated value as second argument. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

fold f m a computes (f kN dN ... (f k1 d1 a)...), where k1 ... kN are the keys of all bindings in m (in increasing order), and d1 ... dN are the associated data.

for_all p m checks if all the bindings of the map satisfy the predicate p.

exists p m checks if at least one binding of the map satisfy the predicate p.

filter p m returns the map with all the bindings in m that satisfy predicate p.

partition p m returns a pair of maps (m1, m2), where m1 contains all the bindings of s that satisfy the predicate p, and m2 is the map with all the bindings of s that do not satisfy p.

Return the number of bindings of a map.

Return the list of all bindings of the given map. The returned list is sorted in increasing order with respect to the ordering Ord.compare, where Ord is the argument given to Extmap.Make.

Return the smallest binding of the given map (with respect to the Ord.compare ordering), or raise Not_found if the map is empty.

Same as Extmap.S.min_binding, but returns the largest binding of the given map.

Return one binding of the given map, or raise Not_found if the map is empty. Which binding is chosen is unspecified, but equal bindings will be chosen for equal maps.

split x m returns a triple (l, data, r), where l is the map with all the bindings of m whose key is strictly less than x; r is the map with all the bindings of m whose key is strictly greater than x; data is None if m contains no binding for x, or Some v if m binds v to x.

find x m returns the current binding of x in m, or raises Not_found if no such binding exists.

map f m returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

Same as Extmap.S.map, but the function receives as arguments both the key and the associated value for each binding of the map.

change f x m returns a map containing the same bindings as m, except the binding of x in m is changed from y to f (Some y) if m contains a binding of x, otherwise the binding of x becomes f None.

change f x m corresponds to a more efficient way to do match (try f (Some (find x m)) with Not_found -> f None) with | None -> m | Some v -> add x v

add_change empty add x b m corresponds to a more efficient and simpler way to do change (function | None -> Some (empty b) | Some l -> Some (add b l)) x m

union f m1 m2 computes a map whose keys is a subset of keys of m1 and of m2. If a binding is present in m1 (resp. m2) and not in m2 (resp. m1) the same binding is present in the result. The function f is called only in ambiguous cases.

Between union for the first argument and merge for the second argument

inter f m1 m2 computes a map whose keys is a subset of the intersection of keys of m1 and of m2.

diff f m1 m2 computes a map whose keys is a subset of keys of m1. f is applied on key which belongs to m1 and m2 if f returns None the binding is removed from m1, otherwise Some d1 is returned, the key binds to d1 in m1

submap pr m1 m2 verifies that all the keys in m1 are in m2 and that for each such binding pr is verified.

disjoint pr m1 m2 verifies that for every common key in m1 and m2, pr is verified.

set_union = union (fun _ x _ -> Some x)

set_inter = inter (fun _ x _ -> Some x)

set_diff = diff (fun _ _ _ -> None)

set_submap = submap (fun _ _ _ -> true)

set_disjoint = disjoint (fun _ _ _ -> false)

set_compare = compare (fun _ _ -> 0)

set_equal = equal (fun _ _ -> true)

find_def x d m returns the current binding of x in m, or return d if no such binding exists.

find_opt x m returns the Some of the current binding of x in m, or return None if no such binding exists.

find_exn exn x d m returns the current binding of x in m, or raise exn if no such binding exists.

find_remove x m returns the map without the binding and the binding

Just add or remove the binding if a data is or not given

return the binding of the maximum key smaller than the given key.

Same as Extmap.S.map, but may remove bindings.

Same as Extmap.S.mapi, but may remove bindings.

fold and map at the same time

Same as Extmap.S.mapi_fold, but may remove bindings.

same as fold but in the order of List.fold_left

fold the common keys of two map at the same time

fold the keys which appear in one of the two maps

same as fold_left but in decreasing order

translate f m translates the keys in the map m by the function f. f must be strictly monotone on the key of m. Otherwise it raises invalid_arg

add_new e x v m binds x to v in m if x is not bound, and raises e otherwise.

Return the list of all keys of the given map. The returned list is sorted in increasing order with respect to the ordering Ord.compare, where Ord is the argument given to Extmap.Make.

Return the list of all values of the given map. The returned list is sorted in increasing order with respect to the ordering Ord.compare of the keys, where Ord is the argument given to Extmap.Make.

construct a map from a pair of bindings

check if the map has the given number of elements

choose an element randomly (but non-uniformly), the given function is the random generator

enumeration: zipper style

get the current key value pair of the enumeration, return None if the enumeration reach the end

start the enumeration of the given map

get the next step of the enumeration

start the enumeration of the given map at the first key which is greater or equal than the given one

get the next (or same) step of the enumeration which key is greater or equal to the given key

Check if the internal invariant are verified. Only for debugging the datastructure