From ae074a6d4ed9a056d6687b2736be28a9dcc0649d Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Mon, 18 Jun 2018 10:49:41 +0200
Subject: Improve seeding methods

---
 lib/stdlib/doc/src/rand.xml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml
index 5f1ec84786..25eec216ef 100644
--- a/lib/stdlib/doc/src/rand.xml
+++ b/lib/stdlib/doc/src/rand.xml
@@ -273,6 +273,31 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre>
 	</p>
       </desc>
     </datatype>
+    <datatype>
+      <name name="seed"/>
+      <desc>
+	<p>
+	  A seed value for the generator.
+	</p>
+	<p>
+	  A list of integers sets the generator's internal state directly,
+	  after algorithm-dependent checks of the value
+	  and masking to the proper word size.
+	</p>
+	<p>
+	  An integer is used as the initial state for a SplitMix64 generator.
+	  The output values of that is then used for setting
+	  the generator's internal state
+	  after masking to the proper word size
+	  and if needed avoiding zero values.
+	</p>
+	<p>
+	  A traditional 3-tuple of integers seed is passed through
+	  algorithm-dependent hashing functions to create
+	  the generator's initial state.
+	</p>
+      </desc>
+    </datatype>
     <datatype>
       <name name="exrop_state"/>
       <desc><p>Algorithm specific internal state</p></desc>
-- 
cgit v1.2.3