Skip to content

Commit

Permalink
Update docs to output generated at 9c83cd8
Browse files Browse the repository at this point in the history
  • Loading branch information
cforeman-cqc committed Jan 16, 2024
1 parent 58cedac commit 830e116
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions _modules/cryptomite/circulant.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@
<h1>Source code for cryptomite.circulant</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Circulant is a seeded extractor that takes an input of</span>
<span class="sd">n - 1 bits and a seed of n bits, where n is prime, to</span>
<span class="sd">produce some error-perfect random bits.</span>
<span class="sd">n bits and a seed of n + 1 bits, where n + 1 is prime,</span>
<span class="sd">to produce some error-perfect random bits.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>

Expand All @@ -93,7 +93,7 @@ <h1>Source code for cryptomite.circulant</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Circulant"><a class="viewcode-back" href="../../cryptomite.html#cryptomite.circulant.Circulant">[docs]</a><span class="k">class</span> <span class="nc">Circulant</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Circulant extractor based on [Foreman23]_. &quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Circulant extractor based on [For2024]_. &quot;&quot;&quot;</span>
<div class="viewcode-block" id="Circulant.__init__"><a class="viewcode-back" href="../../cryptomite.html#cryptomite.circulant.Circulant.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">m</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a Circulant Extractor.</span>

Expand Down
6 changes: 3 additions & 3 deletions cryptomite.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<section id="cryptomite-circulant-module">
<h2>cryptomite.circulant module<a class="headerlink" href="#cryptomite-circulant-module" title="Permalink to this headline"></a></h2>
<span class="target" id="module-cryptomite.circulant"></span><p>Circulant is a seeded extractor that takes an input of
n - 1 bits and a seed of n bits, where n is prime, to
produce some error-perfect random bits.</p>
n bits and a seed of n + 1 bits, where n + 1 is prime,
to produce some error-perfect random bits.</p>
<dl class="py class">
<dt class="sig sig-object py" id="cryptomite.circulant.Circulant">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cryptomite.circulant.</span></span><span class="sig-name descname"><span class="pre">Circulant</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">m</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cryptomite/circulant.html#Circulant"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cryptomite.circulant.Circulant" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Circulant extractor based on <span id="id1">[Foreman23]</span>.</p>
<p>Circulant extractor based on <a class="reference internal" href="bibliography.html#for2024" id="id1"><span>[For2024]</span></a>.</p>
<dl class="py method">
<dt class="sig sig-object py" id="cryptomite.circulant.Circulant.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">m</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cryptomite/circulant.html#Circulant.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cryptomite.circulant.Circulant.__init__" title="Permalink to this definition"></a></dt>
Expand Down
Loading

0 comments on commit 830e116

Please sign in to comment.