12
12
</ script >
13
13
14
14
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
15
- < title > dpnp.dpnp_iface — Data Parallel Extension for NumPy 0.13.1dev1+15.g85f5a06ef9 documentation</ title >
15
+ < title > dpnp.dpnp_iface — Data Parallel Extension for NumPy 0.13.1dev1+24.g6e1b1393e0 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=919706d4 "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=387ab620 "> </ script >
27
27
< script src ="../../_static/doctools.js?v=888ff710 "> </ 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.13.1dev1+15.g85f5a06ef9
46
+ 0.13.1dev1+24.g6e1b1393e0
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -146,6 +146,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
146
146
< span class ="s2 "> "array_equal"</ span > < span class ="p "> ,</ span >
147
147
< span class ="s2 "> "asnumpy"</ span > < span class ="p "> ,</ span >
148
148
< span class ="s2 "> "astype"</ span > < span class ="p "> ,</ span >
149
+ < span class ="s2 "> "check_supported_arrays_type"</ span > < span class ="p "> ,</ span >
149
150
< span class ="s2 "> "convert_single_elem_array_to_scalar"</ span > < span class ="p "> ,</ span >
150
151
< span class ="s2 "> "default_float_type"</ span > < span class ="p "> ,</ span >
151
152
< span class ="s2 "> "dpnp_queue_initialize"</ span > < span class ="p "> ,</ span >
@@ -158,7 +159,6 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
158
159
< span class ="s2 "> "get_usm_ndarray_or_scalar"</ span > < span class ="p "> ,</ span >
159
160
< span class ="s2 "> "is_supported_array_or_scalar"</ span > < span class ="p "> ,</ span >
160
161
< span class ="s2 "> "is_supported_array_type"</ span > < span class ="p "> ,</ span >
161
- < span class ="s2 "> "_replace_nan"</ span > < span class ="p "> ,</ span >
162
162
< span class ="p "> ]</ span >
163
163
164
164
< span class ="kn "> from</ span > < span class ="nn "> dpnp</ span > < span class ="kn "> import</ span > < span class ="n "> float64</ span > < span class ="p "> ,</ span > < span class ="n "> isscalar</ span >
@@ -180,6 +180,8 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
180
180
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_manipulation</ span > < span class ="kn "> import</ span > < span class ="n "> __all__</ span > < span class ="k "> as</ span > < span class ="n "> __all__manipulation</ span >
181
181
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_mathematical</ span > < span class ="kn "> import</ span > < span class ="o "> *</ span >
182
182
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_mathematical</ span > < span class ="kn "> import</ span > < span class ="n "> __all__</ span > < span class ="k "> as</ span > < span class ="n "> __all__mathematical</ span >
183
+ < span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_nanfunctions</ span > < span class ="kn "> import</ span > < span class ="o "> *</ span >
184
+ < span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_nanfunctions</ span > < span class ="kn "> import</ span > < span class ="n "> __all__</ span > < span class ="k "> as</ span > < span class ="n "> __all__nanfunctions</ span >
183
185
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_searching</ span > < span class ="kn "> import</ span > < span class ="o "> *</ span >
184
186
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_searching</ span > < span class ="kn "> import</ span > < span class ="n "> __all__</ span > < span class ="k "> as</ span > < span class ="n "> __all__searching</ span >
185
187
< span class ="kn "> from</ span > < span class ="nn "> dpnp.dpnp_iface_sorting</ span > < span class ="kn "> import</ span > < span class ="o "> *</ span >
@@ -198,6 +200,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
198
200
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__logic</ span >
199
201
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__manipulation</ span >
200
202
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__mathematical</ span >
203
+ < span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__nanfunctions</ span >
201
204
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__searching</ span >
202
205
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__sorting</ span >
203
206
< span class ="n "> __all__</ span > < span class ="o "> +=</ span > < span class ="n "> __all__statistics</ span >
@@ -298,6 +301,42 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
298
301
< span class ="k "> return</ span > < span class ="n "> dpnp_array</ span > < span class ="o "> .</ span > < span class ="n "> _create_from_usm_ndarray</ span > < span class ="p "> (</ span > < span class ="n "> array_obj</ span > < span class ="p "> )</ span >
299
302
300
303
304
+ < span class ="k "> def</ span > < span class ="nf "> check_supported_arrays_type</ span > < span class ="p "> (</ span > < span class ="o "> *</ span > < span class ="n "> arrays</ span > < span class ="p "> ,</ span > < span class ="n "> scalar_type</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
305
+ < span class ="w "> </ span > < span class ="sd "> """</ span >
306
+ < span class ="sd "> Return ``True`` if each array has either type of scalar,</ span >
307
+ < span class ="sd "> :class:`dpnp.ndarray` or :class:`dpctl.tensor.usm_ndarray`.</ span >
308
+ < span class ="sd "> But if any array has unsupported type, ``TypeError`` will be raised.</ span >
309
+
310
+ < span class ="sd "> Parameters</ span >
311
+ < span class ="sd "> ----------</ span >
312
+ < span class ="sd "> arrays : {dpnp_array, usm_ndarray}</ span >
313
+ < span class ="sd "> Input arrays to check for supported types.</ span >
314
+ < span class ="sd "> scalar_type : {bool}, optional</ span >
315
+ < span class ="sd "> A scalar type is also considered as supported if flag is True.</ span >
316
+
317
+ < span class ="sd "> Returns</ span >
318
+ < span class ="sd "> -------</ span >
319
+ < span class ="sd "> out : bool</ span >
320
+ < span class ="sd "> ``True`` if each type of input `arrays` is supported type,</ span >
321
+ < span class ="sd "> ``False`` otherwise.</ span >
322
+
323
+ < span class ="sd "> Raises</ span >
324
+ < span class ="sd "> ------</ span >
325
+ < span class ="sd "> TypeError</ span >
326
+ < span class ="sd "> If any input array from `arrays` is of unsupported array type.</ span >
327
+
328
+ < span class ="sd "> """</ span >
329
+
330
+ < span class ="k "> for</ span > < span class ="n "> a</ span > < span class ="ow "> in</ span > < span class ="n "> arrays</ span > < span class ="p "> :</ span >
331
+ < span class ="k "> if</ span > < span class ="n "> scalar_type</ span > < span class ="ow "> and</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> isscalar</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> )</ span > < span class ="ow "> or</ span > < span class ="n "> is_supported_array_type</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ):</ span >
332
+ < span class ="k "> continue</ span >
333
+
334
+ < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span >
335
+ < span class ="s2 "> "An array must be any of supported type, but got </ span > < span class ="si "> {}</ span > < 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 "> a</ span > < span class ="p "> ))</ span >
336
+ < span class ="p "> )</ span >
337
+ < span class ="k "> return</ span > < span class ="kc "> True</ span >
338
+
339
+
301
340
< span class ="k "> def</ span > < span class ="nf "> convert_single_elem_array_to_scalar</ span > < span class ="p "> (</ span > < span class ="n "> obj</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
302
341
< span class ="w "> </ span > < span class ="sd "> """Convert array with single element to scalar."""</ span >
303
342
@@ -530,11 +569,12 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
530
569
< span class ="sd "> ----------</ span >
531
570
< span class ="sd "> a : {dpnp_array}</ span >
532
571
< span class ="sd "> Input array.</ span >
533
-
534
572
< span class ="sd "> out : {dpnp_array, usm_ndarray}</ span >
535
573
< span class ="sd "> If provided, value of `a` array will be copied into it</ span >
536
574
< span class ="sd "> according to ``safe`` casting rule.</ span >
537
575
< span class ="sd "> It should be of the appropriate shape.</ span >
576
+ < span class ="sd "> casting : {'no', 'equiv', 'safe', 'same_kind', 'unsafe'}, optional</ span >
577
+ < span class ="sd "> Controls what kind of data casting may occur.</ span >
538
578
539
579
< span class ="sd "> Returns</ span >
540
580
< span class ="sd "> -------</ span >
@@ -663,46 +703,6 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
663
703
< span class ="sd "> """</ span >
664
704
665
705
< span class ="k "> return</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="p "> (</ span > < span class ="n "> dpnp_array</ span > < span class ="p "> ,</ span > < span class ="n "> dpt</ span > < span class ="o "> .</ span > < span class ="n "> usm_ndarray</ span > < span class ="p "> ))</ span >
666
-
667
-
668
- < span class ="k "> def</ span > < span class ="nf "> _replace_nan</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="n "> val</ span > < span class ="p "> ):</ span >
669
- < span class ="w "> </ span > < span class ="sd "> """</ span >
670
- < span class ="sd "> If `a` is of inexact type, make a copy of `a`, replace NaNs with</ span >
671
- < span class ="sd "> the `val` value, and return the copy together with a boolean mask</ span >
672
- < span class ="sd "> marking the locations where NaNs were present. If `a` is not of</ span >
673
- < span class ="sd "> inexact type, do nothing and return `a` together with a mask of None.</ span >
674
- < span class ="sd "> Note that scalars will end up as array scalars, which is important</ span >
675
- < span class ="sd "> for using the result as the value of the out argument in some</ span >
676
- < span class ="sd "> operations.</ span >
677
- < span class ="sd "> Parameters</ span >
678
- < span class ="sd "> ----------</ span >
679
- < span class ="sd "> a : {dpnp_array, usm_ndarray}</ span >
680
- < span class ="sd "> Input array.</ span >
681
- < span class ="sd "> val : float</ span >
682
- < span class ="sd "> NaN values are set to val before doing the operation.</ span >
683
- < span class ="sd "> Returns</ span >
684
- < span class ="sd "> -------</ span >
685
- < span class ="sd "> out : {dpnp_array}</ span >
686
- < span class ="sd "> If `a` is of inexact type, return a copy of `a` with the NaNs</ span >
687
- < span class ="sd "> replaced by the fill value, otherwise return `a`.</ span >
688
- < span class ="sd "> mask: {bool, None}</ span >
689
- < span class ="sd "> If `a` is of inexact type, return a boolean mask marking locations of</ span >
690
- < span class ="sd "> NaNs, otherwise return None.</ span >
691
- < span class ="sd "> """</ span >
692
-
693
- < span class ="k "> if</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> is_supported_array_or_scalar</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ):</ span >
694
- < span class ="k "> if</ span > < span class ="nb "> issubclass</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="o "> .</ span > < span class ="n "> type</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> inexact</ span > < span class ="p "> ):</ span >
695
- < span class ="n "> mask</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> isnan</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> )</ span >
696
- < span class ="n "> a</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> array</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> )</ span >
697
- < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> copyto</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="n "> val</ span > < span class ="p "> ,</ span > < span class ="n "> where</ span > < span class ="o "> =</ span > < span class ="n "> mask</ span > < span class ="p "> )</ span >
698
- < span class ="k "> else</ span > < span class ="p "> :</ span >
699
- < span class ="n "> mask</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
700
- < span class ="k "> else</ span > < span class ="p "> :</ span >
701
- < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span >
702
- < span class ="s2 "> "An array must be any of supported type, but got </ span > < span class ="si "> {}</ span > < 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 "> a</ span > < span class ="p "> ))</ span >
703
- < span class ="p "> )</ span >
704
-
705
- < span class ="k "> return</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="n "> mask</ span >
706
706
</ pre > </ div >
707
707
708
708
</ div >
0 commit comments