Github Actions doc build after commit ab8661a

bashtage · Sep 26, 2024 · eb6736b · eb6736b
1 parent 9d77edb
commit eb6736b
Show file tree

Hide file tree

Showing 244 changed files with 14,061 additions and 1,332 deletions.
diff --git a/devel/_modules/index.html b/devel/_modules/index.html
@@ -13,7 +13,7 @@
 
 
 
-        <title>Overview: module code - RandomGen 2.0.1</title>
+        <title>Overview: module code - RandomGen v2.0.2 (+7)</title>
 
 
 
@@ -75,7 +75,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-header__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-header__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -85,7 +85,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            RandomGen 2.0.1
+            RandomGen v2.0.2 (+7)
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -172,10 +172,10 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-nav__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-nav__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
-    RandomGen 2.0.1
+    RandomGen v2.0.2 (+7)
   </label>
 
     <div class="md-nav__source">
@@ -517,6 +517,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="randomgen/sfmt.html">randomgen.sfmt</a></li>
 <li><a href="randomgen/speck128.html">randomgen.speck128</a></li>
 <li><a href="randomgen/threefry.html">randomgen.threefry</a></li>
+<li><a href="randomgen/tyche.html">randomgen.tyche</a></li>
 <li><a href="randomgen/wrapper.html">randomgen.wrapper</a></li>
 <li><a href="randomgen/xoroshiro128.html">randomgen.xoroshiro128</a></li>
 <li><a href="randomgen/xorshift1024.html">randomgen.xorshift1024</a></li>

diff --git a/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.cffi.rst.txt b/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.cffi.rst.txt
@@ -0,0 +1,6 @@
+randomgen.tyche.Tyche.cffi
+==========================
+
+.. currentmodule:: randomgen.tyche
+
+.. autoattribute:: Tyche.cffi
diff --git a/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.ctypes.rst.txt b/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.ctypes.rst.txt
@@ -0,0 +1,6 @@
+randomgen.tyche.Tyche.ctypes
+============================
+
+.. currentmodule:: randomgen.tyche
+
+.. autoattribute:: Tyche.ctypes
diff --git a/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.random_raw.rst.txt b/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.random_raw.rst.txt
@@ -0,0 +1,6 @@
+randomgen.tyche.Tyche.random\_raw
+=================================
+
+.. currentmodule:: randomgen.tyche
+
+.. automethod:: Tyche.random_raw
diff --git a/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.seed.rst.txt b/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.seed.rst.txt
@@ -0,0 +1,6 @@
+randomgen.tyche.Tyche.seed
+==========================
+
+.. currentmodule:: randomgen.tyche
+
+.. automethod:: Tyche.seed
diff --git a/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.state.rst.txt b/devel/_sources/bit_generators/generated/randomgen.tyche.Tyche.state.rst.txt
@@ -0,0 +1,6 @@
+randomgen.tyche.Tyche.state
+===========================
+
+.. currentmodule:: randomgen.tyche
+
+.. autoattribute:: Tyche.state
diff --git a/devel/_sources/bit_generators/index.rst.txt b/devel/_sources/bit_generators/index.rst.txt
@@ -37,6 +37,7 @@ These RNGs will be included in future releases.
    SFMT <sfmt>
    SPECK128 <speck128>
    ThreeFry <threefry>
+   Tyche <tyche>
    XoroShiro128+/++ <xoroshiro128>
    Xoshiro256** <xoshiro256>
    Xoshiro512** <xoshiro512>

diff --git a/devel/_sources/bit_generators/tyche.rst.txt b/devel/_sources/bit_generators/tyche.rst.txt
@@ -0,0 +1,32 @@
+Tyche PRNG
+----------
+
+.. module:: randomgen.tyche
+
+.. currentmodule:: randomgen.tyche
+
+.. autoclass:: Tyche
+
+Seeding and State
+=================
+
+.. autosummary::
+   :toctree: generated/
+
+   ~Tyche.seed
+   ~Tyche.state
+
+Extending
+=========
+.. autosummary::
+   :toctree: generated/
+
+   ~Tyche.cffi
+   ~Tyche.ctypes
+
+Testing
+=======
+.. autosummary::
+   :toctree: generated/
+
+   ~Tyche.random_raw
diff --git a/devel/_sources/change-log.rst.txt b/devel/_sources/change-log.rst.txt
@@ -3,6 +3,12 @@
 Change Log
 ----------
 
+v2.1.0 (Unreleased)
+===================
+- Added the :class:`~randomgen.tyche.Tyche` PRNG of Neves and Araujo. Supports
+  two variants. One is the original implementation in the 2012 paper. The
+  second matches the version in ``OpenRand``.
+
 v2.0.0
 ======
 - Final compatibility with NumPy 2

diff --git a/devel/_sources/custom-bit-generators.ipynb.txt b/devel/_sources/custom-bit-generators.ipynb.txt
@@ -373,7 +373,6 @@
    "source": [
     "import ctypes\n",
     "\n",
-    "import numpy as np\n",
     "from numba import cfunc, types, carray, jit\n",
     "\n",
     "from randomgen.wrapper import UserBitGenerator\n",

diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '2.0.1',
+    VERSION: 'v2.0.2 (+7)',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/devel/bit_generators/aesctr.html b/devel/bit_generators/aesctr.html
@@ -13,7 +13,7 @@
 
 
 
-        <title>AES Counter-based RNG - RandomGen 2.0.1</title>
+        <title>AES Counter-based RNG - RandomGen v2.0.2 (+7)</title>
 
 
 
@@ -80,7 +80,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-header__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-header__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -90,7 +90,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            RandomGen 2.0.1
+            RandomGen v2.0.2 (+7)
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -177,10 +177,10 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-nav__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-nav__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
-    RandomGen 2.0.1
+    RandomGen v2.0.2 (+7)
   </label>
 
     <div class="md-nav__source">
@@ -1154,6 +1154,21 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="tyche.html" class="md-nav__link">
+        <span title="/bit_generators/tyche.rst (reference label)" class="md-ellipsis">Tyche</span>
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="xoroshiro128.html" class="md-nav__link">
         <span title="/bit_generators/xoroshiro128.rst (reference label)" class="md-ellipsis">Xoro<wbr>Shiro128+/++</span>

diff --git a/devel/bit_generators/chacha.html b/devel/bit_generators/chacha.html
@@ -13,7 +13,7 @@
 
 
 
-        <title>ChaCha Cipher-based RNG - RandomGen 2.0.1</title>
+        <title>ChaCha Cipher-based RNG - RandomGen v2.0.2 (+7)</title>
 
 
 
@@ -80,7 +80,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-header__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-header__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -90,7 +90,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            RandomGen 2.0.1
+            RandomGen v2.0.2 (+7)
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -177,10 +177,10 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-nav__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-nav__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
-    RandomGen 2.0.1
+    RandomGen v2.0.2 (+7)
   </label>
 
     <div class="md-nav__source">
@@ -1044,6 +1044,21 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="tyche.html" class="md-nav__link">
+        <span title="/bit_generators/tyche.rst (reference label)" class="md-ellipsis">Tyche</span>
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="xoroshiro128.html" class="md-nav__link">
         <span title="/bit_generators/xoroshiro128.rst (reference label)" class="md-ellipsis">Xoro<wbr>Shiro128+/++</span>

diff --git a/devel/bit_generators/dsfmt.html b/devel/bit_generators/dsfmt.html
@@ -13,7 +13,7 @@
 
 
 
-        <title>Double SIMD Mersenne Twister (dSFMT) - RandomGen 2.0.1</title>
+        <title>Double SIMD Mersenne Twister (dSFMT) - RandomGen v2.0.2 (+7)</title>
 
 
 
@@ -80,7 +80,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-header__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-header__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
     <label class="md-header__button md-icon" for="__drawer">
@@ -90,7 +90,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            RandomGen 2.0.1
+            RandomGen v2.0.2 (+7)
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -177,10 +177,10 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../index.html" title="RandomGen 2.0.1" class="md-nav__button md-logo" aria-label="RandomGen 2.0.1" data-md-component="logo">
+    <a href="../index.html" title="RandomGen v2.0.2 (+7)" class="md-nav__button md-logo" aria-label="RandomGen v2.0.2 (+7)" data-md-component="logo">
       <img src="../_static/casino.svg" alt="logo">
     </a>
-    RandomGen 2.0.1
+    RandomGen v2.0.2 (+7)
   </label>
 
     <div class="md-nav__source">
@@ -1118,6 +1118,21 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="tyche.html" class="md-nav__link">
+        <span title="/bit_generators/tyche.rst (reference label)" class="md-ellipsis">Tyche</span>
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="xoroshiro128.html" class="md-nav__link">
         <span title="/bit_generators/xoroshiro128.rst (reference label)" class="md-ellipsis">Xoro<wbr>Shiro128+/++</span>