mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
91 lines
2.7 KiB
OCaml
91 lines
2.7 KiB
OCaml
|
|
(*
|
|
copyright (c) 2013, simon cruanes
|
|
all rights reserved.
|
|
|
|
redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer. redistributions in binary
|
|
form must reproduce the above copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other materials provided with
|
|
the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*)
|
|
|
|
(** {6 Multimap} *)
|
|
|
|
module type S = sig
|
|
type key
|
|
type value
|
|
type t
|
|
|
|
val empty : t
|
|
(** Empty multimap *)
|
|
|
|
val is_empty : t -> bool
|
|
(** Empty multimap? *)
|
|
|
|
val add : t -> key -> value -> t
|
|
(** Add a key/value binding *)
|
|
|
|
val remove : t -> key -> value -> t
|
|
(** Remove the binding *)
|
|
|
|
val remove_all : t -> key -> t
|
|
(** Remove the key from the map *)
|
|
|
|
val mem : t -> key -> bool
|
|
(** Is there a binding for this key? *)
|
|
|
|
val find : t -> key -> value list
|
|
(** List of values for this key *)
|
|
|
|
val find_iter : t -> key -> (value -> unit) -> unit
|
|
(** Iterate on bindings for this key *)
|
|
|
|
val count : t -> key -> int
|
|
(** Number of bindings for this key *)
|
|
|
|
val iter : t -> (key -> value -> unit) -> unit
|
|
(** Iterate on all key/value *)
|
|
|
|
val fold : t -> 'a -> ('a -> key -> value -> 'a) -> 'a
|
|
(** Fold on all key/value *)
|
|
|
|
val size : t -> int
|
|
(** Number of keys *)
|
|
|
|
val union : t -> t -> t
|
|
(** Union of multimaps *)
|
|
|
|
val inter : t -> t -> t
|
|
(** Intersection of multimaps *)
|
|
|
|
val to_seq : t -> (key * value) Sequence.t
|
|
|
|
val of_seq : ?init:t -> (key * value) Sequence.t -> t
|
|
|
|
val keys : t -> key Sequence.t
|
|
|
|
val values : t -> value Sequence.t
|
|
(** Some values may occur several times *)
|
|
end
|
|
|
|
module type OrderedType = sig
|
|
type t
|
|
val compare : t -> t -> int
|
|
end
|
|
|
|
module Make(K : OrderedType)(V : OrderedType) : S with type key = K.t and type value = V.t
|