diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-03-05 00:40:52 -0500 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-03-05 00:40:52 -0500 |
| commit | 899e2cd3f1ea5f598947c7862d8f76378191b369 (patch) | |
| tree | a590027864b899b22bcc9eb921a55910f50de6f2 /docs/rng.md | |
| parent | 9a3162633d358c9dc698b2733027981203514dc9 (diff) | |
Further shorten docs
Diffstat (limited to 'docs/rng.md')
| -rw-r--r-- | docs/rng.md | 8 |
1 files changed, 0 insertions, 8 deletions
diff --git a/docs/rng.md b/docs/rng.md index af22c088..90c75362 100644 --- a/docs/rng.md +++ b/docs/rng.md @@ -31,7 +31,6 @@ This documentation provides details on RNG functions available in the API. ### `bool` Generate a random boolean value with a given probability. -**Signature:** ```tomo func bool(rng: RNG, p: Num = 0.5 -> Bool) ``` @@ -57,7 +56,6 @@ func bool(rng: RNG, p: Num = 0.5 -> Bool) ### `byte` Generate a random byte with uniform probability. -**Signature:** ```tomo func byte(rng: RNG -> Byte) ``` @@ -78,7 +76,6 @@ A random byte (0-255). ### `bytes` Generate an array of uniformly random bytes with the given length. -**Signature:** ```tomo func bytes(rng: RNG, count: Int -> [Byte]) ``` @@ -101,7 +98,6 @@ An array of length `count` random bytes with uniform random distribution (0-255) Return a copy of a random number generator. This copy will be a parallel version of the given RNG with its own internal state. -**Signature:** ```tomo func copy(rng: RNG -> RNG) ``` @@ -129,7 +125,6 @@ A copy of the given RNG. ### `int`, `int64`, `int32`, `int16`, `int8` Generate a random integer value with the given range. -**Signature:** ```tomo func int(rng: RNG, min: Int, max: Int -> Int) func int64(rng: RNG, min: Int64 = Int64.min, max: Int64 = Int64.max -> Int) @@ -157,7 +152,6 @@ is greater than `max`, an error will be raised. ### `new` Return a new random number generator. -**Signature:** ```tomo func new(seed: [Byte] = (/dev/urandom):read_bytes(40)! -> RNG) ``` @@ -181,7 +175,6 @@ A new random number generator. ### `num`, `num32` Generate a random floating point value with the given range. -**Signature:** ```tomo func num(rng: RNG, min: Num = 0.0, max: Num = 1.0 -> Int) func num32(rng: RNG, min: Num = 0.0_f32, max: Num = 1.0_f32 -> Int) @@ -206,7 +199,6 @@ A floating point number uniformly chosen from the range `[min, max]` ### `set_seed` Set the seed for an RNG. -**Signature:** ```tomo func set_seed(rng: RNG, seed: [Byte]) ``` |