Skip to content

Commit deb6152

Browse files
github-actions[bot]github-actions[bot]
committed
Update doc of elementwise functions (#2188)
* Update bitwise docs adding broadcast info * Update logic func docs adding broadcast info * Update mathematical func docs adding broadcast info * Update trigonometric func docs adding broadcast info 2bab446
1 parent 18d6d1e commit deb6152

File tree

692 files changed

+1622
-1440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

692 files changed

+1622
-1440
lines changed

‎.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7208ea29a9ecfc9263f369f11c103db7
3+
config: f9e8e1d97feee7d10da271e85df86f95
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_modules/dpnp/dpnp_array.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_flatiter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_arraycreation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_bitwise.html

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -228,6 +228,8 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
228228
<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
229229
<span class="s2"> Second input array, also expected to have integer or boolean data</span>
230230
<span class="s2"> type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
231+
<span class="s2"> If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
232+
<span class="s2"> (which becomes the shape of the output).</span>
231233
<span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
232234
<span class="s2"> Output array to populate.</span>
233235
<span class="s2"> Array must have the correct shape and the expected data type.</span>
@@ -312,6 +314,8 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
312314
<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
313315
<span class="s2"> Second input array, also expected to have integer or boolean data</span>
314316
<span class="s2"> type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
317+
<span class="s2"> If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
318+
<span class="s2"> (which becomes the shape of the output).</span>
315319
<span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
316320
<span class="s2"> Output array to populate.</span>
317321
<span class="s2"> Array must have the correct shape and the expected data type.</span>
@@ -387,6 +391,8 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
387391
<span class="s2">x2 : {dpnp.ndarray, usm_ndarray, scalar}</span>
388392
<span class="s2"> Second input array, also expected to have integer or boolean data</span>
389393
<span class="s2"> type. Both inputs `x1` and `x2` can not be scalars at the same time.</span>
394+
<span class="s2"> If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
395+
<span class="s2"> (which becomes the shape of the output).</span>
390396
<span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
391397
<span class="s2"> Output array to populate.</span>
392398
<span class="s2"> Array must have the correct shape and the expected data type.</span>
@@ -546,6 +552,8 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
546552
<span class="s2"> Second input array, also expected to have integer data type.</span>
547553
<span class="s2"> Each element must be greater than or equal to ``0``.</span>
548554
<span class="s2"> Both inputs `x1` and `x2` can not be scalars at the same time.</span>
555+
<span class="s2"> If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
556+
<span class="s2"> (which becomes the shape of the output).</span>
549557
<span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
550558
<span class="s2"> Output array to populate.</span>
551559
<span class="s2"> Array must have the correct shape and the expected data type.</span>
@@ -620,6 +628,8 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
620628
<span class="s2"> Second input array, also expected to have integer data type.</span>
621629
<span class="s2"> Each element must be greater than or equal to ``0``.</span>
622630
<span class="s2"> Both inputs `x1` and `x2` can not be scalars at the same time.</span>
631+
<span class="s2"> If ``x1.shape != x2.shape``, they must be broadcastable to a common shape</span>
632+
<span class="s2"> (which becomes the shape of the output).</span>
623633
<span class="s2">out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
624634
<span class="s2"> Output array to populate.</span>
625635
<span class="s2"> Array must have the correct shape and the expected data type.</span>

‎_modules/dpnp/dpnp_iface_counting.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_functional.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_histograms.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_indexing.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_indexing &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_indexing &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_libmath.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_libmath &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_libmath &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_linearalgebra.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_linearalgebra &mdash; Data Parallel Extension for NumPy 0.17.0dev2+20.g367e74e0198 documentation</title>
17+
<title>dpnp.dpnp_iface_linearalgebra &mdash; Data Parallel Extension for NumPy 0.17.0dev2+21.g2bab446e0e1 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=678303fa"></script>
24+
<script src="../../_static/documentation_options.js?v=282848ef"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

0 commit comments

Comments
 (0)