Update doc of elementwise functions 984d836

Author: github-actions[bot]

pull/2188/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0bb81b21a405db8326162d3720c8fdf0
+config: 177db6c6ce54bde0b2c81b90b7d730fd
 tags: 645f666f9bcd5a90fca523b33c5a78b7

pull/2188/_modules/dpnp/dpnp_array.html

@@ -14,14 +14,14 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev2+15.gb5173efe25e documentation</title>
+  <title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev2+18.g984d8368529 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=65796854"></script>
+      <script src="../../_static/documentation_options.js?v=33e3383a"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -147,44 +147,32 @@ <h1>Source code for dpnp.dpnp_flatiter</h1><div class="highlight"><pre>
         <span class="n">multi_index</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">i_</span>
         <span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">multi_index</span><span class="p">)</span>
 
-<div class="viewcode-block" id="flatiter.__getitem__">
-<a class="viewcode-back" href="../../reference/generated/dpnp.flatiter.html#dpnp.flatiter.__getitem__">[docs]</a>
     <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
         <span class="n">idx</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">&quot;__index__&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="n">idx</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
         <span class="n">i</span> <span class="o">=</span> <span class="n">idx</span><span class="p">()</span>
         <span class="n">mi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_multiindex</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">arr_</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="n">mi</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">arr_</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="n">mi</span><span class="p">)</span>
 
-
-<div class="viewcode-block" id="flatiter.__setitem__">
-<a class="viewcode-back" href="../../reference/generated/dpnp.flatiter.html#dpnp.flatiter.__setitem__">[docs]</a>
     <span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
         <span class="n">idx</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">&quot;__index__&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="n">idx</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
         <span class="n">i</span> <span class="o">=</span> <span class="n">idx</span><span class="p">()</span>
         <span class="n">mi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_multiindex</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">arr_</span><span class="o">.</span><span class="fm">__setitem__</span><span class="p">(</span><span class="n">mi</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span></div>
-
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">arr_</span><span class="o">.</span><span class="fm">__setitem__</span><span class="p">(</span><span class="n">mi</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
 
-<div class="viewcode-block" id="flatiter.__iter__">
-<a class="viewcode-back" href="../../reference/generated/dpnp.flatiter.html#dpnp.flatiter.__iter__">[docs]</a>
     <span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-        <span class="k">return</span> <span class="bp">self</span></div>
+        <span class="k">return</span> <span class="bp">self</span>
 
-
-<div class="viewcode-block" id="flatiter.__next__">
-<a class="viewcode-back" href="../../reference/generated/dpnp.flatiter.html#dpnp.flatiter.__next__">[docs]</a>
     <span class="k">def</span> <span class="fm">__next__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">i_</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">size_</span><span class="p">:</span>
             <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">i_</span><span class="p">)</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">i_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">i_</span> <span class="o">+</span> <span class="mi">1</span>
             <span class="k">return</span> <span class="n">val</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">StopIteration</span></div>
-</div>
 
 </pre></div>
 

pull/2188/_modules/dpnp/dpnp_flatiter.html

@@ -14,14 +14,14 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev2+15.gb5173efe25e documentation</title>
+  <title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev2+18.g984d8368529 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=65796854"></script>
+      <script src="../../_static/documentation_options.js?v=33e3383a"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

pull/2188/_modules/dpnp/dpnp_iface.html

@@ -14,14 +14,14 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev2+15.gb5173efe25e documentation</title>
+  <title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev2+18.g984d8368529 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=65796854"></script>
+      <script src="../../_static/documentation_options.js?v=33e3383a"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

pull/2188/_modules/dpnp/dpnp_iface_arraycreation.html

@@ -14,14 +14,14 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev2+15.gb5173efe25e documentation</title>
+  <title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev2+18.g984d8368529 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=65796854"></script>
+      <script src="../../_static/documentation_options.js?v=33e3383a"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -222,15 +222,17 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 
 <span class="s2">Parameters</span>
 <span class="s2">----------</span>
-<span class="s2">x1, x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
-<span class="s2">    Input arrays, expected to have integer or boolean data type.</span>
+<span class="s2">x1 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    First input array, expected to have integer or boolean data type.</span>
 <span class="s2">    Both inputs `x1` and `x2` can not be scalars at the same time.</span>
+<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    Second input array, also expected to have integer or boolean data</span>
+<span class="s2">    type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
 <span class="s2">    If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
 <span class="s2">    (which becomes the shape of the output).</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the inputs broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>
@@ -306,15 +308,17 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 
 <span class="s2">Parameters</span>
 <span class="s2">----------</span>
-<span class="s2">x1, x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
-<span class="s2">    Input arrays, expected to have integer or boolean data type.</span>
+<span class="s2">x1 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    First input array, expected to have integer or boolean data type.</span>
 <span class="s2">    Both inputs `x1` and `x2` can not be scalars at the same time.</span>
+<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    Second input array, also expected to have integer or boolean data</span>
+<span class="s2">    type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
 <span class="s2">    If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
 <span class="s2">    (which becomes the shape of the output).</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the inputs broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>
@@ -381,15 +385,17 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 
 <span class="s2">Parameters</span>
 <span class="s2">----------</span>
-<span class="s2">x1, x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
-<span class="s2">    Input arrays, expected to have integer or boolean data type.</span>
+<span class="s2">x1 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    First input array, expected to have integer or boolean data type.</span>
 <span class="s2">    Both inputs `x1` and `x2` can not be scalars at the same time.</span>
+<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
+<span class="s2">    Second input array, also expected to have integer or boolean data</span>
+<span class="s2">    type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
 <span class="s2">    If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
 <span class="s2">    (which becomes the shape of the output).</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the inputs broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>
@@ -464,8 +470,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 <span class="s2">    Input array, expected to have integer or boolean data type.</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the input broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>
@@ -551,8 +556,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 <span class="s2">    (which becomes the shape of the output).</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the inputs broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>
@@ -628,8 +632,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
 <span class="s2">    (which becomes the shape of the output).</span>
 <span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
 <span class="s2">    Output array to populate.</span>
-<span class="s2">    Array must have a shape that the inputs broadcast to and</span>
-<span class="s2">    the expected data type.</span>
+<span class="s2">    Array must have the correct shape and the expected data type.</span>
 <span class="s2">    Default: ``None``.</span>
 <span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
 <span class="s2">    Memory layout of the newly output array, if parameter `out` is ``None``.</span>

pull/2188/_modules/dpnp/dpnp_iface_bitwise.html

@@ -14,14 +14,14 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev2+15.gb5173efe25e documentation</title>
+  <title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev2+18.g984d8368529 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=65796854"></script>
+      <script src="../../_static/documentation_options.js?v=33e3383a"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>