12
12
</ script >
13
13
14
14
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
15
- < title > dpnp.dpnp_iface_indexing — Data Parallel Extension for NumPy 0.16.0dev0+177.g71a33d0959c documentation</ title >
15
+ < title > dpnp.dpnp_iface_indexing — Data Parallel Extension for NumPy 0.16.0dev0+181.g4c3c994f7c2 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=3deeace5 "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=294065b9 "> </ 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+177.g71a33d0959c
46
+ 0.16.0dev0+181.g4c3c994f7c2
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -1606,19 +1606,21 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
1606
1606
< span class ="sd "> ----------</ span >
1607
1607
< span class ="sd "> multi_index : tuple of {dpnp.ndarray, usm_ndarray}</ span >
1608
1608
< span class ="sd "> A tuple of integer arrays, one array for each dimension.</ span >
1609
- < span class ="sd "> dims : tuple of ints</ span >
1609
+ < span class ="sd "> dims : tuple or list of ints</ span >
1610
1610
< span class ="sd "> The shape of array into which the indices from ``multi_index`` apply.</ span >
1611
1611
< span class ="sd "> mode : {"raise", "wrap" or "clip'}, optional</ span >
1612
- < span class ="sd "> Specifies how out-of-bounds indices are handled. Can specify either</ span >
1612
+ < span class ="sd "> Specifies how out-of-bounds indices are handled. Can specify either</ span >
1613
1613
< span class ="sd "> one mode or a tuple of modes, one mode per index:</ span >
1614
- < span class ="sd "> - "raise" -- raise an error (default) </ span >
1614
+ < span class ="sd "> - "raise" -- raise an error</ span >
1615
1615
< span class ="sd "> - "wrap" -- wrap around</ span >
1616
1616
< span class ="sd "> - "clip" -- clip to the range</ span >
1617
1617
< span class ="sd "> In "clip" mode, a negative index which would normally wrap will</ span >
1618
1618
< span class ="sd "> clip to 0 instead.</ span >
1619
+ < span class ="sd "> Default: ``"raise"``.</ span >
1619
1620
< span class ="sd "> order : {None, "C", "F"}, optional</ span >
1620
1621
< span class ="sd "> Determines whether the multi-index should be viewed as indexing in</ span >
1621
1622
< span class ="sd "> row-major (C-style) or column-major (Fortran-style) order.</ span >
1623
+ < span class ="sd "> Default: ``"C"``.</ span >
1622
1624
1623
1625
< span class ="sd "> Returns</ span >
1624
1626
< span class ="sd "> -------</ span >
@@ -1634,17 +1636,18 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
1634
1636
< span class ="sd "> Examples</ span >
1635
1637
< span class ="sd "> --------</ span >
1636
1638
< span class ="sd "> >>> import dpnp as np</ span >
1637
- < span class ="sd "> >>> arr = np.array([[3,6, 6],[4,5, 1]])</ span >
1638
- < span class ="sd "> >>> np.ravel_multi_index(arr, (7,6))</ span >
1639
+ < span class ="sd "> >>> arr = np.array([[3, 6, 6], [4, 5, 1]])</ span >
1640
+ < span class ="sd "> >>> np.ravel_multi_index(arr, (7, 6))</ span >
1639
1641
< span class ="sd "> array([22, 41, 37])</ span >
1640
- < span class ="sd "> >>> np.ravel_multi_index(arr, (7,6), order="F")</ span >
1642
+ < span class ="sd "> >>> np.ravel_multi_index(arr, (7, 6), order="F")</ span >
1641
1643
< span class ="sd "> array([31, 41, 13])</ span >
1642
- < span class ="sd "> >>> np.ravel_multi_index(arr, (4,6), mode="clip")</ span >
1644
+ < span class ="sd "> >>> np.ravel_multi_index(arr, (4, 6), mode="clip")</ span >
1643
1645
< span class ="sd "> array([22, 23, 19])</ span >
1644
- < span class ="sd "> >>> np.ravel_multi_index(arr, (4,4), mode=("clip","wrap"))</ span >
1646
+ < span class ="sd "> >>> np.ravel_multi_index(arr, (4, 4), mode=("clip", "wrap"))</ span >
1645
1647
< span class ="sd "> array([12, 13, 13])</ span >
1646
- < span class ="sd "> >>> np.ravel_multi_index((3,1,4,1), (6,7,8,9))</ span >
1647
- < span class ="sd "> 1621</ span >
1648
+ < span class ="sd "> >>> arr = np.array([3, 1, 4, 1])</ span >
1649
+ < span class ="sd "> >>> np.ravel_multi_index(arr, (6, 7, 8, 9))</ span >
1650
+ < span class ="sd "> array(1621)</ span >
1648
1651
1649
1652
< span class ="sd "> """</ span >
1650
1653
@@ -1657,11 +1660,8 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
1657
1660
< span class ="n "> s</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span >
1658
1661
< span class ="n "> ravel_strides</ span > < span class ="o "> =</ span > < span class ="p "> [</ span > < span class ="mi "> 1</ span > < span class ="p "> ]</ span > < span class ="o "> *</ span > < span class ="n "> ndim</ span >
1659
1662
1660
- < span class ="k "> if</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> is_supported_array_type</ span > < span class ="p "> (</ span > < span class ="n "> multi_index</ span > < span class ="p "> ):</ span >
1661
- < span class ="n "> usm_type_alloc</ span > < span class ="o "> =</ span > < span class ="n "> multi_index</ span > < span class ="o "> .</ span > < span class ="n "> usm_type</ span >
1662
- < span class ="n "> sycl_queue_alloc</ span > < span class ="o "> =</ span > < span class ="n "> multi_index</ span > < span class ="o "> .</ span > < span class ="n "> sycl_queue</ span >
1663
- < span class ="k "> else</ span > < span class ="p "> :</ span >
1664
- < span class ="n "> usm_type_alloc</ span > < span class ="p "> ,</ span > < span class ="n "> sycl_queue_alloc</ span > < span class ="o "> =</ span > < span class ="n "> get_usm_allocations</ span > < span class ="p "> (</ span > < span class ="n "> multi_index</ span > < span class ="p "> )</ span >
1663
+ < span class ="n "> multi_index</ span > < span class ="o "> =</ span > < span class ="nb "> tuple</ span > < span class ="p "> (</ span > < span class ="n "> multi_index</ span > < span class ="p "> )</ span >
1664
+ < span class ="n "> usm_type_alloc</ span > < span class ="p "> ,</ span > < span class ="n "> sycl_queue_alloc</ span > < span class ="o "> =</ span > < span class ="n "> get_usm_allocations</ span > < span class ="p "> (</ span > < span class ="n "> multi_index</ span > < span class ="p "> )</ span >
1665
1665
1666
1666
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "C"</ span > < span class ="k "> if</ span > < span class ="n "> order</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="k "> else</ span > < span class ="n "> order</ span > < span class ="o "> .</ span > < span class ="n "> upper</ span > < span class ="p "> ()</ span >
1667
1667
< span class ="k "> if</ span > < span class ="n "> order</ span > < span class ="o "> ==</ span > < span class ="s2 "> "C"</ span > < span class ="p "> :</ span >
@@ -1681,7 +1681,6 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
1681
1681
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue_alloc</ span > < span class ="p "> ,</ span >
1682
1682
< span class ="p "> )</ span >
1683
1683
< span class ="k "> for</ span > < span class ="n "> d</ span > < span class ="p "> ,</ span > < span class ="n "> stride</ span > < span class ="p "> ,</ span > < span class ="n "> idx</ span > < span class ="p "> ,</ span > < span class ="n "> _mode</ span > < span class ="ow "> in</ span > < span class ="nb "> zip</ span > < span class ="p "> (</ span > < span class ="n "> dims</ span > < span class ="p "> ,</ span > < span class ="n "> ravel_strides</ span > < span class ="p "> ,</ span > < span class ="n "> multi_index</ span > < span class ="p "> ,</ span > < span class ="n "> mode</ span > < span class ="p "> ):</ span >
1684
- < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_supported_arrays_type</ span > < span class ="p "> (</ span > < span class ="n "> idx</ span > < span class ="p "> )</ span >
1685
1684
< span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> can_cast</ span > < span class ="p "> (</ span > < span class ="n "> idx</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> int64</ span > < span class ="p "> ,</ span > < span class ="s2 "> "same_kind"</ span > < span class ="p "> ):</ span >
1686
1685
< span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span >
1687
1686
< span class ="sa "> f</ span > < span class ="s2 "> "multi_index entries could not be cast from dtype(</ span > < span class ="si "> {</ span > < span class ="n "> idx</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="si "> }</ span > < span class ="s2 "> )"</ span >
@@ -2485,9 +2484,9 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
2485
2484
< span class ="sd "> ----------</ span >
2486
2485
< span class ="sd "> indices : {dpnp.ndarray, usm_ndarray}</ span >
2487
2486
< span class ="sd "> An integer array whose elements are indices into the flattened version</ span >
2488
- < span class ="sd "> of an array of dimensions shape.</ span >
2489
- < span class ="sd "> shape : tuple of ints</ span >
2490
- < span class ="sd "> The shape of the array to use for unraveling indices.</ span >
2487
+ < span class ="sd "> of an array of dimensions `` shape`` .</ span >
2488
+ < span class ="sd "> shape : tuple or list of ints</ span >
2489
+ < span class ="sd "> The shape of the array to use for unraveling `` indices`` .</ span >
2491
2490
< span class ="sd "> order : {None, "C", "F"}, optional</ span >
2492
2491
< span class ="sd "> Determines whether the indices should be viewed as indexing in</ span >
2493
2492
< span class ="sd "> row-major (C-style) or column-major (Fortran-style) order.</ span >
@@ -2507,13 +2506,13 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
2507
2506
< span class ="sd "> Examples</ span >
2508
2507
< span class ="sd "> --------</ span >
2509
2508
< span class ="sd "> import dpnp as np</ span >
2510
- < span class ="sd "> >>> np.unravel_index([22, 41, 37], (7,6))</ span >
2509
+ < span class ="sd "> >>> np.unravel_index(np.array( [22, 41, 37]) , (7, 6))</ span >
2511
2510
< span class ="sd "> (array([3, 6, 6]), array([4, 5, 1]))</ span >
2512
- < span class ="sd "> >>> np.unravel_index([31, 41, 13], (7,6), order=' ;F' ;)</ span >
2511
+ < span class ="sd "> >>> np.unravel_index(np.array( [31, 41, 13]) , (7, 6), order=" ;F" ;)</ span >
2513
2512
< span class ="sd "> (array([3, 6, 6]), array([4, 5, 1]))</ span >
2514
2513
2515
- < span class ="sd "> >>> np.unravel_index(1621, (6,7,8, 9))</ span >
2516
- < span class ="sd "> (3, 1, 4, 1 )</ span >
2514
+ < span class ="sd "> >>> np.unravel_index(np.array( 1621) , (6, 7, 8, 9))</ span >
2515
+ < span class ="sd "> (array(3), array(1), array(4), array(1) )</ span >
2517
2516
2518
2517
< span class ="sd "> """</ span >
2519
2518
0 commit comments