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

[CCHeap] update comment delete_all

Browse source
This commit is contained in:
Fardale 2018-01-28 12:36:37 +01:00
parent 4e9eeb50e5
commit 50d970852e
2 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/core/CCHeap.ml
View file

@ -119,8 +119,11 @@ module type S = sig
@raise Empty if the heap is empty *)
val delete_all : (elt -> elt -> bool) -> elt -> t -> t
(** Delete value if it exist in the heap.
[delete_all eq x h], use [eq] to find all [x] in [h] and delete them *)
(** Delete all occurrences of a value in the heap.
[delete_all eq x h], use [eq] to find all [x] in [h] and delete them.
If [h] do not contain [x] then it return [h].
The difference with {!filter} is that [delete_all] stops as soon as
it enters a subtree whose root is bigger than the element *)
val iter : (elt -> unit) -> t -> unit
(** Iterate on elements *)

7
src/core/CCHeap.mli
View file

@ -56,8 +56,11 @@ module type S = sig
@raise Empty if the heap is empty *)
val delete_all : (elt -> elt -> bool) -> elt -> t -> t
(** Delete value if it exist in the heap.
[delete_all eq x h], use [eq] to find all [x] in [h] and delete them
(** Delete all occurrences of a value in the heap.
[delete_all eq x h], use [eq] to find all [x] in [h] and delete them.
If [h] do not contain [x] then it return [h].
The difference with {!filter} is that [delete_all] stops as soon as
it enters a subtree whose root is bigger than the element
@since NEXT_RELEASE *)
val iter : (elt -> unit) -> t -> unit