Skip to content

Commit d4e9d98

Browse files
Mention statistical independence of members of set of generators
Also refer to examples/ folder for example of Parallel Monte-Carlo simulation.
1 parent b7c5b5b commit d4e9d98

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

docs/source/reference/mt2203.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
MT2203 brng
22
===========
33

4-
Each generator from the set of 6024 Mersenne Twister pseudorandom number generators can be
5-
initialized with either an integral seed, a list of integral seeds, or automatically.
4+
Each generator from the set of `6024 Mersenne Twister pseudorandom number generators <philoxrng_>`_ can be
5+
initialized with either an integral seed, a list of integral seeds, or automatically.
66

77
An individual member of the set can be addressed by using a tuple to specify the generator
8-
:code:`brng=("MT2203", set_id)` where :math:`0 \leq \text{set_id} \le 6024`.
8+
:code:`brng=("MT2203", set_id)` where :math:`0 \leq \text{set_id} < 6024`.
99

1010
.. code-block:: python
1111
:caption: Construction for MT2203 basic random number generator with scalar seed
@@ -44,3 +44,10 @@ When seed is not specified, the generator is initialized using system clock, e.g
4444
# Use random state instance to generate 1000 random numbers
4545
# from discrete uniform distribution [1, 6]
4646
isample = rs_def.randint(1, 6 + 1, size=1000)
47+
48+
Different members of the set of generators initialized with the same seed are designed to generate
49+
statistically independent streams of randomness. This property makes MT2203 generator suitable for
50+
parallelizing stochastic algorithms. Please refer to "examples/" folder in the `GitHub repo
51+
<https://github.com/IntelPython/mkl_random>`_.
52+
53+
.. _philoxrng: https://spec.oneapi.io/versions/1.0-rev-2/elements/oneMKL/source/domains/rng/mkl-rng-philox4x32x10.html

docs/source/reference/wichmann_hill.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Wichmann-Hill brng
22
==================
33

44
Each generator from the set of 273 Wichmann-Hill’s combined multiplicative congruential
5-
generators can be initialized with either an integral seed, a list of integral seeds,
5+
`generators <whrng_>`_ can be initialized with either an integral seed, a list of integral seeds,
66
or automatically.
77

88
An individual member of the set can be addressed by using a tuple to specify the generator as
9-
:code:`brng=("WH", set_id)` where :math:`0 \leq \text{set_id} \le 273`.
9+
:code:`brng=("WH", set_id)` where :math:`0 \leq \text{set_id} < 273`.
1010

1111
.. code-block:: python
1212
:caption: Construction for WH basic random number generator with scalar seed
@@ -45,3 +45,10 @@ When seed is not specified, the generator is initialized using system clock, e.g
4545
# Use random state instance to generate 1000 random numbers
4646
# from discrete uniform distribution [1, 6]
4747
isample = rs_def.randint(1, 6 + 1, size=1000)
48+
49+
Different members of the set of generators initialized with the same seed are designed to generate
50+
statistically independent streams of randomness. This property makes MT2203 generator suitable for
51+
parallelizing stochastic algorithms. Please refer to "examples/" folder in the `GitHub repo
52+
<https://github.com/IntelPython/mkl_random>`_.
53+
54+
.. _whrng: https://spec.oneapi.io/versions/1.0-rev-2/elements/oneMKL/source/domains/rng/mkl-rng-wichmann_hill.html

0 commit comments

Comments
 (0)