Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d107111

Browse files
author
array-api-bot
committed
Deploy: 6b8172e
1 parent 7027ba6 commit d107111

30 files changed

+64
-55
lines changed

2022.12/API_specification/generated/array_api.array.__add__.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -457,13 +457,13 @@
457457
<h1 id="api-specification-generated-array-api-array-add--page-root">__add__<a class="headerlink" href="#api-specification-generated-array-api-array-add--page-root" title="Link to this heading"></a></h1>
458458
<dl class="py method">
459459
<dt class="sig sig-object py" id="array_api.array.__add__">
460-
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__add__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__add__" title="Link to this definition"></a></dt>
460+
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__add__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__add__" title="Link to this definition"></a></dt>
461461
<dd><p>Calculates the sum for each element of an array instance with the respective element of the array <code class="docutils literal notranslate"><span class="pre">other</span></code>.</p>
462462
<dl class="field-list simple">
463463
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
464464
<dd class="field-odd"><ul class="simple">
465465
<li><p><strong>self</strong> (<em>array</em>) – array instance (augend array). Should have a numeric data type.</p></li>
466-
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>array</em><em>]</em>) – addend array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a numeric data type.</p></li>
466+
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>complex</em><em>, </em><em>array</em><em>]</em>) – addend array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a numeric data type.</p></li>
467467
</ul>
468468
</dd>
469469
<dt class="field-even">Returns<span class="colon">:</span></dt>

2022.12/API_specification/generated/array_api.array.__eq__.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -457,13 +457,13 @@
457457
<h1 id="api-specification-generated-array-api-array-eq--page-root">__eq__<a class="headerlink" href="#api-specification-generated-array-api-array-eq--page-root" title="Link to this heading"></a></h1>
458458
<dl class="py method">
459459
<dt class="sig sig-object py" id="array_api.array.__eq__">
460-
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__eq__" title="Link to this definition"></a></dt>
460+
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__eq__" title="Link to this definition"></a></dt>
461461
<dd><p>Computes the truth value of <code class="docutils literal notranslate"><span class="pre">self_i</span> <span class="pre">==</span> <span class="pre">other_i</span></code> for each element of an array instance with the respective element of the array <code class="docutils literal notranslate"><span class="pre">other</span></code>.</p>
462462
<dl class="field-list simple">
463463
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
464464
<dd class="field-odd"><ul class="simple">
465465
<li><p><strong>self</strong> (<em>array</em>) – array instance. May have any data type.</p></li>
466-
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>bool</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). May have any data type.</p></li>
466+
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>complex</em><em>, </em><em>bool</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). May have any data type.</p></li>
467467
</ul>
468468
</dd>
469469
<dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -474,6 +474,9 @@ <h1 id="api-specification-generated-array-api-array-eq--page-root">__eq__<a clas
474474
<p class="admonition-title">Note</p>
475475
<p>Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function <a class="reference internal" href="array_api.equal.html#array_api.equal" title="array_api.equal"><code class="xref py py-func docutils literal notranslate"><span class="pre">equal()</span></code></a>.</p>
476476
</div>
477+
<div class="versionchanged">
478+
<p><span class="versionmodified changed">Changed in version 2022.12: </span>Added complex data type support.</p>
479+
</div>
477480
</dd></dl>
478481
</section>
479482

2022.12/API_specification/generated/array_api.array.__mul__.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@
457457
<h1 id="api-specification-generated-array-api-array-mul--page-root">__mul__<a class="headerlink" href="#api-specification-generated-array-api-array-mul--page-root" title="Link to this heading"></a></h1>
458458
<dl class="py method">
459459
<dt class="sig sig-object py" id="array_api.array.__mul__">
460-
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__mul__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__mul__" title="Link to this definition"></a></dt>
460+
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__mul__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__mul__" title="Link to this definition"></a></dt>
461461
<dd><p>Calculates the product for each element of an array instance with the respective element of the array <code class="docutils literal notranslate"><span class="pre">other</span></code>.</p>
462462
<div class="admonition note">
463463
<p class="admonition-title">Note</p>
@@ -467,7 +467,7 @@ <h1 id="api-specification-generated-array-api-array-mul--page-root">__mul__<a cl
467467
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
468468
<dd class="field-odd"><ul class="simple">
469469
<li><p><strong>self</strong> (<em>array</em>) – array instance. Should have a numeric data type.</p></li>
470-
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a numeric data type.</p></li>
470+
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>complex</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a numeric data type.</p></li>
471471
</ul>
472472
</dd>
473473
<dt class="field-even">Returns<span class="colon">:</span></dt>

2022.12/API_specification/generated/array_api.array.__ne__.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -457,13 +457,13 @@
457457
<h1 id="api-specification-generated-array-api-array-ne--page-root">__ne__<a class="headerlink" href="#api-specification-generated-array-api-array-ne--page-root" title="Link to this heading"></a></h1>
458458
<dl class="py method">
459459
<dt class="sig sig-object py" id="array_api.array.__ne__">
460-
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__ne__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__ne__" title="Link to this definition"></a></dt>
460+
<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__ne__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__ne__" title="Link to this definition"></a></dt>
461461
<dd><p>Computes the truth value of <code class="docutils literal notranslate"><span class="pre">self_i</span> <span class="pre">!=</span> <span class="pre">other_i</span></code> for each element of an array instance with the respective element of the array <code class="docutils literal notranslate"><span class="pre">other</span></code>.</p>
462462
<dl class="field-list simple">
463463
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
464464
<dd class="field-odd"><ul class="simple">
465465
<li><p><strong>self</strong> (<em>array</em>) – array instance. May have any data type.</p></li>
466-
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>bool</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). May have any data type.</p></li>
466+
<li><p><strong>other</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>complex</em><em>, </em><em>bool</em><em>, </em><em>array</em><em>]</em>) – other array. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). May have any data type.</p></li>
467467
</ul>
468468
</dd>
469469
<dt class="field-even">Returns<span class="colon">:</span></dt>

2022.12/API_specification/generated/array_api.array.__or__.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -475,9 +475,6 @@ <h1 id="api-specification-generated-array-api-array-or--page-root">__or__<a clas
475475
<p class="admonition-title">Note</p>
476476
<p>Element-wise results must equal the results returned by the equivalent element-wise function <a class="reference internal" href="array_api.bitwise_or.html#array_api.bitwise_or" title="array_api.bitwise_or"><code class="xref py py-func docutils literal notranslate"><span class="pre">bitwise_or()</span></code></a>.</p>
477477
</div>
478-
<div class="versionchanged">
479-
<p><span class="versionmodified changed">Changed in version 2022.12: </span>Added complex data type support.</p>
480-
</div>
481478
</dd></dl>
482479
</section>
483480

0 commit comments

Comments
 (0)