package coq

  1. Overview
  2. Docs
Formal proof management system

Install 

dune-project
 Dependency

coq.inria.fr Edit opam file Versions (40)

Authors

  1. T
    The Coq development team, INRIA, CNRS, and contributors.

Maintainers

  1. C
    coqdev@inria.fr

Sources

coq-8.16.0.tar.gz
sha256=36577b55f4a4b1c64682c387de7abea932d0fd42fc0cd5406927dca344f53587

doc/coq-core.clib/HMap/Make/index.html

Module HMap.MakeSource

Hash maps are maps that take advantage of having a hash on keys. This is essentially a hash table, except that it uses purely functional maps instead of arrays.

CAVEAT: order-related functions like fold or iter do not respect the provided order anymore! It's your duty to do something sensible to prevent this if you need it. In particular, min_binding and max_binding are now made meaningless.

Parameters

module M : HashedType

Signature

The underlying Map library

include CSig.MapS with type key = M.t
Sourcetype key = M.t
Sourcetype +'a t
Sourceval empty : 'a t
Sourceval is_empty : 'a t -> bool
Sourceval mem : key -> 'a t -> bool
Sourceval add : key -> 'a -> 'a t -> 'a t
Sourceval update : key -> ('a option -> 'a option) -> 'a t -> 'a t
Sourceval singleton : key -> 'a -> 'a t
Sourceval remove : key -> 'a t -> 'a t
Sourceval merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
Sourceval union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
Sourceval iter : (key -> 'a -> unit) -> 'a t -> unit
Sourceval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
Sourceval for_all : (key -> 'a -> bool) -> 'a t -> bool
Sourceval exists : (key -> 'a -> bool) -> 'a t -> bool
Sourceval filter : (key -> 'a -> bool) -> 'a t -> 'a t
Sourceval partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
Sourceval cardinal : 'a t -> int
Sourceval bindings : 'a t -> (key * 'a) list
Sourceval min_binding : 'a t -> key * 'a
Sourceval max_binding : 'a t -> key * 'a
Sourceval choose : 'a t -> key * 'a
Sourceval choose_opt : 'a t -> (key * 'a) option
Sourceval split : key -> 'a t -> 'a t * 'a option * 'a t
Sourceval find : key -> 'a t -> 'a
Sourceval find_opt : key -> 'a t -> 'a option
Sourceval map : ('a -> 'b) -> 'a t -> 'b t
Sourceval mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
Sourcemodule Set : CSig.SetS with type elt = key

Sets used by the domain function

Sourceval get : key -> 'a t -> 'a

Same as find but fails an assertion instead of raising Not_found

Sourceval set : key -> 'a -> 'a t -> 'a t

Same as add, but expects the key to be present, and thus faster.

  • raises Not_found

    when the key is unbound in the map.

Sourceval modify : key -> (key -> 'a -> 'a) -> 'a t -> 'a t

Apply the given function to the binding of the given key.

  • raises Not_found

    when the key is unbound in the map.

Sourceval domain : 'a t -> Set.t

Recover the set of keys defined in the map.

Sourceval bind : (key -> 'a) -> Set.t -> 'a t

bind f s transform the set x1; ...; xn into x1 := f x1; ...; xn := f xn.

Sourceval fold_left : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b

Alias for fold, to easily track where we depend on fold order.

Sourceval fold_right : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b

Folding keys in decreasing order.

Sourceval height : 'a t -> int

An indication of the logarithmic size of a map

Sourceval filter_range : (key -> int) -> 'a t -> 'a t

find_range in_range m Given a comparison function in_range x, that tests if x is below, above, or inside a given range filter_range returns the submap of m whose keys are in range. Note that in_range has to define a continouous range.

Sourcemodule Smart : sig ... end
Sourcemodule Monad (M : CMap.MonadS) : sig ... end

Fold operators parameterized by any monad.