summaryrefslogtreecommitdiff
path: root/doc/source/reference/random/index.rst
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/index.rst
parente058ae46f534f675bb39e521eacc5874c0149c11 (diff)
downloadnumpy-3d19ae92ac3dc4fad7018112a3e293a5e4b283b1.tar.gz
MAINT: remove threefry32, xoroshiro128, xorshift1024 BitGenerators
Diffstat (limited to 'doc/source/reference/random/index.rst')
-rw-r--r--doc/source/reference/random/index.rst20
1 files changed, 4 insertions, 16 deletions
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