12
12
</ script >
13
13
14
14
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
15
- < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.16.0dev0+113.g6ae16ce5bf documentation</ title >
15
+ < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.16.0dev0+114.g4a232390fe documentation</ title >
16
16
< link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=fa44fd50 " />
17
17
< link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=19f00094 " />
18
18
23
23
24
24
< script src ="../../_static/jquery.js?v=5d32c60e "> </ script >
25
25
< script src ="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
26
- < script src ="../../_static/documentation_options.js?v=714a5aca "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=30100828 "> </ script >
27
27
< script src ="../../_static/doctools.js?v=9a2dae69 "> </ script >
28
28
< script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
29
29
< script src ="../../_static/js/theme.js "> </ script >
43
43
Data Parallel Extension for NumPy
44
44
</ a >
45
45
< div class ="version ">
46
- 0.16.0dev0+113.g6ae16ce5bf
46
+ 0.16.0dev0+114.g4a232390fe
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -1502,12 +1502,45 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1502
1502
< span class ="nd "> @property</ span >
1503
1503
< span class ="k "> def</ span > < span class ="nf "> shape</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
1504
1504
< span class ="w "> </ span > < span class ="sd "> """</ span >
1505
- < span class ="sd "> Lengths of axes. A tuple of numbers represents size of each dimension .</ span >
1505
+ < span class ="sd "> Tuple of array dimensions .</ span >
1506
1506
1507
- < span class ="sd "> Setter of this property involves reshaping without copy. If the array</ span >
1508
- < span class ="sd "> cannot be reshaped without copy, it raises an exception.</ span >
1507
+ < span class ="sd "> The shape property is usually used to get the current shape of an array,</ span >
1508
+ < span class ="sd "> but may also be used to reshape the array in-place by assigning a tuple</ span >
1509
+ < span class ="sd "> of array dimensions to it. Unlike :obj:`dpnp.reshape`, only non-negative</ span >
1510
+ < span class ="sd "> values are supported to be set as new shape. Reshaping an array in-place</ span >
1511
+ < span class ="sd "> will fail if a copy is required.</ span >
1509
1512
1510
- < span class ="sd "> .. seealso: :attr:`numpy.ndarray.shape`</ span >
1513
+ < span class ="sd "> For full documentation refer to :obj:`numpy.ndarray.shape`.</ span >
1514
+
1515
+ < span class ="sd "> Note</ span >
1516
+ < span class ="sd "> ----</ span >
1517
+ < span class ="sd "> Using :obj:`dpnp.ndarray.reshape` or :obj:`dpnp.reshape` is the</ span >
1518
+ < span class ="sd "> preferred approach to set new shape of an array.</ span >
1519
+
1520
+ < span class ="sd "> See Also</ span >
1521
+ < span class ="sd "> --------</ span >
1522
+ < span class ="sd "> :obj:`dpnp.shape` : Equivalent getter function.</ span >
1523
+ < span class ="sd "> :obj:`dpnp.reshape` : Function similar to setting `shape`.</ span >
1524
+ < span class ="sd "> :obj:`dpnp.ndarray.reshape` : Method similar to setting `shape`.</ span >
1525
+
1526
+ < span class ="sd "> Examples</ span >
1527
+ < span class ="sd "> --------</ span >
1528
+ < span class ="sd "> >>> import dpnp as np</ span >
1529
+ < span class ="sd "> >>> x = np.array([1, 2, 3, 4])</ span >
1530
+ < span class ="sd "> >>> x.shape</ span >
1531
+ < span class ="sd "> (4,)</ span >
1532
+ < span class ="sd "> >>> y = np.zeros((2, 3, 4))</ span >
1533
+ < span class ="sd "> >>> y.shape</ span >
1534
+ < span class ="sd "> (2, 3, 4)</ span >
1535
+
1536
+ < span class ="sd "> >>> y.shape = (3, 8)</ span >
1537
+ < span class ="sd "> >>> y</ span >
1538
+ < span class ="sd "> array([[ 0., 0., 0., 0., 0., 0., 0., 0.],</ span >
1539
+ < span class ="sd "> [ 0., 0., 0., 0., 0., 0., 0., 0.],</ span >
1540
+ < span class ="sd "> [ 0., 0., 0., 0., 0., 0., 0., 0.]])</ span >
1541
+ < span class ="sd "> >>> y.shape = (3, 6)</ span >
1542
+ < span class ="sd "> ...</ span >
1543
+ < span class ="sd "> TypeError: Can not reshape array of size 24 into (3, 6)</ span >
1511
1544
1512
1545
< span class ="sd "> """</ span >
1513
1546
@@ -1518,16 +1551,23 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1518
1551
< span class ="w "> </ span > < span class ="sd "> """</ span >
1519
1552
< span class ="sd "> Set new lengths of axes.</ span >
1520
1553
1521
- < span class ="sd "> A tuple of numbers represents size of each dimension. </ span >
1522
- < span class ="sd "> It involves reshaping without copy. If the array cannot be reshaped without copy, </ span >
1523
- < span class ="sd "> it raises an exception .</ span >
1554
+ < span class ="sd "> Modifies array instance in-place by changing its metadata about the </ span >
1555
+ < span class ="sd "> shape and the strides of the array, or raises `AttributeError` </ span >
1556
+ < span class ="sd "> exception if in-place change is not possible .</ span >
1524
1557
1525
- < span class ="sd "> .. seealso: :attr:`numpy.ndarray.shape`</ span >
1558
+ < span class ="sd "> Whether the array can be reshape in-place depends on its strides. Use</ span >
1559
+ < span class ="sd "> :obj:`dpnp.reshape` function which always succeeds to reshape the array</ span >
1560
+ < span class ="sd "> by performing a copy if necessary.</ span >
1526
1561
1527
- < span class ="sd "> """ </ span >
1562
+ < span class ="sd "> For full documentation refer to :obj:`numpy.ndarray.shape`. </ span >
1528
1563
1529
- < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> newshape</ span > < span class ="p "> ,</ span > < span class ="p "> (</ span > < span class ="nb "> list</ span > < span class ="p "> ,</ span > < span class ="nb "> tuple</ span > < span class ="p "> )):</ span >
1530
- < span class ="n "> newshape</ span > < span class ="o "> =</ span > < span class ="p "> (</ span > < span class ="n "> newshape</ span > < span class ="p "> ,)</ span >
1564
+ < span class ="sd "> Parameters</ span >
1565
+ < span class ="sd "> ----------</ span >
1566
+ < span class ="sd "> newshape : {tuple, int}</ span >
1567
+ < span class ="sd "> New shape. Only non-negative values are supported. The new shape</ span >
1568
+ < span class ="sd "> may not lead to the change in the number of elements in the array.</ span >
1569
+
1570
+ < span class ="sd "> """</ span >
1531
1571
1532
1572
< span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _array_obj</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="o "> =</ span > < span class ="n "> newshape</ span >
1533
1573
0 commit comments