diff options
| author | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2022-06-09 00:25:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-08 15:25:09 -0700 |
| commit | 3523b578f60b4b584f951f0ffaf89703bc3e07b3 (patch) | |
| tree | 0628cd0da56f551cdbf25f976ca3e598404d9359 /doc/source/reference/random/bit_generators | |
| parent | 126046f84449fffeb0c75ae88657ce6b90236eee (diff) | |
| download | numpy-3523b578f60b4b584f951f0ffaf89703bc3e07b3.tar.gz | |
DOC: RST Titles Underline reordering (#21677)
* ~ not ^
* = skipped for -
* swap - and = underline in files they are swapped
* * to = in header underline
* - to = and * to - for consitency
* A few more change * -> ~
* use ~ instead of +
* DOC: Fixup `c-api/array.rst` with further ^ with ~ replacement
There is still a fourth level here, which remains using "
Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net>
Diffstat (limited to 'doc/source/reference/random/bit_generators')
6 files changed, 22 insertions, 22 deletions
diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst index 211f0d60e..d93f38d0b 100644 --- a/doc/source/reference/random/bit_generators/index.rst +++ b/doc/source/reference/random/bit_generators/index.rst @@ -1,7 +1,7 @@ .. currentmodule:: numpy.random Bit Generators --------------- +============== The random values produced by :class:`~Generator` originate in a BitGenerator. The BitGenerators do not directly provide @@ -11,7 +11,7 @@ low-level wrappers for consumption by code that can efficiently access the functions provided, e.g., `numba <https://numba.pydata.org>`_. Supported BitGenerators -======================= +----------------------- The included BitGenerators are: @@ -51,7 +51,7 @@ The included BitGenerators are: SFC64 <sfc64> Seeding and Entropy -------------------- +=================== A BitGenerator provides a stream of random values. In order to generate reproducible streams, BitGenerators support setting their initial state via a diff --git a/doc/source/reference/random/bit_generators/mt19937.rst b/doc/source/reference/random/bit_generators/mt19937.rst index d05ea7c6f..e85234d10 100644 --- a/doc/source/reference/random/bit_generators/mt19937.rst +++ b/doc/source/reference/random/bit_generators/mt19937.rst @@ -1,5 +1,5 @@ Mersenne Twister (MT19937) --------------------------- +========================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Mersenne Twister (MT19937) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,14 +16,14 @@ State ~MT19937.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ ~MT19937.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/pcg64.rst b/doc/source/reference/random/bit_generators/pcg64.rst index 889965f77..6ebd34f4a 100644 --- a/doc/source/reference/random/bit_generators/pcg64.rst +++ b/doc/source/reference/random/bit_generators/pcg64.rst @@ -1,5 +1,5 @@ Permuted Congruential Generator (64-bit, PCG64) ------------------------------------------------ +=============================================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Permuted Congruential Generator (64-bit, PCG64) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~PCG64.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~PCG64.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/pcg64dxsm.rst b/doc/source/reference/random/bit_generators/pcg64dxsm.rst index e37efa5d3..99e4d15c9 100644 --- a/doc/source/reference/random/bit_generators/pcg64dxsm.rst +++ b/doc/source/reference/random/bit_generators/pcg64dxsm.rst @@ -1,5 +1,5 @@ Permuted Congruential Generator (64-bit, PCG64 DXSM) ----------------------------------------------------- +==================================================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Permuted Congruential Generator (64-bit, PCG64 DXSM) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~PCG64DXSM.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~PCG64DXSM.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/philox.rst b/doc/source/reference/random/bit_generators/philox.rst index 3c2fa4cc5..4df364653 100644 --- a/doc/source/reference/random/bit_generators/philox.rst +++ b/doc/source/reference/random/bit_generators/philox.rst @@ -1,5 +1,5 @@ Philox Counter-based RNG ------------------------- +======================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Philox Counter-based RNG :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~Philox.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~Philox.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/sfc64.rst b/doc/source/reference/random/bit_generators/sfc64.rst index 8cb255bc1..6ea9593c2 100644 --- a/doc/source/reference/random/bit_generators/sfc64.rst +++ b/doc/source/reference/random/bit_generators/sfc64.rst @@ -1,5 +1,5 @@ SFC64 Small Fast Chaotic PRNG ------------------------------ +============================= .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ SFC64 Small Fast Chaotic PRNG :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~SFC64.state Extending -========= +--------- .. autosummary:: :toctree: generated/ |