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

Browse source
This commit is contained in:
Simon Cruanes 2022-10-18 15:42:59 -04:00
parent d822d023a2
commit 8983f3410a
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/Iter.mli
View file

@ -65,10 +65,14 @@ val init : (int -> 'a) -> 'a t
val cons : 'a -> 'a t -> 'a t
(** [cons x l] yields [x], then yields from [l].
Same as [append (singleton x) l] *)
Same as [append (singleton x) l].
Caution: it is advised not to build long iterators out of [cons],
because it's inefficient. Each additional [cons x i] adds one
layer of function call per item traversed in [i]. *)
val snoc : 'a t -> 'a -> 'a t
(** Same as {!cons} but yields the element after iterating on [l] *)
(** Same as {!cons} but yields the element after iterating on [l]. *)
val return : 'a -> 'a t
(** Synonym to {!singleton} *)