summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2021-07-13 21:34:56 -0700
committerKaz Kylheku <kaz@kylheku.com>2021-07-13 21:34:56 -0700
commit673489d49890bfdaffdd30246266eea97365d487 (patch)
tree4af799f0c8f3cac42e60ddf7db4fc2ad26f0c73c
parent6a5488b1d3966452daa4f6d1f025bc22f4b02566 (diff)
downloadtxr-673489d49890bfdaffdd30246266eea97365d487.tar.gz
txr-673489d49890bfdaffdd30246266eea97365d487.tar.bz2
txr-673489d49890bfdaffdd30246266eea97365d487.zip
doc: warm-up-period argument of make-random-state.
* txr.1: Add missing requirement: warm-up is also not performed if make-random-state is a vector. Improve the wording overall.
-rw-r--r--txr.121
1 files changed, 14 insertions, 7 deletions
diff --git a/txr.1 b/txr.1
index dfc1d443..9c475232 100644
--- a/txr.1
+++ b/txr.1
@@ -61708,15 +61708,22 @@ function.
The
.meta warm-up-period
argument specifies the number of values which are immediately obtained and
-discarded from the newly-seeded generator before it is returned.
-Warm-up is not performed when
+discarded from the newly-seeded generator before it is returned. This
+procedure is referred to as PRNG
+.IR warm-up .
+
+Warm-up is not performed if
.meta seed
-is an existing random state object, and this argument is ignored in that
-case. If the parameter is required, but the argument is missing, then
-the value of the
+is a vector or random state object. In this situation, if the
+.meta warm-up-period
+is present, it may still be required to be an integer, even though it is ignored.
+
+If warm-up is performed, but the
+.meta warm-up-period
+argument is missing, then the value of the
.code *random-warmup*
-special variable is used. This variable has a default value which may be too
-small for serious applications of pseudorandom numbers; see the Notes under
+special variable is used. Note: this variable has a default value which may be too
+small for some applications of pseudorandom numbers; see the Notes under
.codn *random-warmup* .
.coNP Function @ random-state-p