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

Merge pull request #40 from mooreryan/random-iter-docs

Browse source 
Add docs about seeding random generator
This commit is contained in:
Simon Cruanes 2023-05-03 21:20:36 -04:00 • committed by GitHub
commit 29cabc46eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/Iter.mli
View file

@ -707,6 +707,8 @@ end
(** {1 Random iterators} *)
(** {2 Generating} *)
val random_int : int -> int t
(** Infinite iterator of random integers between 0 and
the given higher bound (see Random.int) *)
@ -745,6 +747,26 @@ val sample : int -> 'a t -> 'a array
It returns an array of size [min (length seq) n].
@since 0.7 *)
(** {2 Seeding}
Random iterators use [Random.int], [Random.float], [Random.bool],
etc., under the hood, so they will respect seeding of the random
generator in the usual way. I.e., if you do not initialize the
random generator with one of [Random.init], [Random.full_init], or
[Random.self_init] before calling these functions, they will yield
the same values across seperate invocations of your program.
Example:
{[
(* Ensure a fresh random seed each time the program is executed. *)
let () = Random.self_init ()
(* Generate random values. *)
let l = Iter.random_int 1000 |> Iter.take 3 |> Iter.to_list
]}
*)
(** {1 Infix functions} *)
module Infix : sig

22
src/IterLabels.mli
View file

@ -676,6 +676,8 @@ end
(** {2 Random iterators} *)
(** {3 Generating} *)
val random_int : int -> int t
(** Infinite iterator of random integers between 0 and
the given higher bound (see Random.int) *)
@ -714,6 +716,26 @@ val sample : n:int -> 'a t -> 'a array
It returns an array of size [min (length seq) n].
@since 0.7 *)
(** {3 Seeding}
Random iterators use [Random.int], [Random.float], [Random.bool],
etc., under the hood, so they will respect seeding of the random
generator in the usual way. I.e., if you do not initialize the
random generator with one of [Random.init], [Random.full_init], or
[Random.self_init] before calling these functions, they will yield
the same values across seperate invocations of your program.
Example:
{[
(* Ensure a fresh random seed each time the program is executed. *)
let () = Random.self_init ()
(* Generate random values. *)
let l = Iter.random_int 1000 |> Iter.take 3 |> Iter.to_list
]}
*)
(** {2 Infix functions} *)
module Infix : sig