summaryrefslogtreecommitdiff
path: root/macros/generic/random
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-04-14 03:02:32 +0000
committerNorbert Preining <norbert@preining.info>2020-04-14 03:02:32 +0000
commitc7235aafe4ddb8f9800cdf784212d4c53bb53e32 (patch)
tree3485e2d65f65d8128206c5a1c45c842b26e84705 /macros/generic/random
parentc98e9ebef816f09dc54c52a01df4f978e1b210fc (diff)
CTAN sync 202004140302
Diffstat (limited to 'macros/generic/random')
-rw-r--r--macros/generic/random/README.md11
-rw-r--r--macros/generic/random/random-doc.pdfbin0 -> 76332 bytes
-rw-r--r--macros/generic/random/random-doc.tex74
-rw-r--r--macros/generic/random/random.tex104
4 files changed, 189 insertions, 0 deletions
diff --git a/macros/generic/random/README.md b/macros/generic/random/README.md
new file mode 100644
index 0000000000..471963a7e1
--- /dev/null
+++ b/macros/generic/random/README.md
@@ -0,0 +1,11 @@
+#random.tex ver 0.2 (Donald Arseneau)
+
+Generating "random" numbers in TeX.
+
+ `\setrannum {<`*counter*`>} {<`*minimum*`>} {<`*maximum*`>}`
+ `\setrandimen {<`*dimen-register*`>} {<`*minimum*`>} {<`*maximum*`>}`
+
+This software is contributed to the public domain.
+
+Definitions are in `random.tex`. Documentation is in comments of
+`random.tex` and in `random-doc.tex` and `random-doc.pdf`
diff --git a/macros/generic/random/random-doc.pdf b/macros/generic/random/random-doc.pdf
new file mode 100644
index 0000000000..a27c7bd90b
--- /dev/null
+++ b/macros/generic/random/random-doc.pdf
Binary files differ
diff --git a/macros/generic/random/random-doc.tex b/macros/generic/random/random-doc.tex
new file mode 100644
index 0000000000..59520b62b9
--- /dev/null
+++ b/macros/generic/random/random-doc.tex
@@ -0,0 +1,74 @@
+% plain TeX
+
+\def\cmd#1{\leavevmode\hbox{\tt\string#1}}
+\edef\{{\string{}
+\edef\}{\string}}
+
+\noindent{\bf RANDOM.TEX }\qquad\qquad ver 0.2 \qquad\qquad (Donald Arseneau)
+
+\bigskip
+
+\noindent Generating ``random'' numbers in \TeX.
+
+\medskip
+
+ {\tt \string\setrannum \thinspace\{$\langle \it counter\rangle$\}\thinspace\{$\langle\it minimum\rangle$\}\thinspace\{$\langle\it maximum\rangle$\}}
+
+ {\tt \string\setrandimen \thinspace\{$\langle \hbox{\it dimen-register}\rangle$\}\thinspace\{$\langle\it minimum\rangle$\}\thinspace\{$\langle\it maximum\rangle$\}}
+
+\medskip
+\noindent This software is released to the public domain.
+\bigskip
+\noindent Random integers are generated in the range 1 to 2147483646 by the
+macro \cmd\nextrandom. The result is returned in the counter \cmd\randomi.
+Do not change \cmd\randomi\ except, perhaps, to initialize it at some
+random (or specific) value. If you do not initialize it, it will be initialized
+using the time and date. (This is a sparse initialization, giving
+fewer than a million different starting values, but you should use
+other sources of numbers if they are available---just remember that
+most of the numbers available to \TeX\ are not at all random.)
+
+The \cmd\nextrandom\ command is not very useful by itself, unless you
+have exactly 2147483646 things to choose from. Much more useful
+is the \cmd\setrannum\ command which sets a given counter to a random
+value within a specified range. There are three parameters:
+\medskip
+{\tt \string\setrannum \thinspace\{$\langle \it counter\rangle$\}\thinspace\{$\langle\it minimum\rangle$\}\thinspace\{$\langle\it maximum\rangle$\}}
+\medskip
+\noindent For example, to simulate a die-roll:
+\medskip
+{\tt \string\setrannum\{\string\die\}\{1\}\{6\} \string\ifcase\string\die...}
+\medskip
+
+If you need random numbers that are not integers, you will have to
+use dimen registers instead with \cmd\setrandimen. For example, to set a random
+page width between 3 and 6.5 inches:
+\medskip
+\cmd\setrandimen \cmd\hsize{\tt\{3in\}\{6.5in\}}
+\medskip\noindent
+The ``\cmd\pointless'' macro
+will remove the ``{\tt pt}'' that \TeX\ gives so you can use the dimensions
+as pure ``real'' numbers. In that case, specify the range in {\tt pt} units.
+For example,
+\medskip
+ {\tt\string\setrandimen\string\answer\{2.71828pt\}\{3.14159pt\}}
+ \hfill\break\indent
+ {\tt The answer is \string\pointless\string\answer.}
+\medskip
+
+The random number generator is the one by Lewis, Goodman, and Miller
+(1969) and used as ``ran0'' in ``Numerical Recipies'' using Schrage's
+method for avoiding overflows. The multiplier is 16807 ($7^5$), the
+added constant is 0, and the modulus is 2147483647 ($2^{31}-1$).
+
+See CACM, Vol.~36, no. 7, (July 1993), p.~109. The original authors
+Park and Miller have since concluded that a better multiplier is 48271,
+rather than their original 16807.
+
+The range of integers generated is $1 - 2147483646$. A smaller range would
+reduce the complexity of the macros a bit, but not much---most of the
+code deals with initialization and type-conversion. On the other hand,
+the large range may be wasted due to the sparse seed initialization.
+
+
+\bye
diff --git a/macros/generic/random/random.tex b/macros/generic/random/random.tex
new file mode 100644
index 0000000000..2ea4c82eca
--- /dev/null
+++ b/macros/generic/random/random.tex
@@ -0,0 +1,104 @@
+% RANDOM.TEX v 0.2 (Donald Arseneau)
+% Generating "random" numbers in TeX.
+%
+% \setrannum {<counter>} {<minimum>} {<maximum>}
+% \setrandimen {<dimen-register>} {<minimum>} {<maximum>}
+%
+% This software is released to the public domain.
+%
+% Random integers are generated in the range 1 to 2147483646 by the
+% macro \nextrandom. The result is returned in the counter \randomi.
+% Do not change \randomi except, perhaps, to initialize it at some
+% random value. If you do not initialize it, it will be initialized
+% using the time and date. (This is a sparse initialization, giving
+% fewer than a million different starting values, but you should use
+% other sources of numbers if they are available--just remember that
+% most of the numbers available to TeX are not at all random.)
+%
+% The \nextrandom command is not very useful by itself, unless you
+% have exactly 2147483646 things to choose from. Much more useful
+% is the \setrannum command which sets a given counter to a random
+% value within a specified range. There are three parameters:
+% \setrannum {<counter>} {<minimum>} {<maximum>}. For example, to
+% simulate a die-roll: \setrannum{\die}{1}{6} \ifcase\die... .
+%
+% If you need random numbers that are not integers, you will have to
+% use dimen registers and \setrandimen. For example, to set a random
+% page width: \setrandimen \hsize{3in}{6.5in}. The "\pointless" macro
+% will remove the "pt" that TeX gives so you can use the dimensions
+% as pure `real' numbers. In that case, specify the range in pt units.
+% For example,
+% \setrandimen\answer{2.71828pt}{3.14159pt}
+% The answer is \pointless\answer.
+%
+% The random number generator is the one by Lewis, Goodman, and Miller
+% (1969) and used as "ran0" in "Numerical Recipies" using Schrage's
+% method for avoiding overflows. The multiplier is 16807 (7^5), the
+% added constant is 0, and the modulus is 2147483647 (2^{31}-1).
+%
+% See CACM, Vol. 36, no. 7, (July 1993), p. 109. The original authors
+% Park and Miller have since concluded that a better multiplier is 48271,
+% rather than their original 16807.
+%
+% The range of integers generated is 1 - 2147483646. A smaller range would
+% reduce the complexity of the macros a bit, but not much--most of the
+% code deals with initialization and type-conversion. On the other hand,
+% the large range may be wasted due to the sparse seed initialization.
+
+\newcount\randomi % the random number seed (while executing)
+\global\randomi\catcode`\@ % scratch variable during definitions
+\catcode`\@=11
+
+\def\nextrandom{\begingroup
+ \ifnum\randomi<\@ne % then initialize with time
+ \global\randomi\time
+ \global\multiply\randomi388 \global\advance\randomi\year
+ \global\multiply\randomi31 \global\advance\randomi\day
+ \global\multiply\randomi97 \global\advance\randomi\month
+ \message{Randomizer initialized to \the\randomi.}%
+ \nextrandom \nextrandom \nextrandom
+ \fi
+ \count@ii\randomi
+ \divide\count@ii 127773 % modulus = multiplier * 127773 + 2836
+ \count@\count@ii
+ \multiply\count@ii 127773
+ \global\advance\randomi-\count@ii % random mod 127773
+ \global\multiply\randomi 16807
+ \multiply\count@ 2836
+ \global\advance\randomi-\count@
+ \ifnum\randomi<\z@ \global\advance\randomi 2147483647\relax\fi
+ \endgroup
+}
+
+\countdef\count@ii=2 % use only in boxes!
+\ifx\@tempcnta\undefined \csname newcount\endcsname \@tempcnta \fi
+\ifx\@tempcntb\undefined \csname newcount\endcsname \@tempcntb \fi
+
+\def\setrannum#1#2#3{% count register, minimum, maximum
+ \@tempcnta#3\advance\@tempcnta-#2\advance\@tempcnta\@ne
+ \@tempcntb 2147483645 % = m - 2 = 2^{31} - 3
+ \divide\@tempcntb\@tempcnta
+ \getr@nval
+ \advance\ranval#2\relax
+ #1\ranval
+}
+
+\def\setrandim#1#2#3{% dimen register, minimum length, maximum length
+ \dimen@#2\dimen@ii#3\relax
+ \setrannum\ranval\dimen@\dimen@ii
+ #1\ranval sp\relax
+}
+
+\def\getr@nval{% The values in \@tempcnta and \@tempcntb are parameters
+ \nextrandom
+ \ranval\randomi \advance\ranval\m@ne \divide\ranval\@tempcntb
+ \ifnum\ranval<\@tempcnta\else \expandafter\getr@nval \fi
+}
+
+\def\pointless{\expandafter\PoinTless\the}
+{\catcode`p=12 \catcode`t=12
+\gdef\PoinTless#1pt{#1}}
+
+\catcode`\@=\randomi
+\global\randomi=0
+\newcount\ranval