summaryrefslogtreecommitdiffstats
path: root/Doc/libwhrandom.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/libwhrandom.tex')
-rw-r--r--Doc/libwhrandom.tex20
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/libwhrandom.tex b/Doc/libwhrandom.tex
new file mode 100644
index 0000000..8ad2339
--- /dev/null
+++ b/Doc/libwhrandom.tex
@@ -0,0 +1,20 @@
+\section{Standard Module \sectcode{whrandom}}
+
+\stmodindex{whrandom}
+This module implements a Wichmann-Hill pseudo-random number generator.
+It defines the following functions:
+
+\renewcommand{\indexsubitem}{(in module whrandom)}
+\begin{funcdesc}{random}{}
+Returns the next random floating point number in the range [0.0 ... 1.0).
+\end{funcdesc}
+
+\begin{funcdesc}{seed}{x\, y\, z}
+Initializes the random number generator from the integers
+\var{x},
+\var{y}
+and
+\var{z}.
+When the module is first imported, the random number is initialized
+using values derived from the current time.
+\end{funcdesc}