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

doc: make it clearer the order of elements in group_by is unspecified

Browse source
This commit is contained in:
Simon Cruanes 2021-01-08 11:20:48 -05:00
parent 67affd2502
commit 28bff9b530
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/Iter.mli
View file

@ -296,13 +296,14 @@ val sorted : ?cmp:('a -> 'a -> int) -> 'a t -> bool
val group_succ_by : ?eq:('a -> 'a -> bool) -> 'a t -> 'a list t val group_succ_by : ?eq:('a -> 'a -> bool) -> 'a t -> 'a list t
(** Group equal consecutive elements. Linear time. (** Group equal consecutive elements. Linear time.
Formerly synonym to [group]. Formerly synonym to [group].
{b note}: Order of items in each list is unspecified.
@since 0.6 *) @since 0.6 *)
val group_by : ?hash:('a -> int) -> ?eq:('a -> 'a -> bool) -> val group_by : ?hash:('a -> int) -> ?eq:('a -> 'a -> bool) ->
'a t -> 'a list t 'a t -> 'a list t
(** Group equal elements, disregarding their order of appearance. (** Group equal elements, disregarding their order of appearance.
The result iterator is traversable as many times as required.
precondition: for any [x] and [y], if [eq x y] then [hash x=hash y] must hold. precondition: for any [x] and [y], if [eq x y] then [hash x=hash y] must hold.
{b note}: Order of items in each list is unspecified.
@since 0.6 *) @since 0.6 *)
val count : ?hash:('a -> int) -> ?eq:('a -> 'a -> bool) -> val count : ?hash:('a -> int) -> ?eq:('a -> 'a -> bool) ->