summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2019-06-26 06:17:59 -0700
committerGitHub <noreply@github.com>2019-06-26 06:17:59 -0700
commit60ede65d0d1ba546eb6da3764b55c061a11a7a80 (patch)
treee401808d0fffe76ee57b866a40a3f28677f8b82d /doc/source
parent4668b46310e74b2f3c78eb213b6d796456278942 (diff)
parent42f8ed33dbc8c911a63a73df91e298505019eefc (diff)
downloadnumpy-60ede65d0d1ba546eb6da3764b55c061a11a7a80.tar.gz
Merge pull request #13838 from rkern/sfc64
ENH: SFC64 BitGenerator
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/reference/random/bit_generators/index.rst1
-rw-r--r--doc/source/reference/random/bit_generators/sfc64.rst28
-rw-r--r--doc/source/reference/random/performance.py4
3 files changed, 31 insertions, 2 deletions
diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst
index 7f88231bd..9907988fa 100644
--- a/doc/source/reference/random/bit_generators/index.rst
+++ b/doc/source/reference/random/bit_generators/index.rst
@@ -19,6 +19,7 @@ access the functions provided, e.g., `numba <https://numba.pydata.org>`_.
MT19937 <mt19937>
PCG64 <pcg64>
Philox <philox>
+ SFC64 <sfc64>
Seeding and Entropy
-------------------
diff --git a/doc/source/reference/random/bit_generators/sfc64.rst b/doc/source/reference/random/bit_generators/sfc64.rst
new file mode 100644
index 000000000..dc03820ae
--- /dev/null
+++ b/doc/source/reference/random/bit_generators/sfc64.rst
@@ -0,0 +1,28 @@
+SFC64 Small Fast Chaotic PRNG
+-----------------------------
+
+.. module:: numpy.random.sfc64
+
+.. currentmodule:: numpy.random.sfc64
+
+.. autoclass:: SFC64
+ :exclude-members:
+
+State
+=====
+
+.. autosummary::
+ :toctree: generated/
+
+ ~SFC64.state
+
+Extending
+=========
+.. autosummary::
+ :toctree: generated/
+
+ ~SFC64.cffi
+ ~SFC64.ctypes
+
+
+
diff --git a/doc/source/reference/random/performance.py b/doc/source/reference/random/performance.py
index aeb82e086..ed8745078 100644
--- a/doc/source/reference/random/performance.py
+++ b/doc/source/reference/random/performance.py
@@ -4,9 +4,9 @@ from timeit import repeat
import pandas as pd
import numpy as np
-from numpy.random import MT19937, ThreeFry, PCG64, Philox
+from numpy.random import MT19937, PCG64, Philox, SFC64
-PRNGS = [MT19937, PCG64, Philox, ThreeFry]
+PRNGS = [MT19937, PCG64, Philox, SFC64]
funcs = OrderedDict()
integers = 'integers(0, 2**{bits},size=1000000, dtype="uint{bits}")'