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+115.g79d2fd942b documentation</ title >
15
+ < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.16.0dev0+127.g2f8aed7b81 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=8e70e022 "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=77b75cb0 "> </ 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+115.g79d2fd942b
46
+ 0.16.0dev0+127.g2f8aed7b81
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -162,31 +162,30 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
162
162
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="s2 "> "device"</ span > < span class ="p "> ,</ span >
163
163
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
164
164
< span class ="p "> ):</ span >
165
+ < span class ="k "> if</ span > < span class ="n "> order</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
166
+ < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "C"</ span >
167
+
165
168
< span class ="k "> if</ span > < span class ="n "> buffer</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
166
- < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> buffer</ span > < span class ="p "> ,</ span > < span class ="n "> dpt</ span > < span class ="o "> .</ span > < span class ="n "> usm_ndarray</ span > < span class ="p "> ):</ span >
167
- < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span >
168
- < span class ="s2 "> "Expected dpctl.tensor.usm_ndarray, got </ span > < span class ="si "> {}</ span > < span class ="s2 "> "</ span >
169
- < span class ="s2 "> ""</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="nb "> type</ span > < span class ="p "> (</ span > < span class ="n "> buffer</ span > < span class ="p "> ))</ span >
170
- < span class ="p "> )</ span >
171
- < span class ="k "> if</ span > < span class ="n "> buffer</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="o "> !=</ span > < span class ="n "> shape</ span > < span class ="p "> :</ span >
172
- < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span >
173
- < span class ="s2 "> "Expected buffer.shape=</ span > < span class ="si "> {}</ span > < span class ="s2 "> , got </ span > < span class ="si "> {}</ span > < span class ="s2 "> "</ span >
174
- < span class ="s2 "> ""</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> shape</ span > < span class ="p "> ,</ span > < span class ="n "> buffer</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="p "> )</ span >
175
- < span class ="p "> )</ span >
176
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _array_obj</ span > < span class ="o "> =</ span > < span class ="n "> dpt</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span > < span class ="n "> buffer</ span > < span class ="p "> ,</ span > < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> )</ span >
169
+ < span class ="n "> buffer</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> get_usm_ndarray</ span > < span class ="p "> (</ span > < span class ="n "> buffer</ span > < span class ="p "> )</ span >
170
+
171
+ < span class ="k "> if</ span > < span class ="n "> dtype</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
172
+ < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> buffer</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span >
177
173
< span class ="k "> else</ span > < span class ="p "> :</ span >
178
- < span class ="n "> sycl_queue_normalized</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> get_normalized_queue_device</ span > < span class ="p "> (</ span >
179
- < span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span > < span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span >
180
- < span class ="p "> )</ span >
181
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _array_obj</ span > < span class ="o "> =</ span > < span class ="n "> dpt</ span > < span class ="o "> .</ span > < span class ="n "> usm_ndarray</ span > < span class ="p "> (</ span >
182
- < span class ="n "> shape</ span > < span class ="p "> ,</ span >
183
- < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
184
- < span class ="n "> strides</ span > < span class ="o "> =</ span > < span class ="n "> strides</ span > < span class ="p "> ,</ span >
185
- < span class ="n "> buffer</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
186
- < span class ="n "> offset</ span > < span class ="o "> =</ span > < span class ="n "> offset</ span > < span class ="p "> ,</ span >
187
- < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
188
- < span class ="n "> buffer_ctor_kwargs</ span > < span class ="o "> =</ span > < span class ="p "> {</ span > < span class ="s2 "> "queue"</ span > < span class ="p "> :</ span > < span class ="n "> sycl_queue_normalized</ span > < span class ="p "> },</ span >
189
- < span class ="p "> )</ span >
174
+ < span class ="n "> buffer</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span >
175
+
176
+ < span class ="n "> sycl_queue_normalized</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> get_normalized_queue_device</ span > < span class ="p "> (</ span >
177
+ < span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span > < span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span >
178
+ < span class ="p "> )</ span >
179
+
180
+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _array_obj</ span > < span class ="o "> =</ span > < span class ="n "> dpt</ span > < span class ="o "> .</ span > < span class ="n "> usm_ndarray</ span > < span class ="p "> (</ span >
181
+ < span class ="n "> shape</ span > < span class ="p "> ,</ span >
182
+ < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
183
+ < span class ="n "> strides</ span > < span class ="o "> =</ span > < span class ="n "> strides</ span > < span class ="p "> ,</ span >
184
+ < span class ="n "> buffer</ span > < span class ="o "> =</ span > < span class ="n "> buffer</ span > < span class ="p "> ,</ span >
185
+ < span class ="n "> offset</ span > < span class ="o "> =</ span > < span class ="n "> offset</ span > < span class ="p "> ,</ span >
186
+ < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
187
+ < span class ="n "> buffer_ctor_kwargs</ span > < span class ="o "> =</ span > < span class ="p "> {</ span > < span class ="s2 "> "queue"</ span > < span class ="p "> :</ span > < span class ="n "> sycl_queue_normalized</ span > < span class ="p "> },</ span >
188
+ < span class ="p "> )</ span >
190
189
191
190
< span class ="nd "> @property</ span >
192
191
< span class ="k "> def</ span > < span class ="nf "> __sycl_usm_array_interface__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
@@ -582,6 +581,8 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
582
581
< span class ="c1 "> # '__setstate__',</ span >
583
582
< span class ="c1 "> # '__sizeof__',</ span >
584
583
584
+ < span class ="vm "> __slots__</ span > < span class ="o "> =</ span > < span class ="p "> (</ span > < span class ="s2 "> "_array_obj"</ span > < span class ="p "> ,)</ span >
585
+
585
586
< span class ="k "> def</ span > < span class ="fm "> __str__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
586
587
< span class ="w "> </ span > < span class ="sd "> """Return ``str(self)``."""</ span >
587
588
< span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _array_obj</ span > < span class ="o "> .</ span > < span class ="fm "> __str__</ span > < span class ="p "> ()</ span >
@@ -855,10 +856,35 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
855
856
856
857
< div class ="viewcode-block " id ="dpnp_array.copy ">
857
858
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.copy "> [docs]</ a >
858
- < 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 >
859
860
< span class ="w "> </ span > < span class ="sd "> """</ span >
860
861
< span class ="sd "> Return a copy of the array.</ span >
861
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
+
862
888
< span class ="sd "> Returns</ span >
863
889
< span class ="sd "> -------</ span >
864
890
< span class ="sd "> out : dpnp.ndarray</ span >
@@ -871,8 +897,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
871
897
872
898
< span class ="sd "> Notes</ span >
873
899
< span class ="sd "> -----</ span >
874
- < span class ="sd "> This function is the preferred method for creating an array copy. The</ span >
875
- < 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 >
876
903
877
904
< span class ="sd "> Examples</ span >
878
905
< span class ="sd "> --------</ span >
@@ -894,7 +921,13 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
894
921
895
922
< span class ="sd "> """</ span >
896
923
897
- < 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 >
898
931
899
932
900
933
< span class ="c1 "> # 'ctypes',</ span >
@@ -1493,6 +1526,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1493
1526
1494
1527
< span class ="sd "> """</ span >
1495
1528
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 >
1531
+
1496
1532
< 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 >
1497
1533
1498
1534
< span class ="nd "> @property</ span >
0 commit comments