summaryrefslogtreecommitdiff
path: root/doc/classes/RandomNumberGenerator.xml
diff options
context:
space:
mode:
authorYuri Roubinsky <chaosus89@gmail.com>2019-04-07 08:32:04 +0300
committerGitHub <noreply@github.com>2019-04-07 08:32:04 +0300
commit134be5c728a8e54fe248c654daa30986d2153c1b (patch)
tree05d8027b550bd462b9377568fe7faf15e12f70e3 /doc/classes/RandomNumberGenerator.xml
parentde825df1210089b4f8427618bb758101d5ad379b (diff)
parent5f137925dccd8a7facc34d05d2652af6d03285ba (diff)
Merge pull request #27043 from Chaosus/randfn
Added gaussian distribution function to RNG
Diffstat (limited to 'doc/classes/RandomNumberGenerator.xml')
-rw-r--r--doc/classes/RandomNumberGenerator.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml
index 6fa2d44fd0..07c9f2a74b 100644
--- a/doc/classes/RandomNumberGenerator.xml
+++ b/doc/classes/RandomNumberGenerator.xml
@@ -28,6 +28,17 @@
Generates pseudo-random float between [code]from[/code] and [code]to[/code].
</description>
</method>
+ <method name="randfn">
+ <return type="float">
+ </return>
+ <argument index="0" name="mean" type="float" default="0.0">
+ </argument>
+ <argument index="1" name="deviation" type="float" default="1.0">
+ </argument>
+ <description>
+ Generates normally(gaussian) distributed pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code].
+ </description>
+ </method>
<method name="randi">
<return type="int">
</return>