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+114.g92597db978 documentation</ title >
15
+ < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.16.0dev0+122.gf81393b667 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=a3a31435 "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=3850e290 "> </ 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+114.g92597db978
46
+ 0.16.0dev0+122.gf81393b667
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -856,10 +856,35 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
856
856
857
857
< div class ="viewcode-block " id ="dpnp_array.copy ">
858
858
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.copy "> [docs]</ a >
859
- < span class ="k "> def</ span > < span class ="nf "> copy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "C"</ span > < span class ="p "> ):</ span >
859
+ < span class ="k "> def</ span > < span class ="nf "> copy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "C"</ span > < span class ="p "> , </ span > < span class =" n " > device </ span > < span class =" o " > = </ span > < span class =" kc " > None </ span > < span class =" p " > , </ span > < span class =" n " > usm_type </ span > < span class =" o " > = </ span > < span class =" kc " > None </ span > < span class =" p " > , </ span > < span class =" n " > sycl_queue </ span > < span class =" o " > = </ span > < span class =" kc " > None </ span > < span class =" p " > ):</ span >
860
860
< span class ="w "> </ span > < span class ="sd "> """</ span >
861
861
< span class ="sd "> Return a copy of the array.</ span >
862
862
863
+ < span class ="sd "> Refer to :obj:`dpnp.copy` for full documentation.</ span >
864
+
865
+ < span class ="sd "> Parameters</ span >
866
+ < span class ="sd "> ----------</ span >
867
+ < span class ="sd "> order : {"C", "F", "A", "K"}, optional</ span >
868
+ < span class ="sd "> Memory layout of the newly output array.</ span >
869
+ < span class ="sd "> Default: ``"C"``.</ span >
870
+ < span class ="sd "> device : {None, string, SyclDevice, SyclQueue}, optional</ span >
871
+ < span class ="sd "> An array API concept of device where the output array is created.</ span >
872
+ < span class ="sd "> The `device` can be ``None`` (the default), an OneAPI filter</ span >
873
+ < span class ="sd "> selector string, an instance of :class:`dpctl.SyclDevice`</ span >
874
+ < span class ="sd "> corresponding to a non-partitioned SYCL device, an instance of</ span >
875
+ < span class ="sd "> :class:`dpctl.SyclQueue`, or a `Device` object returned by</ span >
876
+ < span class ="sd "> :obj:`dpnp.dpnp_array.dpnp_array.device` property.</ span >
877
+ < span class ="sd "> Default: ``None``.</ span >
878
+ < span class ="sd "> usm_type : {None, "device", "shared", "host"}, optional</ span >
879
+ < span class ="sd "> The type of SYCL USM allocation for the output array.</ span >
880
+ < span class ="sd "> Default: ``None``.</ span >
881
+ < span class ="sd "> sycl_queue : {None, SyclQueue}, optional</ span >
882
+ < span class ="sd "> A SYCL queue to use for output array allocation and copying. The</ span >
883
+ < span class ="sd "> `sycl_queue` can be passed as ``None`` (the default), which means</ span >
884
+ < span class ="sd "> to get the SYCL queue from `device` keyword if present or to use</ span >
885
+ < span class ="sd "> a default queue.</ span >
886
+ < span class ="sd "> Default: ``None``.</ span >
887
+
863
888
< span class ="sd "> Returns</ span >
864
889
< span class ="sd "> -------</ span >
865
890
< span class ="sd "> out : dpnp.ndarray</ span >
@@ -872,8 +897,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
872
897
873
898
< span class ="sd "> Notes</ span >
874
899
< span class ="sd "> -----</ span >
875
- < span class ="sd "> This function is the preferred method for creating an array copy. The</ span >
876
- < span class ="sd "> function :func:`dpnp.copy` is similar, but it defaults to using order 'K'.</ span >
900
+ < span class ="sd "> This function is the preferred method for creating an array copy.</ span >
901
+ < span class ="sd "> The function :func:`dpnp.copy` is similar, but it defaults to using</ span >
902
+ < span class ="sd "> order ``"K"``.</ span >
877
903
878
904
< span class ="sd "> Examples</ span >
879
905
< span class ="sd "> --------</ span >
@@ -895,7 +921,13 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
895
921
896
922
< span class ="sd "> """</ span >
897
923
898
- < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> copy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> )</ span > </ div >
924
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> copy</ span > < span class ="p "> (</ span >
925
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span >
926
+ < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
927
+ < span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span >
928
+ < span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
929
+ < span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span > < span class ="p "> ,</ span >
930
+ < span class ="p "> )</ span > </ div >
899
931
900
932
901
933
< span class ="c1 "> # 'ctypes',</ span >
@@ -1482,7 +1514,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1482
1514
1483
1515
< span class ="sd "> Note</ span >
1484
1516
< span class ="sd "> ----</ span >
1485
- < span class ="sd "> Using :obj:`dpnp.ndarray.reshape` or :obj:`dpnp.reshape is the</ span >
1517
+ < span class ="sd "> Using :obj:`dpnp.ndarray.reshape` or :obj:`dpnp.reshape` is the</ span >
1486
1518
< span class ="sd "> preferred approach to set new shape of an array.</ span >
1487
1519
1488
1520
< span class ="sd "> See Also</ span >
@@ -1503,12 +1535,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1503
1535
1504
1536
< span class ="sd "> >>> y.shape = (3, 8)</ span >
1505
1537
< span class ="sd "> >>> y</ span >
1506
- < span class ="sd "> array([[[0., 0., 0., 0.],</ span >
1507
- < span class ="sd "> [0., 0., 0., 0.],</ span >
1508
- < span class ="sd "> [0., 0., 0., 0.]],</ span >
1509
- < span class ="sd "> [[0., 0., 0., 0.],</ span >
1510
- < span class ="sd "> [0., 0., 0., 0.],</ span >
1511
- < span class ="sd "> [0., 0., 0., 0.]]])</ 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 >
1512
1541
< span class ="sd "> >>> y.shape = (3, 6)</ span >
1513
1542
< span class ="sd "> ...</ span >
1514
1543
< span class ="sd "> TypeError: Can not reshape array of size 24 into (3, 6)</ span >
@@ -1522,7 +1551,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1522
1551
< span class ="w "> </ span > < span class ="sd "> """</ span >
1523
1552
< span class ="sd "> Set new lengths of axes.</ span >
1524
1553
1525
- < span class ="sd "> Modifies array instamcee in-place by changing its metadata about the</ span >
1554
+ < span class ="sd "> Modifies array instance in-place by changing its metadata about the</ span >
1526
1555
< span class ="sd "> shape and the strides of the array, or raises `AttributeError`</ span >
1527
1556
< span class ="sd "> exception if in-place change is not possible.</ span >
1528
1557
0 commit comments