summaryrefslogtreecommitdiff
path: root/doc/source/reference/random/bit_generators
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2019-11-19 07:44:44 -0700
committerCharles Harris <charlesr.harris@gmail.com>2019-11-19 07:44:44 -0700
commitd6ecf67f88fb61cf641e2370d3e54938232de09d (patch)
tree08223e6b70fd71d0b11d378ca02f96d56c715d74 /doc/source/reference/random/bit_generators
parent53201578225cc89d383738598acec03572554019 (diff)
downloadnumpy-d6ecf67f88fb61cf641e2370d3e54938232de09d.tar.gz
API: restructure and document numpy.random C-API (#14604)
* API: restructure and document numpy.random C-API * DOC: fix bad reference * API: ship, document, and start to test numpy.random C-API examples * API, DOC, TST: fix tests, refactor documentation to include snippets * BUILD: move public headers to numpy/core/include/numpy/random * TST: ignore DeprecationWarnings in setuptools and numba * DOC: document the C-API as used from Cython
Diffstat (limited to 'doc/source/reference/random/bit_generators')
-rw-r--r--doc/source/reference/random/bit_generators/index.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst
index 94d3d8a3c..315657172 100644
--- a/doc/source/reference/random/bit_generators/index.rst
+++ b/doc/source/reference/random/bit_generators/index.rst
@@ -19,7 +19,7 @@ The included BitGenerators are:
and can be advanced by an arbitrary amount. See the documentation for
:meth:`~.PCG64.advance`. PCG-64 has a period of :math:`2^{128}`. See the `PCG
author's page`_ for more details about this class of PRNG.
-* MT19937 - The standard Python BitGenerator. Adds a `~mt19937.MT19937.jumped`
+* MT19937 - The standard Python BitGenerator. Adds a `MT19937.jumped`
function that returns a new generator with state as-if :math:`2^{128}` draws have
been made.
* Philox - A counter-based generator capable of being advanced an