You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<spanclass="sig-name descname"><spanclass="pre">max</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">/</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axis</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">Tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">...</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">keepdims</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">False</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">array</span></span></span><aclass="headerlink" href="#array_api.max" title="Permalink to this definition">¶</a></dt>
467
467
<dd><p>Calculates the maximum value of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code>.</p>
468
-
<divclass="admonition note">
469
-
<pclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point input array, return <codeclass="docutils literal notranslate"><spanclass="pre">NaN</span></code>), or return the minimum possible value for the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> data type (e.g., if <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point array, return <codeclass="docutils literal notranslate"><spanclass="pre">-infinity</span></code>).</p>
471
-
</div>
472
-
<divclass="admonition note">
473
-
<pclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<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 <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point input array, return <codeclass="docutils literal notranslate"><spanclass="pre">NaN</span></code>), or return the minimum possible value for the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> data type (e.g., if <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point array, return <codeclass="docutils literal notranslate"><spanclass="pre">-infinity</span></code>).</p>
482
+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <codeclass="docutils literal notranslate"><spanclass="pre">-0</span></code> or <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<spanclass="sig-name descname"><spanclass="pre">maximum</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x1</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">x2</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">/</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">array</span></span></span><aclass="headerlink" href="#array_api.maximum" title="Permalink to this definition">¶</a></dt>
467
467
<dd><p>Computes the maximum value for each element <codeclass="docutils literal notranslate"><spanclass="pre">x1_i</span></code> of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x1</span></code> relative to the respective element <codeclass="docutils literal notranslate"><spanclass="pre">x2_i</span></code> of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x2</span></code>.</p>
468
-
<divclass="admonition note">
469
-
<pclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <codeclass="docutils literal notranslate"><spanclass="pre">-0</span></code> or <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<spanclass="sig-name descname"><spanclass="pre">min</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">/</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">axis</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">Tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">...</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">keepdims</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">False</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">array</span></span></span><aclass="headerlink" href="#array_api.min" title="Permalink to this definition">¶</a></dt>
467
467
<dd><p>Calculates the minimum value of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code>.</p>
468
-
<divclass="admonition note">
469
-
<pclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point input array, return <codeclass="docutils literal notranslate"><spanclass="pre">NaN</span></code>), or return the maximum possible value for the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> data type (e.g., if <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point array, return <codeclass="docutils literal notranslate"><spanclass="pre">+infinity</span></code>).</p>
471
-
</div>
472
-
<divclass="admonition note">
473
-
<pclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<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 <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point input array, return <codeclass="docutils literal notranslate"><spanclass="pre">NaN</span></code>), or return the maximum possible value for the input array <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> data type (e.g., if <codeclass="docutils literal notranslate"><spanclass="pre">x</span></code> is a floating-point array, return <codeclass="docutils literal notranslate"><spanclass="pre">+infinity</span></code>).</p>
482
+
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <codeclass="docutils literal notranslate"><spanclass="pre">-0</span></code> or <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<spanclass="sig-name descname"><spanclass="pre">minimum</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x1</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">x2</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">array</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">/</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">array</span></span></span><aclass="headerlink" href="#array_api.minimum" title="Permalink to this definition">¶</a></dt>
467
467
<dd><p>Computes the minimum value for each element <codeclass="docutils literal notranslate"><spanclass="pre">x1_i</span></code> of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x1</span></code> relative to the respective element <codeclass="docutils literal notranslate"><spanclass="pre">x2_i</span></code> of the input array <codeclass="docutils literal notranslate"><spanclass="pre">x2</span></code>.</p>
468
-
<divclass="admonition note">
469
-
<pclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
<p>The order of signed zeros is unspecified and thus implementation-defined. When choosing between <codeclass="docutils literal notranslate"><spanclass="pre">-0</span></code> or <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><spanclass="std std-ref">Complex Number Ordering</span></a>).</p>
0 commit comments