summaryrefslogtreecommitdiff
path: root/doc/source/reference/random
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2019-05-20 23:06:48 +0300
committermattip <matti.picus@gmail.com>2019-05-20 23:23:36 +0300
commit3d19ae92ac3dc4fad7018112a3e293a5e4b283b1 (patch)
tree9e2846f113d3b4dff7504d980a3f4cb803cacc1e /doc/source/reference/random
parente058ae46f534f675bb39e521eacc5874c0149c11 (diff)
downloadnumpy-3d19ae92ac3dc4fad7018112a3e293a5e4b283b1.tar.gz
MAINT: remove threefry32, xoroshiro128, xorshift1024 BitGenerators
Diffstat (limited to 'doc/source/reference/random')
-rw-r--r--doc/source/reference/random/bit_generators/index.rst12
-rw-r--r--doc/source/reference/random/bit_generators/threefry32.rst36
-rw-r--r--doc/source/reference/random/bit_generators/xoroshiro128.rst35
-rw-r--r--doc/source/reference/random/bit_generators/xorshift1024.rst35
-rw-r--r--doc/source/reference/random/index.rst20
-rw-r--r--doc/source/reference/random/new-or-different.rst8
6 files changed, 8 insertions, 138 deletions
diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst
index e3ca073c9..5fcb6ce37 100644
--- a/doc/source/reference/random/bit_generators/index.rst
+++ b/doc/source/reference/random/bit_generators/index.rst
@@ -22,18 +22,6 @@ Stable RNGs
MT19937 <mt19937>
Philox <philox>
ThreeFry <threefry>
- XoroShiro128+ <xoroshiro128>
- Xorshift1024*φ <xorshift1024>
Xoshiro256** <xoshiro256>
Xoshiro512** <xoshiro512>
-
-Experimental RNGs
-=================
-
-These BitGenerators are currently included but are may not be permanent.
-
-.. toctree::
- :maxdepth: 1
-
- ThreeFry32 <threefry32>
diff --git a/doc/source/reference/random/bit_generators/threefry32.rst b/doc/source/reference/random/bit_generators/threefry32.rst
deleted file mode 100644
index 1af9491a6..000000000
--- a/doc/source/reference/random/bit_generators/threefry32.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-ThreeFry32 Counter-based RNG
-----------------------------
-
-.. module:: numpy.random.threefry32
-
-.. currentmodule:: numpy.random.threefry32
-
-.. autoclass:: ThreeFry32
- :exclude-members:
-
-Seeding and State
-=================
-
-.. autosummary::
- :toctree: generated/
-
- ~ThreeFry32.seed
- ~ThreeFry32.state
-
-Parallel generation
-===================
-.. autosummary::
- :toctree: generated/
-
- ~ThreeFry32.advance
- ~ThreeFry32.jumped
-
-Extending
-=========
-.. autosummary::
- :toctree: generated/
-
- ~ThreeFry32.cffi
- ~ThreeFry32.ctypes
-
-
diff --git a/doc/source/reference/random/bit_generators/xoroshiro128.rst b/doc/source/reference/random/bit_generators/xoroshiro128.rst
deleted file mode 100644
index 41f5238fc..000000000
--- a/doc/source/reference/random/bit_generators/xoroshiro128.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-Xoroshiro128+
--------------
-
-.. module:: numpy.random.xoroshiro128
-
-.. currentmodule:: numpy.random.xoroshiro128
-
-.. autoclass:: Xoroshiro128
- :exclude-members:
-
-Seeding and State
-=================
-
-.. autosummary::
- :toctree: generated/
-
- ~Xoroshiro128.seed
- ~Xoroshiro128.state
-
-Parallel generation
-===================
-.. autosummary::
- :toctree: generated/
-
- ~Xoroshiro128.jumped
-
-Extending
-=========
-.. autosummary::
- :toctree: generated/
-
- ~Xoroshiro128.cffi
- ~Xoroshiro128.ctypes
-
-
diff --git a/doc/source/reference/random/bit_generators/xorshift1024.rst b/doc/source/reference/random/bit_generators/xorshift1024.rst
deleted file mode 100644
index 5d0c9048f..000000000
--- a/doc/source/reference/random/bit_generators/xorshift1024.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-Xorshift1024*φ
---------------
-
-.. module:: numpy.random.xorshift1024
-
-.. currentmodule:: numpy.random.xorshift1024
-
-.. autoclass:: Xorshift1024
- :exclude-members:
-
-Seeding and State
-=================
-
-.. autosummary::
- :toctree: generated/
-
- ~Xorshift1024.seed
- ~Xorshift1024.state
-
-Parallel generation
-===================
-.. autosummary::
- :toctree: generated/
-
- ~Xorshift1024.jumped
-
-Extending
-=========
-.. autosummary::
- :toctree: generated/
-
- ~Xorshift1024.cffi
- ~Xorshift1024.ctypes
-
-
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst
index 032db8562..45b5ed2c0 100644
--- a/doc/source/reference/random/index.rst
+++ b/doc/source/reference/random/index.rst
@@ -30,7 +30,7 @@ instance's methods are imported into the numpy.random namespace, see
Quick Start
-----------
-By default, `Generator` uses normals provided by `xoroshiro128.Xoroshiro128`
+By default, `Generator` uses normals provided by `xoshiro256.Xoshiro256`
which will be faster than the legacy methods in `RandomState`
.. code-block:: python
@@ -40,7 +40,7 @@ which will be faster than the legacy methods in `RandomState`
random.standard_normal()
`Generator` can be used as a direct replacement for `~RandomState`, although
-the random values are generated by `~xoroshiro128.Xoroshiro128`. The
+the random values are generated by `~xoshiro256.Xoshiro256`. The
`Generator` holds an instance of a BitGenerator. It is accessable as
``gen.bit_generator``.
@@ -120,8 +120,8 @@ What's New or Different
source of randomness that is used in cryptographic applications (e.g.,
``/dev/urandom`` on Unix).
* All BitGenerators can produce doubles, uint64s and uint32s via CTypes
- (`~xoroshiro128.Xoroshiro128.ctypes`) and CFFI
- (:meth:`~xoroshiro128.Xoroshiro128.cffi`). This allows the bit generators to
+ (`~xoshiro256.Xoshiro256.ctypes`) and CFFI
+ (:meth:`~xoshiro256.Xoshiro256.cffi`). This allows the bit generators to
be used in numba.
* The bit generators can be used in downstream projects via
:ref:`Cython <randomgen_cython>`.
@@ -157,18 +157,6 @@ The included BitGenerators are:
the same, but with a different state and so it is not possible to produce a
sequence identical to MT19937. Supports ``jumped`` and so can
be used in parallel applications. See the `dSFMT authors' page`_.
-* XoroShiro128+ - Improved version of XorShift128+ with better performance
- and statistical quality. Like the XorShift generators, it can be jumped
- to produce multiple streams in parallel applications. See
- `~xoroshiro128.Xoroshiro128.jumped` for details.
- More information about this bit generator is available at the
- `xorshift, xoroshiro and xoshiro authors' page`_.
-* XorShift1024*φ - Fast fast generator based on the XSadd
- generator. Supports ``jumped`` and so can be used in
- parallel applications. See the documentation for
- `~xorshift1024.Xorshift1024.jumped` for details. More
- information about these bit generators is available at the
- `xorshift, xoroshiro and xoshiro authors' page`_.
* Xorshiro256** and Xorshiro512** - The most recently introduced XOR,
shift, and rotate generator. Supports ``jumped`` and so can be used in
parallel applications. See the documentation for
diff --git a/doc/source/reference/random/new-or-different.rst b/doc/source/reference/random/new-or-different.rst
index 906cceceb..969a9372d 100644
--- a/doc/source/reference/random/new-or-different.rst
+++ b/doc/source/reference/random/new-or-different.rst
@@ -58,8 +58,8 @@ And in more detail:
This replaces both ``randint`` and the deprecated ``random_integers``.
* The Box-Muller used to produce NumPy's normals is no longer available.
* All bit generators can produce doubles, uint64s and
- uint32s via CTypes (`~.xoroshiro128.Xoroshiro128.
- ctypes`) and CFFI (`~.xoroshiro128.Xoroshiro128.cffi`).
+ uint32s via CTypes (`~.xoshiro256.Xoshiro256.
+ ctypes`) and CFFI (`~.xoshiro256.Xoshiro256.cffi`).
This allows these bit generators to be used in numba.
* The bit generators can be used in downstream projects via
Cython.
@@ -67,9 +67,9 @@ And in more detail:
.. ipython:: python
- from numpy.random import Generator, Xoroshiro128
+ from numpy.random import Generator, Xoshiro256
import numpy.random
- rg = Generator(Xoroshiro128())
+ rg = Generator(Xoshiro256())
%timeit rg.standard_normal(100000)
%timeit numpy.random.standard_normal(100000)