diff options
| author | mattip <matti.picus@gmail.com> | 2019-10-13 09:13:05 +0300 |
|---|---|---|
| committer | mattip <matti.picus@gmail.com> | 2019-10-13 09:13:05 +0300 |
| commit | 185efe1bb746ad5b6ac23d106df12ad35a207d49 (patch) | |
| tree | 737b9dd102c576756910764aa12da74c099b50b5 /doc/source/reference/random/bit_generators | |
| parent | 260bf67640724915ffefd0a5a7133318ece149da (diff) | |
| download | numpy-185efe1bb746ad5b6ac23d106df12ad35a207d49.tar.gz | |
DOC: clean up for moved references, remove ISeedSequence
Diffstat (limited to 'doc/source/reference/random/bit_generators')
| -rw-r--r-- | doc/source/reference/random/bit_generators/bitgenerators.rst | 11 | ||||
| -rw-r--r-- | doc/source/reference/random/bit_generators/index.rst | 21 |
2 files changed, 10 insertions, 22 deletions
diff --git a/doc/source/reference/random/bit_generators/bitgenerators.rst b/doc/source/reference/random/bit_generators/bitgenerators.rst deleted file mode 100644 index 11d80e7df..000000000 --- a/doc/source/reference/random/bit_generators/bitgenerators.rst +++ /dev/null @@ -1,11 +0,0 @@ -:orphan: - -BitGenerator ------------- - -.. currentmodule:: numpy.random._bit_generator - -.. autosummary:: - :toctree: generated/ - - BitGenerator diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst index e4646dce5..c5b6123aa 100644 --- a/doc/source/reference/random/bit_generators/index.rst +++ b/doc/source/reference/random/bit_generators/index.rst @@ -1,5 +1,3 @@ -.. _bit_generator: - .. currentmodule:: numpy.random Bit Generators @@ -35,14 +33,18 @@ The included BitGenerators are: .. _`Random123`: https://www.deshawresearch.com/resources_random123.html .. _`SFC author's page`: http://pracrand.sourceforge.net/RNG_engines.txt +.. autosummary:: + :toctree: generated/ + + BitGenerator + .. toctree:: :maxdepth: 1 - BitGenerator <bitgenerators> - MT19937 <mt19937> - PCG64 <pcg64> - Philox <philox> - SFC64 <sfc64> + MT19937 <mt19937> + PCG64 <pcg64> + Philox <philox> + SFC64 <sfc64> Seeding and Entropy ------------------- @@ -53,7 +55,7 @@ seed. All of the provided BitGenerators will take an arbitrary-sized non-negative integer, or a list of such integers, as a seed. BitGenerators need to take those inputs and process them into a high-quality internal state for the BitGenerator. All of the BitGenerators in numpy delegate that task to -`~SeedSequence`, which uses hashing techniques to ensure that even low-quality +`SeedSequence`, which uses hashing techniques to ensure that even low-quality seeds generate high-quality initial states. .. code-block:: python @@ -107,6 +109,3 @@ convenient ways. :toctree: generated/ SeedSequence - _bit_generator.ISeedSequence - _bit_generator.ISpawnableSeedSequence - _bit_generator.SeedlessSeedSequence |