summaryrefslogtreecommitdiff
path: root/doc/source/reference/random/brng/pcg64.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/reference/random/brng/pcg64.rst')
-rw-r--r--doc/source/reference/random/brng/pcg64.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/source/reference/random/brng/pcg64.rst b/doc/source/reference/random/brng/pcg64.rst
new file mode 100644
index 000000000..93f026fcb
--- /dev/null
+++ b/doc/source/reference/random/brng/pcg64.rst
@@ -0,0 +1,43 @@
+Parallel Congruent Generator (64-bit, PCG64)
+--------------------------------------------
+
+.. module:: numpy.random.pcg64
+
+.. currentmodule:: numpy.random.pcg64
+
+.. autoclass:: PCG64
+ :exclude-members:
+
+Seeding and State
+=================
+
+.. autosummary::
+ :toctree: generated/
+
+ ~PCG64.seed
+ ~PCG64.state
+
+Parallel generation
+===================
+.. autosummary::
+ :toctree: generated/
+
+ ~PCG64.advance
+ ~PCG64.jump
+
+Random Generator
+================
+.. autosummary::
+ :toctree: generated/
+
+ ~PCG64.generator
+
+Extending
+=========
+.. autosummary::
+ :toctree: generated/
+
+ ~PCG64.cffi
+ ~PCG64.ctypes
+
+