Deploy 7f8df89

v0.3.x/api/galois.Array.Identity/index.html

@@ -7792,14 +7792,14 @@
 
 <dl class="py method objdesc">
 <dt class="sig sig-object highlight sig-wrap py">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">galois.</span><span class="pre">Array.</span></span><span class="sig-name descname"><span class="pre">Identity</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-size" title="galois.Array.Identity.size (Python parameter) — The size $n$ along one dimension of the identity matrix."><span class="n"><span class="pre">size</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-dtype" title="galois.Array.Identity.dtype (Python parameter) — The numpy.dtype of the array elements. The default is None which represents the smallest unsigned data type for this Array subclass (the first element in dtypes)."><span class="n"><span class="pre">dtype</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type."><span class="pre">DTypeLike</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><span class="pre">Self</span></span></span></span></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">galois.</span><span class="pre">Array.</span></span><span class="sig-name descname"><span class="pre">Identity</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-size" title="galois.Array.Identity.size (Python parameter) — The size $n$ along one dimension of the identity matrix."><span class="n"><span class="pre">size</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-dtype" title="galois.Array.Identity.dtype (Python parameter) — The numpy.dtype of the array elements. The default is None which represents the smallest unsigned data type for this Array subclass (the first element in dtypes)."><span class="n"><span class="pre">dtype</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type."><span class="pre">DTypeLike</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><span class="pre">Self</span></span></span></span></dt>
 <dd><p>Creates an <span class="math notranslate nohighlight">\(n \times n\)</span> identity matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd" id="parameters">Parameters<span class="colon">:</span><a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></dt>
 <dd class="field-odd"><dl class="simple api-field highlight">
-<dt id="p-size"><span class="n sig-name">size</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a></span></span><a class="headerlink" href="#p-size" title="Permalink to this definition">¶</a></dt><dd><p>The size <span class="math notranslate nohighlight">\(n\)</span> along one dimension of the identity matrix.</p>
+<dt id="p-size"><span class="n sig-name">size</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></span></span><a class="headerlink" href="#p-size" title="Permalink to this definition">¶</a></dt><dd><p>The size <span class="math notranslate nohighlight">\(n\)</span> along one dimension of the identity matrix.</p>
 </dd>
-<dt id="p-dtype"><span class="n sig-name">dtype</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type.">DTypeLike</a><span class="w">   </span><span class="p">|</span><span class="w">   </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)">None</a></span></span><span class="w">   </span><span class="o">=</span><span class="w">   </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#p-dtype" title="Permalink to this definition">¶</a></dt><dd><p>The <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.dtype</span></code></a> of the array elements. The default is <code class="code highlight python docutils literal highlight-python"><span class="kc">None</span></code> which represents the smallest
+<dt id="p-dtype"><span class="n sig-name">dtype</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type.">DTypeLike</a><span class="w">   </span><span class="p">|</span><span class="w">   </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)">None</a></span></span><span class="w">   </span><span class="o">=</span><span class="w">   </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#p-dtype" title="Permalink to this definition">¶</a></dt><dd><p>The <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.dtype</span></code></a> of the array elements. The default is <code class="code highlight python docutils literal highlight-python"><span class="kc">None</span></code> which represents the smallest
 unsigned data type for this <a class="reference internal" href="../galois.Array/" title="galois.Array (Python class) — An abstract ndarray subclass over a Galois field or Galois ring."><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a> subclass (the first element in
 <a class="reference internal" href="../galois.Array.dtypes/" title="galois.Array.dtypes (Python property) — List of valid integer numpy.dtype values that are compatible with this Galois field or Galois ring."><code class="xref py py-obj docutils literal notranslate"><span class="pre">dtypes</span></code></a>).</p>
 </dd>

v0.3.x/api/galois.Array.Ones/index.html

@@ -7792,14 +7792,14 @@
 
 <dl class="py method objdesc">
 <dt class="sig sig-object highlight sig-wrap py">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">galois.</span><span class="pre">Array.</span></span><span class="sig-name descname"><span class="pre">Ones</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-shape" title="galois.Array.Ones.shape (Python parameter) — A NumPy-compliant shape tuple."><span class="n"><span class="pre">shape</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.ShapeLike/" title="galois.typing.ShapeLike (Python data) — A Union representing objects that can be coerced into a NumPy shape tuple."><span class="pre">ShapeLike</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-dtype" title="galois.Array.Ones.dtype (Python parameter) — The numpy.dtype of the array elements. The default is None which represents the smallest unsigned data type for this Array subclass (the first element in dtypes)."><span class="n"><span class="pre">dtype</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type."><span class="pre">DTypeLike</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><span class="pre">Self</span></span></span></span></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">galois.</span><span class="pre">Array.</span></span><span class="sig-name descname"><span class="pre">Ones</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-shape" title="galois.Array.Ones.shape (Python parameter) — A NumPy-compliant shape tuple."><span class="n"><span class="pre">shape</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.ShapeLike/" title="galois.typing.ShapeLike (Python data) — A Union representing objects that can be coerced into a NumPy shape tuple."><span class="pre">ShapeLike</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-dtype" title="galois.Array.Ones.dtype (Python parameter) — The numpy.dtype of the array elements. The default is None which represents the smallest unsigned data type for this Array subclass (the first element in dtypes)."><span class="n"><span class="pre">dtype</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type."><span class="pre">DTypeLike</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><span class="pre">Self</span></span></span></span></dt>
 <dd><p>Creates an array of all ones.</p>
 <dl class="field-list simple">
 <dt class="field-odd" id="parameters">Parameters<span class="colon">:</span><a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></dt>
 <dd class="field-odd"><dl class="simple api-field highlight">
 <dt id="p-shape"><span class="n sig-name">shape</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.ShapeLike/" title="galois.typing.ShapeLike (Python data) — A Union representing objects that can be coerced into a NumPy shape tuple.">ShapeLike</a></span></span><a class="headerlink" href="#p-shape" title="Permalink to this definition">¶</a></dt><dd><p>A NumPy-compliant <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.shape.html#numpy.ndarray.shape" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shape</span></code></a> tuple.</p>
 </dd>
-<dt id="p-dtype"><span class="n sig-name">dtype</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type.">DTypeLike</a><span class="w">   </span><span class="p">|</span><span class="w">   </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)">None</a></span></span><span class="w">   </span><span class="o">=</span><span class="w">   </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#p-dtype" title="Permalink to this definition">¶</a></dt><dd><p>The <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.dtype</span></code></a> of the array elements. The default is <code class="code highlight python docutils literal highlight-python"><span class="kc">None</span></code> which represents the smallest
+<dt id="p-dtype"><span class="n sig-name">dtype</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference internal" href="../galois.typing.DTypeLike/" title="galois.typing.DTypeLike (Python data) — A Union representing objects that can be coerced into a NumPy data type.">DTypeLike</a><span class="w">   </span><span class="p">|</span><span class="w">   </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)">None</a></span></span><span class="w">   </span><span class="o">=</span><span class="w">   </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#p-dtype" title="Permalink to this definition">¶</a></dt><dd><p>The <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.dtype</span></code></a> of the array elements. The default is <code class="code highlight python docutils literal highlight-python"><span class="kc">None</span></code> which represents the smallest
 unsigned data type for this <a class="reference internal" href="../galois.Array/" title="galois.Array (Python class) — An abstract ndarray subclass over a Galois field or Galois ring."><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a> subclass (the first element in
 <a class="reference internal" href="../galois.Array.dtypes/" title="galois.Array.dtypes (Python property) — List of valid integer numpy.dtype values that are compatible with this Galois field or Galois ring."><code class="xref py py-obj docutils literal notranslate"><span class="pre">dtypes</span></code></a>).</p>
 </dd>