Skip to content

Commit 45239f5

Browse files
author
array-api-bot
committed
Deploy: 6e9c487
1 parent 81efc31 commit 45239f5

File tree

5 files changed

+11
-25
lines changed

5 files changed

+11
-25
lines changed

draft/API_specification/generated/array_api.max.html

+3-8
Original file line numberDiff line numberDiff line change
@@ -465,14 +465,6 @@ <h1 id="api-specification-generated-array-api-max--page-root">max<a class="heade
465465
<dt class="sig sig-object py" id="array_api.max">
466466
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keepdims</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</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.max" title="Permalink to this definition"></a></dt>
467467
<dd><p>Calculates the maximum value of the input array <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
468-
<div class="admonition note">
469-
<p class="admonition-title">Note</p>
470-
<p>When the number of elements over which to compute the maximum value is zero, the maximum value is implementation-defined. Specification-compliant libraries may choose to raise an error, return a sentinel value (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point input array, return <code class="docutils literal notranslate"><span class="pre">NaN</span></code>), or return the minimum possible value for the input array <code class="docutils literal notranslate"><span class="pre">x</span></code> data type (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point array, return <code class="docutils literal notranslate"><span class="pre">-infinity</span></code>).</p>
471-
</div>
472-
<div class="admonition note">
473-
<p class="admonition-title">Note</p>
474-
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
475-
</div>
476468
<dl class="field-list simple">
477469
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
478470
<dd class="field-odd"><ul class="simple">
@@ -486,6 +478,9 @@ <h1 id="api-specification-generated-array-api-max--page-root">max<a class="heade
486478
</dd>
487479
</dl>
488480
<p class="rubric">Notes</p>
481+
<p>When the number of elements over which to compute the maximum value is zero, the maximum value is implementation-defined. Specification-compliant libraries may choose to raise an error, return a sentinel value (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point input array, return <code class="docutils literal notranslate"><span class="pre">NaN</span></code>), or return the minimum possible value for the input array <code class="docutils literal notranslate"><span class="pre">x</span></code> data type (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point array, return <code class="docutils literal notranslate"><span class="pre">-infinity</span></code>).</p>
482+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <code class="docutils literal notranslate"><span class="pre">-0</span></code> or <code class="docutils literal notranslate"><span class="pre">+0</span></code> as a maximum value, specification-compliant libraries may choose to return either value.</p>
483+
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-defined (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
489484
<p><strong>Special Cases</strong></p>
490485
<p>For floating-point operands,</p>
491486
<ul class="simple">

draft/API_specification/generated/array_api.maximum.html

+2-4
Original file line numberDiff line numberDiff line change
@@ -465,10 +465,6 @@ <h1 id="api-specification-generated-array-api-maximum--page-root">maximum<a clas
465465
<dt class="sig sig-object py" id="array_api.maximum">
466466
<span class="sig-name descname"><span class="pre">maximum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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.maximum" title="Permalink to this definition"></a></dt>
467467
<dd><p>Computes the maximum value for each element <code class="docutils literal notranslate"><span class="pre">x1_i</span></code> of the input array <code class="docutils literal notranslate"><span class="pre">x1</span></code> relative to the respective element <code class="docutils literal notranslate"><span class="pre">x2_i</span></code> of the input array <code class="docutils literal notranslate"><span class="pre">x2</span></code>.</p>
468-
<div class="admonition note">
469-
<p class="admonition-title">Note</p>
470-
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
471-
</div>
472468
<dl class="field-list simple">
473469
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
474470
<dd class="field-odd"><ul class="simple">
@@ -481,6 +477,8 @@ <h1 id="api-specification-generated-array-api-maximum--page-root">maximum<a clas
481477
</dd>
482478
</dl>
483479
<p class="rubric">Notes</p>
480+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <code class="docutils literal notranslate"><span class="pre">-0</span></code> or <code class="docutils literal notranslate"><span class="pre">+0</span></code> as a maximum value, specification-compliant libraries may choose to return either value.</p>
481+
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-defined (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
484482
<p><strong>Special Cases</strong></p>
485483
<p>For floating-point operands,</p>
486484
<ul class="simple">

draft/API_specification/generated/array_api.min.html

+3-8
Original file line numberDiff line numberDiff line change
@@ -465,14 +465,6 @@ <h1 id="api-specification-generated-array-api-min--page-root">min<a class="heade
465465
<dt class="sig sig-object py" id="array_api.min">
466466
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keepdims</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</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.min" title="Permalink to this definition"></a></dt>
467467
<dd><p>Calculates the minimum value of the input array <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
468-
<div class="admonition note">
469-
<p class="admonition-title">Note</p>
470-
<p>When the number of elements over which to compute the minimum value is zero, the minimum value is implementation-defined. Specification-compliant libraries may choose to raise an error, return a sentinel value (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point input array, return <code class="docutils literal notranslate"><span class="pre">NaN</span></code>), or return the maximum possible value for the input array <code class="docutils literal notranslate"><span class="pre">x</span></code> data type (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point array, return <code class="docutils literal notranslate"><span class="pre">+infinity</span></code>).</p>
471-
</div>
472-
<div class="admonition note">
473-
<p class="admonition-title">Note</p>
474-
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
475-
</div>
476468
<dl class="field-list simple">
477469
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
478470
<dd class="field-odd"><ul class="simple">
@@ -486,6 +478,9 @@ <h1 id="api-specification-generated-array-api-min--page-root">min<a class="heade
486478
</dd>
487479
</dl>
488480
<p class="rubric">Notes</p>
481+
<p>When the number of elements over which to compute the minimum value is zero, the minimum value is implementation-defined. Specification-compliant libraries may choose to raise an error, return a sentinel value (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point input array, return <code class="docutils literal notranslate"><span class="pre">NaN</span></code>), or return the maximum possible value for the input array <code class="docutils literal notranslate"><span class="pre">x</span></code> data type (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is a floating-point array, return <code class="docutils literal notranslate"><span class="pre">+infinity</span></code>).</p>
482+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <code class="docutils literal notranslate"><span class="pre">-0</span></code> or <code class="docutils literal notranslate"><span class="pre">+0</span></code> as a minimum value, specification-compliant libraries may choose to return either value.</p>
483+
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-defined (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
489484
<p><strong>Special Cases</strong></p>
490485
<p>For floating-point operands,</p>
491486
<ul class="simple">

draft/API_specification/generated/array_api.minimum.html

+2-4
Original file line numberDiff line numberDiff line change
@@ -465,10 +465,6 @@ <h1 id="api-specification-generated-array-api-minimum--page-root">minimum<a clas
465465
<dt class="sig sig-object py" id="array_api.minimum">
466466
<span class="sig-name descname"><span class="pre">minimum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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.minimum" title="Permalink to this definition"></a></dt>
467467
<dd><p>Computes the minimum value for each element <code class="docutils literal notranslate"><span class="pre">x1_i</span></code> of the input array <code class="docutils literal notranslate"><span class="pre">x1</span></code> relative to the respective element <code class="docutils literal notranslate"><span class="pre">x2_i</span></code> of the input array <code class="docutils literal notranslate"><span class="pre">x2</span></code>.</p>
468-
<div class="admonition note">
469-
<p class="admonition-title">Note</p>
470-
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
471-
</div>
472468
<dl class="field-list simple">
473469
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
474470
<dd class="field-odd"><ul class="simple">
@@ -481,6 +477,8 @@ <h1 id="api-specification-generated-array-api-minimum--page-root">minimum<a clas
481477
</dd>
482478
</dl>
483479
<p class="rubric">Notes</p>
480+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <code class="docutils literal notranslate"><span class="pre">-0</span></code> or <code class="docutils literal notranslate"><span class="pre">+0</span></code> as a minimum value, specification-compliant libraries may choose to return either value.</p>
481+
<p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-defined (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p>
484482
<p><strong>Special Cases</strong></p>
485483
<p>For floating-point operands,</p>
486484
<ul class="simple">

draft/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)