Deploy e350f98

Author: mhostetter

v0.4.x/.doctrees/api/galois.BCH.decode.doctree

@@ -76,3 +76,19 @@ tocdepth: 2
 ### Contributors
 
 - Matt Hostetter ([@mhostetter](https://github.com/mhostetter))
+
+## v0.4.5
+
+*Released April 13, 2025*
+
+### Changes
+
+- Improved performance of linear algebra over finite fields with prime order. This is achieved by using floating-point
+  BLAS implementations, where possible. A 10-100x performance improvement is seen. ([#596](https://github.com/mhostetter/galois/pull/596))
+- Upgrade documentation styling.
+
+### Contributors
+
+- Bogdan Reznychenko ([@theodotk](https://github.com/theodotk))
+- [@rafaelha](https://github.com/rafaelha)
+- Matt Hostetter ([@mhostetter](https://github.com/mhostetter))

v0.4.x/.doctrees/api/galois.BCH.detect.doctree

@@ -12311,10 +12311,10 @@
 <span class="gp">In [2]: </span><span class="n">GF</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">field</span>
 
 <span class="gp">In [3]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">(</span><span class="n">bch</span><span class="o">.</span><span class="n">k</span><span class="p">);</span> <span class="n">m</span>
-<span class="gh">Out[3]: </span><span class="go">GF([0, 1, 0, 1, 0, 0, 1], order=2)</span>
+<span class="gh">Out[3]: </span><span class="go">GF([1, 0, 0, 1, 1, 0, 1], order=2)</span>
 
 <span class="gp">In [4]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
-<span class="gh">Out[4]: </span><span class="go">GF([0, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 0, 0], order=2)</span>
+<span class="gh">Out[4]: </span><span class="go">GF([1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0], order=2)</span>
 </code></pre></div>
 </div>
 <p>Detect no errors in the valid codeword.</p>
@@ -12327,7 +12327,7 @@
 <span class="gh">Out[6]: </span><span class="go">5</span>
 
 <span class="gp">In [7]: </span><span class="n">c</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">bch</span><span class="o">.</span><span class="n">d</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span> <span class="o">^=</span> <span class="mi">1</span><span class="p">;</span> <span class="n">c</span>
-<span class="gh">Out[7]: </span><span class="go">GF([1, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 1, 0, 0, 0], order=2)</span>
+<span class="gh">Out[7]: </span><span class="go">GF([0, 1, 1, 0, 1, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0], order=2)</span>
 
 <span class="gp">In [8]: </span><span class="n">bch</span><span class="o">.</span><span class="n">detect</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 <span class="gh">Out[8]: </span><span class="go">True</span>
@@ -12341,10 +12341,10 @@
 <span class="gp">In [10]: </span><span class="n">GF</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">field</span>
 
 <span class="gp">In [11]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">(</span><span class="n">bch</span><span class="o">.</span><span class="n">k</span> <span class="o">-</span> <span class="mi">3</span><span class="p">);</span> <span class="n">m</span>
-<span class="gh">Out[11]: </span><span class="go">GF([1, 1, 1, 0], order=2)</span>
+<span class="gh">Out[11]: </span><span class="go">GF([1, 0, 1, 1], order=2)</span>
 
 <span class="gp">In [12]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
-<span class="gh">Out[12]: </span><span class="go">GF([1, 1, 1, 0, 1, 0, 0, 0, 1, 0, 0, 0], order=2)</span>
+<span class="gh">Out[12]: </span><span class="go">GF([1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1], order=2)</span>
 </code></pre></div>
 </div>
 <p>Detect no errors in the valid codeword.</p>
@@ -12357,7 +12357,7 @@
 <span class="gh">Out[14]: </span><span class="go">5</span>
 
 <span class="gp">In [15]: </span><span class="n">c</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">bch</span><span class="o">.</span><span class="n">d</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span> <span class="o">^=</span> <span class="mi">1</span><span class="p">;</span> <span class="n">c</span>
-<span class="gh">Out[15]: </span><span class="go">GF([0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 0, 0], order=2)</span>
+<span class="gh">Out[15]: </span><span class="go">GF([0, 1, 0, 0, 1, 0, 1, 1, 1, 1, 1, 1], order=2)</span>
 
 <span class="gp">In [16]: </span><span class="n">bch</span><span class="o">.</span><span class="n">detect</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 <span class="gh">Out[16]: </span><span class="go">True</span>
@@ -12372,15 +12372,15 @@
 
 <span class="gp">In [19]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="n">bch</span><span class="o">.</span><span class="n">k</span><span class="p">));</span> <span class="n">m</span>
 <span class="gh">Out[19]: </span>
-<span class="go">GF([[1, 1, 1, 0, 1, 0, 1],</span>
-<span class="go">    [1, 0, 0, 0, 0, 1, 0],</span>
-<span class="go">    [1, 1, 0, 0, 0, 0, 0]], order=2)</span>
+<span class="go">GF([[0, 0, 0, 1, 0, 1, 1],</span>
+<span class="go">    [0, 1, 0, 1, 1, 0, 0],</span>
+<span class="go">    [1, 1, 0, 1, 0, 1, 1]], order=2)</span>
 
 <span class="gp">In [20]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
 <span class="gh">Out[20]: </span>
-<span class="go">GF([[1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1],</span>
-<span class="go">    [1, 0, 0, 0, 0, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1],</span>
-<span class="go">    [1, 1, 0, 0, 0, 0, 0, 1, 0, 0, 1, 1, 1, 0, 0]], order=2)</span>
+<span class="go">GF([[0, 0, 0, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1],</span>
+<span class="go">    [0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 1],</span>
+<span class="go">    [1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1, 1]], order=2)</span>
 </code></pre></div>
 </div>
 <p>Detect no errors in the valid codewords.</p>
@@ -12400,9 +12400,9 @@
 
 <span class="gp">In [26]: </span><span class="n">c</span>
 <span class="gh">Out[26]: </span>
-<span class="go">GF([[0, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1],</span>
-<span class="go">    [0, 1, 0, 0, 0, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1],</span>
-<span class="go">    [0, 0, 1, 1, 0, 0, 0, 1, 0, 0, 1, 1, 1, 0, 0]], order=2)</span>
+<span class="go">GF([[1, 0, 0, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1],</span>
+<span class="go">    [1, 0, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 1],</span>
+<span class="go">    [0, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1, 1]], order=2)</span>
 
 <span class="gp">In [27]: </span><span class="n">bch</span><span class="o">.</span><span class="n">detect</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 <span class="gh">Out[27]: </span><span class="go">array([ True,  True,  True])</span>
@@ -12417,15 +12417,15 @@
 
 <span class="gp">In [30]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="n">bch</span><span class="o">.</span><span class="n">k</span> <span class="o">-</span> <span class="mi">3</span><span class="p">));</span> <span class="n">m</span>
 <span class="gh">Out[30]: </span>
-<span class="go">GF([[1, 1, 1, 1],</span>
+<span class="go">GF([[1, 0, 1, 0],</span>
 <span class="go">    [0, 0, 1, 1],</span>
-<span class="go">    [0, 1, 1, 0]], order=2)</span>
+<span class="go">    [1, 1, 0, 0]], order=2)</span>
 
 <span class="gp">In [31]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
 <span class="gh">Out[31]: </span>
-<span class="go">GF([[1, 1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1],</span>
+<span class="go">GF([[1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0],</span>
 <span class="go">    [0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0],</span>
-<span class="go">    [0, 1, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1]], order=2)</span>
+<span class="go">    [1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1]], order=2)</span>
 </code></pre></div>
 </div>
 <p>Detect no errors in the valid codewords.</p>
@@ -12445,9 +12445,9 @@
 
 <span class="gp">In [37]: </span><span class="n">c</span>
 <span class="gh">Out[37]: </span>
-<span class="go">GF([[0, 1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1],</span>
+<span class="go">GF([[0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0],</span>
 <span class="go">    [1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0],</span>
-<span class="go">    [1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 0, 1]], order=2)</span>
+<span class="go">    [0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1]], order=2)</span>
 
 <span class="gp">In [38]: </span><span class="n">bch</span><span class="o">.</span><span class="n">detect</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 <span class="gh">Out[38]: </span><span class="go">array([ True,  True,  True])</span>

v0.4.x/.doctrees/api/galois.BCH.doctree

@@ -12384,15 +12384,15 @@
 <span class="gp">In [2]: </span><span class="n">GF</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">field</span>
 
 <span class="gp">In [3]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">(</span><span class="n">bch</span><span class="o">.</span><span class="n">k</span><span class="p">);</span> <span class="n">m</span>
-<span class="gh">Out[3]: </span><span class="go">GF([0, 0, 0, 0, 1, 1, 0], order=2)</span>
+<span class="gh">Out[3]: </span><span class="go">GF([1, 1, 0, 1, 0, 0, 1], order=2)</span>
 
 <span class="gp">In [4]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
-<span class="gh">Out[4]: </span><span class="go">GF([0, 0, 0, 0, 1, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1], order=2)</span>
+<span class="gh">Out[4]: </span><span class="go">GF([1, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0, 0, 0, 0], order=2)</span>
 </code></pre></div>
 </div>
 <p>Compute the parity symbols only.</p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><code><span class="gp">In [5]: </span><span class="n">p</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;parity&quot;</span><span class="p">);</span> <span class="n">p</span>
-<span class="gh">Out[5]: </span><span class="go">GF([1, 0, 0, 1, 0, 1, 0, 1], order=2)</span>
+<span class="gh">Out[5]: </span><span class="go">GF([0, 1, 0, 1, 0, 0, 0, 0], order=2)</span>
 </code></pre></div>
 </div>
 </div>
@@ -12403,15 +12403,15 @@
 <span class="gp">In [7]: </span><span class="n">GF</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">field</span>
 
 <span class="gp">In [8]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">(</span><span class="n">bch</span><span class="o">.</span><span class="n">k</span> <span class="o">-</span> <span class="mi">3</span><span class="p">);</span> <span class="n">m</span>
-<span class="gh">Out[8]: </span><span class="go">GF([1, 0, 0, 0], order=2)</span>
+<span class="gh">Out[8]: </span><span class="go">GF([1, 1, 0, 0], order=2)</span>
 
 <span class="gp">In [9]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
-<span class="gh">Out[9]: </span><span class="go">GF([1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 1], order=2)</span>
+<span class="gh">Out[9]: </span><span class="go">GF([1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1], order=2)</span>
 </code></pre></div>
 </div>
 <p>Compute the parity symbols only.</p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><code><span class="gp">In [10]: </span><span class="n">p</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;parity&quot;</span><span class="p">);</span> <span class="n">p</span>
-<span class="gh">Out[10]: </span><span class="go">GF([0, 0, 0, 1, 1, 1, 0, 1], order=2)</span>
+<span class="gh">Out[10]: </span><span class="go">GF([1, 1, 1, 1, 1, 0, 1, 1], order=2)</span>
 </code></pre></div>
 </div>
 </div>
@@ -12423,23 +12423,23 @@
 
 <span class="gp">In [13]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="n">bch</span><span class="o">.</span><span class="n">k</span><span class="p">));</span> <span class="n">m</span>
 <span class="gh">Out[13]: </span>
-<span class="go">GF([[0, 0, 1, 1, 1, 1, 1],</span>
-<span class="go">    [0, 0, 1, 0, 1, 0, 1],</span>
-<span class="go">    [0, 1, 1, 1, 0, 0, 0]], order=2)</span>
+<span class="go">GF([[0, 1, 1, 1, 1, 0, 1],</span>
+<span class="go">    [0, 0, 1, 1, 0, 0, 1],</span>
+<span class="go">    [1, 1, 1, 0, 1, 1, 0]], order=2)</span>
 
 <span class="gp">In [14]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
 <span class="gh">Out[14]: </span>
-<span class="go">GF([[0, 0, 1, 1, 1, 1, 1, 0, 1, 1, 0, 0, 0, 1, 1],</span>
-<span class="go">    [0, 0, 1, 0, 1, 0, 1, 0, 0, 0, 0, 1, 1, 0, 1],</span>
-<span class="go">    [0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 1, 0, 0, 1, 1]], order=2)</span>
+<span class="go">GF([[0, 1, 1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0],</span>
+<span class="go">    [0, 0, 1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1, 0],</span>
+<span class="go">    [1, 1, 1, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1]], order=2)</span>
 </code></pre></div>
 </div>
 <p>Compute the parity symbols only.</p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><code><span class="gp">In [15]: </span><span class="n">p</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;parity&quot;</span><span class="p">);</span> <span class="n">p</span>
 <span class="gh">Out[15]: </span>
-<span class="go">GF([[0, 1, 1, 0, 0, 0, 1, 1],</span>
-<span class="go">    [0, 0, 0, 0, 1, 1, 0, 1],</span>
-<span class="go">    [0, 1, 0, 1, 0, 0, 1, 1]], order=2)</span>
+<span class="go">GF([[0, 1, 1, 0, 0, 1, 0, 0],</span>
+<span class="go">    [1, 1, 1, 1, 0, 1, 1, 0],</span>
+<span class="go">    [0, 0, 1, 1, 0, 0, 1, 1]], order=2)</span>
 </code></pre></div>
 </div>
 </div>
@@ -12451,23 +12451,23 @@
 
 <span class="gp">In [18]: </span><span class="n">m</span> <span class="o">=</span> <span class="n">GF</span><span class="o">.</span><span class="n">Random</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="n">bch</span><span class="o">.</span><span class="n">k</span> <span class="o">-</span> <span class="mi">3</span><span class="p">));</span> <span class="n">m</span>
 <span class="gh">Out[18]: </span>
-<span class="go">GF([[0, 0, 0, 0],</span>
-<span class="go">    [0, 1, 0, 0],</span>
-<span class="go">    [0, 0, 1, 1]], order=2)</span>
+<span class="go">GF([[0, 0, 1, 0],</span>
+<span class="go">    [1, 1, 0, 1],</span>
+<span class="go">    [1, 0, 1, 0]], order=2)</span>
 
 <span class="gp">In [19]: </span><span class="n">c</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">);</span> <span class="n">c</span>
 <span class="gh">Out[19]: </span>
-<span class="go">GF([[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],</span>
-<span class="go">    [0, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1, 0],</span>
-<span class="go">    [0, 0, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0]], order=2)</span>
+<span class="go">GF([[0, 0, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1],</span>
+<span class="go">    [1, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0],</span>
+<span class="go">    [1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0]], order=2)</span>
 </code></pre></div>
 </div>
 <p>Compute the parity symbols only.</p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><code><span class="gp">In [20]: </span><span class="n">p</span> <span class="o">=</span> <span class="n">bch</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;parity&quot;</span><span class="p">);</span> <span class="n">p</span>
 <span class="gh">Out[20]: </span>
-<span class="go">GF([[0, 0, 0, 0, 0, 0, 0, 0],</span>
-<span class="go">    [1, 1, 1, 0, 0, 1, 1, 0],</span>
-<span class="go">    [1, 0, 1, 0, 0, 0, 1, 0]], order=2)</span>
+<span class="go">GF([[0, 1, 1, 1, 0, 0, 1, 1],</span>
+<span class="go">    [0, 0, 1, 0, 1, 0, 1, 0],</span>
+<span class="go">    [0, 1, 1, 0, 1, 1, 1, 0]], order=2)</span>
 </code></pre></div>
 </div>
 </div>