summaryrefslogtreecommitdiff
path: root/doc/source/reference/random/bit_generators
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/bit_generators
parente058ae46f534f675bb39e521eacc5874c0149c11 (diff)
downloadnumpy-3d19ae92ac3dc4fad7018112a3e293a5e4b283b1.tar.gz
MAINT: remove threefry32, xoroshiro128, xorshift1024 BitGenerators
Diffstat (limited to 'doc/source/reference/random/bit_generators')
-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
4 files changed, 0 insertions, 118 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
-
-