simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-07 19:55:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

comments in CCMultiSet.mli, to explain meet/intersection/union

Browse source
This commit is contained in:
Simon Cruanes 2014-10-16 16:50:04 +02:00
parent 6d0e2fdd2d
commit 432f0f0abd
2 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
core/CCMultiSet.ml
View file

@ -148,16 +148,16 @@ module Make(O : Set.OrderedType) = struct
| Some n1, None -> Some n1 | Some n1, None -> Some n1
| None, Some n2 -> None | None, Some n2 -> None
| Some n1, Some n2 -> | Some n1, Some n2 ->
if n1 > n2 if n1 > n2
then Some (n1 - n2) then Some (n1 - n2)
else None) else None)
m1 m2 m1 m2
let contains m1 m2 = let contains m1 m2 =
try try
M.for_all (fun x c -> M.find x m1 >= c) m2 M.for_all (fun x c -> M.find x m1 >= c) m2
with Not_found -> false with Not_found -> false
let compare m1 m2 = let compare m1 m2 =
M.compare (fun x y -> x - y) m1 m2 M.compare (fun x y -> x - y) m1 m2

12
core/CCMultiSet.mli
View file

@ -46,25 +46,35 @@ module type S = sig
val remove : t -> elt -> t val remove : t -> elt -> t
val min : t -> elt val min : t -> elt
(** Minimal element w.r.t the total ordering on elements *)
val max : t -> elt val max : t -> elt
val union : t -> t -> t val union : t -> t -> t
(** [union a b] contains as many occurrences of an element [x]
as [count a x + count b x]. *)
val meet : t -> t -> t val meet : t -> t -> t
(** [meet a b] is a multiset such that
[count (meet a b) x = max (count a x) (count b x)] *)
val intersection : t -> t -> t val intersection : t -> t -> t
(** [intersection a b] is a multiset such that
[count (intersection a b) x = min (count a x) (count b x)] *)
val diff : t -> t -> t val diff : t -> t -> t
(** MultiSet difference.
[count (diff a b) x = max (count a x - count b x) 0] *)
val contains : t -> t -> bool val contains : t -> t -> bool
(** [contains a x = (count m x > 0)] *)
val compare : t -> t -> int val compare : t -> t -> int
val equal : t -> t -> bool val equal : t -> t -> bool
val cardinal : t -> int val cardinal : t -> int
(** Number of distinct elements *) (** Number of distinct elements *)
val iter : t -> (int -> elt -> unit) -> unit val iter : t -> (int -> elt -> unit) -> unit