Skip to content

Commit d000f4b

Browse files
Add raises NotImplementedError for array creation functions (#1695)
* Add raises NotImplementedError for array creation functions * address comments * address comments * Added value error for order A and K. Changed test for exceptions * Fix pre-commit 4f4db77
1 parent 9f130c0 commit d000f4b

File tree

478 files changed

+1739
-1890
lines changed

Some content is hidden

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

478 files changed

+1739
-1890
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 hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5a992483ba3d29ce81701b5eb7a6c09e
3+
config: 75acf18a3a4590524706e3b6207c62dd
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/dpnp/dpnp_array.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_flatiter.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface_arraycreation.html

Lines changed: 268 additions & 331 deletions
Large diffs are not rendered by default.

_modules/dpnp/dpnp_iface_bitwise.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface_counting.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface_indexing.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_indexing &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_indexing &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface_libmath.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_libmath &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_libmath &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface_linearalgebra.html

Lines changed: 7 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_linearalgebra &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_linearalgebra &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -373,53 +373,18 @@ <h1>Source code for dpnp.dpnp_iface_linearalgebra</h1><div class="highlight"><pr
373373
<span class="n">order</span><span class="o">=</span><span class="s2">&quot;K&quot;</span><span class="p">,</span>
374374
<span class="n">dtype</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
375375
<span class="n">subok</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
376-
<span class="n">signature</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
377-
<span class="n">extobj</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
378-
<span class="n">axes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
379-
<span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
380376
<span class="p">):</span>
381377
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
382378
<span class="sd"> Matrix product of two arrays.</span>
383379

384380
<span class="sd"> For full documentation refer to :obj:`numpy.matmul`.</span>
385381

386-
<span class="sd"> Parameters</span>
387-
<span class="sd"> ----------</span>
388-
<span class="sd"> x1 : {dpnp_array, usm_ndarray}</span>
389-
<span class="sd"> First input array.</span>
390-
<span class="sd"> x2 : {dpnp_array, usm_ndarray}</span>
391-
<span class="sd"> Second input array.</span>
392-
<span class="sd"> out : {dpnp.ndarray, usm_ndarray}, optional</span>
393-
<span class="sd"> Alternative output array in which to place the result. It must have</span>
394-
<span class="sd"> a shape that matches the signature `(n,k),(k,m)-&gt;(n,m)` but the type</span>
395-
<span class="sd"> (of the calculated values) will be cast if necessary. Default: ``None``.</span>
396-
<span class="sd"> dtype : dtype, optional</span>
397-
<span class="sd"> Type to use in computing the matrix product. By default, the returned</span>
398-
<span class="sd"> array will have data type that is determined by considering</span>
399-
<span class="sd"> Promotion Type Rule and device capabilities.</span>
400-
<span class="sd"> casting : {&#39;no&#39;, &#39;equiv&#39;, &#39;safe&#39;, &#39;same_kind&#39;, &#39;unsafe&#39;}, optional</span>
401-
<span class="sd"> Controls what kind of data casting may occur. Default: ``&quot;same_kind&quot;``.</span>
402-
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;, None}, optional</span>
403-
<span class="sd"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
404-
<span class="sd"> Default: &quot;K&quot;.</span>
405-
<span class="sd"> axes : list of tuples, optional</span>
406-
<span class="sd"> A list of tuples with indices of axes the matrix product should operate on.</span>
407-
<span class="sd"> For instance, for the signature of ``(i,j),(j,k)-&gt;(i,k)``, the base elements</span>
408-
<span class="sd"> are 2d matrices and these are taken to be stored in the two last axes of each</span>
409-
<span class="sd"> argument. The corresponding axes keyword would be [(-2, -1), (-2, -1), (-2, -1)].</span>
410-
<span class="sd"> Default: ``None``.</span>
411-
412-
<span class="sd"> Returns</span>
413-
<span class="sd"> -------</span>
414-
<span class="sd"> out : dpnp.ndarray</span>
415-
<span class="sd"> Returns the matrix product of the inputs.</span>
416-
<span class="sd"> This is a 0-d array only when both `x1`, `x2` are 1-d vectors.</span>
417-
418382
<span class="sd"> Limitations</span>
419383
<span class="sd"> -----------</span>
420-
<span class="sd"> Keyword arguments `subok`, `signature`, `extobj`, and `axis` are</span>
421-
<span class="sd"> only supported with their default value.</span>
422-
<span class="sd"> Otherwise ``NotImplementedError`` exception will be raised.</span>
384+
<span class="sd"> Input arrays and parameter `out` are supported as either :class:`dpnp.ndarray`</span>
385+
<span class="sd"> or :class:`dpctl.tensor.usm_ndarray`.</span>
386+
<span class="sd"> Keyword argument `subok` is currently unsupported.</span>
387+
<span class="sd"> Input array data types are limited by supported DPNP :ref:`Data types`.</span>
423388

424389
<span class="sd"> See Also</span>
425390
<span class="sd"> --------</span>
@@ -480,18 +445,6 @@ <h1>Source code for dpnp.dpnp_iface_linearalgebra</h1><div class="highlight"><pr
480445
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
481446
<span class="s2">&quot;subok keyword argument is only supported by its default value.&quot;</span>
482447
<span class="p">)</span>
483-
<span class="k">elif</span> <span class="n">signature</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
484-
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
485-
<span class="s2">&quot;signature keyword argument is only supported by its default value.&quot;</span>
486-
<span class="p">)</span>
487-
<span class="k">elif</span> <span class="n">extobj</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
488-
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
489-
<span class="s2">&quot;extobj keyword argument is only supported by its default value.&quot;</span>
490-
<span class="p">)</span>
491-
<span class="k">elif</span> <span class="n">axis</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
492-
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
493-
<span class="s2">&quot;axis keyword argument is only supported by its default value.&quot;</span>
494-
<span class="p">)</span>
495448
<span class="k">else</span><span class="p">:</span>
496449
<span class="k">return</span> <span class="n">dpnp_matmul</span><span class="p">(</span>
497450
<span class="n">x1</span><span class="p">,</span>
@@ -500,7 +453,6 @@ <h1>Source code for dpnp.dpnp_iface_linearalgebra</h1><div class="highlight"><pr
500453
<span class="n">casting</span><span class="o">=</span><span class="n">casting</span><span class="p">,</span>
501454
<span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">,</span>
502455
<span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
503-
<span class="n">axes</span><span class="o">=</span><span class="n">axes</span><span class="p">,</span>
504456
<span class="p">)</span></div>
505457

506458

_modules/dpnp/dpnp_iface_logic.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface_logic &mdash; Data Parallel Extension for NumPy 0.13.1dev4+7.g786d4504f5 documentation</title>
15+
<title>dpnp.dpnp_iface_logic &mdash; Data Parallel Extension for NumPy 0.13.1dev4+4.g4f4db77686 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=db5cbdd5"></script>
26+
<script src="../../_static/documentation_options.js?v=96b34e92"></script>
2727
<script src="../../_static/doctools.js?v=888ff710"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.13.1dev4+7.g786d4504f5
46+
0.13.1dev4+4.g4f4db77686
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

0 commit comments

Comments
 (0)