From dff85f3d6fdb4b3453d863bf9208073564a9fcf2 Mon Sep 17 00:00:00 2001
From: Guilherme Andrade <g@gandrade.net>
Date: Sat, 18 Mar 2017 19:48:23 +0000
Subject: rand: Support arbitrary normal distributions

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

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml
index 8745e16908..3a5d18dc35 100644
--- a/lib/stdlib/doc/src/rand.xml
+++ b/lib/stdlib/doc/src/rand.xml
@@ -119,6 +119,11 @@ S0 = rand:seed_s(exsplus),
    <pre>
 {SND0, S2} = rand:normal_s(S1),</pre>
 
+   <p>Create a normal deviate with mean -3 and variance 0.5:</p>
+
+   <pre>
+{ND0, S3} = rand:normal_s(-3, 0.5, S2),</pre>
+
     <note>
       <p>This random number generator is not cryptographically
         strong. If a strong cryptographic random number generator is
@@ -200,6 +205,15 @@ S0 = rand:seed_s(exsplus),
       </desc>
     </func>
 
+    <func>
+      <name name="normal" arity="2"/>
+      <fsummary>Return a normal distributed random float.</fsummary>
+      <desc>
+        <p>Returns a normal N(Mean, Variance) deviate float
+          and updates the state in the process dictionary.</p>
+      </desc>
+    </func>
+
     <func>
       <name name="normal_s" arity="1"/>
       <fsummary>Return a standard normal distributed random float.</fsummary>
@@ -210,6 +224,15 @@ S0 = rand:seed_s(exsplus),
       </desc>
     </func>
 
+    <func>
+      <name name="normal_s" arity="3"/>
+      <fsummary>Return a normal distributed random float.</fsummary>
+      <desc>
+        <p>Returns, for a specified state, a normal N(Mean, Variance)
+          deviate float and a new state.</p>
+      </desc>
+    </func>
+
     <func>
       <name name="seed" arity="1"/>
       <fsummary>Seed random number generator.</fsummary>
-- 
cgit v1.2.3