Deploy: 6fd5129

Author: array-api-bot

draft/API_specification/generated/array_api.searchsorted.html

@@ -471,13 +471,13 @@
 <h1 id="api-specification-generated-array-api-searchsorted--page-root">searchsorted<a class="headerlink" href="#api-specification-generated-array-api-searchsorted--page-root" title="Link to this heading">¶</a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="array_api.searchsorted">
-<span class="sig-name descname"><span class="pre">searchsorted</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>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'left'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'right'</span></span><span class="p"><span class="pre">]</span></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">'left'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sorter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</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><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.searchsorted" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">searchsorted</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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><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></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">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'left'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'right'</span></span><span class="p"><span class="pre">]</span></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">'left'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sorter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</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><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.searchsorted" title="Link to this definition">¶</a></dt>
 <dd><p>Finds the indices into <code class="docutils literal notranslate"><span class="pre">x1</span></code> such that, if the corresponding elements in <code class="docutils literal notranslate"><span class="pre">x2</span></code> were inserted before the indices, the order of <code class="docutils literal notranslate"><span class="pre">x1</span></code>, when sorted in ascending order, would be preserved.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x1</strong> (<em>array</em>) – input array. <strong>Must</strong> be a one-dimensional array. <strong>Should</strong> have a real-valued data type. If <code class="docutils literal notranslate"><span class="pre">sorter</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, <strong>must</strong> be sorted in ascending order; otherwise, <code class="docutils literal notranslate"><span class="pre">sorter</span></code> <strong>must</strong> be an array of indices that sort <code class="docutils literal notranslate"><span class="pre">x1</span></code> in ascending order.</p></li>
-<li><p><strong>x2</strong> (<em>array</em>) – array containing search values. <strong>Should</strong> have a real-valued data type.</p></li>
+<li><p><strong>x2</strong> (<em>Union</em><em>[</em><em>array</em><em>, </em><em>int</em><em>, </em><em>float</em><em>]</em>) – array containing search values. <strong>Should</strong> have a real-valued data type.</p></li>
 <li><p><strong>side</strong> (<em>Literal</em><em>[</em><em>'left'</em><em>, </em><em>'right'</em><em>]</em>) – <p>argument controlling which index is returned if a value lands exactly on an edge.</p>
 <p>Let <code class="docutils literal notranslate"><span class="pre">v</span></code> be an element of <code class="docutils literal notranslate"><span class="pre">x2</span></code> given by <code class="docutils literal notranslate"><span class="pre">v</span> <span class="pre">=</span> <span class="pre">x2[j]</span></code>, where <code class="docutils literal notranslate"><span class="pre">j</span></code> refers to a valid index (see <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a>).</p>
 <ul>
@@ -501,6 +501,7 @@ <h1 id="api-specification-generated-array-api-searchsorted--page-root">searchsor
 </dl>
 <p class="rubric">Notes</p>
 <ul class="simple">
+<li><p>If <code class="docutils literal notranslate"><span class="pre">x2</span></code> is a scalar value, <code class="docutils literal notranslate"><span class="pre">x2</span></code> should be treated as equivalent to a zero-dimensional array having a data type determined according to <a class="reference internal" href="../type_promotion.html#mixing-scalars-and-arrays"><span class="std std-ref">Mixing arrays with Python scalars</span></a>.</p></li>
 <li><p>For real-valued floating-point arrays, the sort order of NaNs and signed zeros is unspecified and thus implementation-dependent. Accordingly, when a real-valued floating-point array contains NaNs and signed zeros, what constitutes ascending order <strong>may</strong> vary among specification-conforming array libraries.</p></li>
 <li><p>While behavior for arrays containing NaNs and signed zeros is implementation-dependent, specification-conforming libraries <strong>should</strong>, however, ensure consistency with <code class="docutils literal notranslate"><span class="pre">sort</span></code> and <code class="docutils literal notranslate"><span class="pre">argsort</span></code> (i.e., if a value in <code class="docutils literal notranslate"><span class="pre">x2</span></code> is inserted into <code class="docutils literal notranslate"><span class="pre">x1</span></code> according to the corresponding index in the output array and <code class="docutils literal notranslate"><span class="pre">sort</span></code> is invoked on the resultant array, the sorted result <strong>should</strong> be an array in the same order).</p></li>
 </ul>