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

more explanations about merge

Browse source
This commit is contained in:
Simon Cruanes 2013-03-21 17:14:15 +01:00
parent 6a918a95dc
commit ebbf4a9138
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
enum.mli
View file

@ -184,7 +184,12 @@ val max : ?lt:('a -> 'a -> bool) -> 'a t -> 'a
val merge : 'a t t -> 'a t
(** Pick elements fairly in each sub-enum. The given enum
must be finite (not its elements, though). *)
must be finite (not its elements, though). The merge of enums
[e1, e2, ... en] picks one element in [e1], then one element in [e2],
then in [e3], ..., then in [en], and then starts again at [e1]. Once
a generator is empty, it is skipped; when they are all empty,
their merge is also empty.
For instance, [merge [1;3;5] [2;4;6]] will be [1;2;3;4;5;6]. *)
(** {3 Mutable heap (taken from heap.ml to avoid dependencies)} *)
module Heap : sig