12
12
</ script >
13
13
14
14
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
15
- < title > dpnp.dpnp_iface_arraycreation — Data Parallel Extension for NumPy 0.16.0dev0+155.g78b0bee505 documentation</ title >
15
+ < title > dpnp.dpnp_iface_arraycreation — Data Parallel Extension for NumPy 0.16.0dev0+165.g39109869f0f 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=e1b9974c "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=f22b0320 "> </ 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+155.g78b0bee505
46
+ 0.16.0dev0+165.g39109869f0f
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
@@ -328,17 +328,24 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
328
328
< span class ="sd "> The desired dtype for the array. If not given, a default dtype will be</ span >
329
329
< span class ="sd "> used that can represent the values (by considering Promotion Type Rule</ span >
330
330
< span class ="sd "> and device capabilities when necessary).</ span >
331
- < span class ="sd "> copy : bool, optional</ span >
332
- < span class ="sd "> If ``True`` (default), then the object is copied.</ span >
331
+ < span class ="sd "> Default: ``None``.</ span >
332
+ < span class ="sd "> copy : {None, bool}, optional</ span >
333
+ < span class ="sd "> If ``True``, then the array data is copied. If ``None``, a copy will</ span >
334
+ < span class ="sd "> only be made if a copy is needed to satisfy any of the requirements</ span >
335
+ < span class ="sd "> (``dtype``, ``order``, etc.). For ``False`` it raises a ``ValueError``</ span >
336
+ < span class ="sd "> exception if a copy can not be avoided.</ span >
337
+ < span class ="sd "> Default: ``True``.</ span >
333
338
< span class ="sd "> order : {"C", "F", "A", "K"}, optional</ span >
334
- < span class ="sd "> Memory layout of the newly output array. Default: "K".</ span >
339
+ < span class ="sd "> Memory layout of the newly output array.</ span >
340
+ < span class ="sd "> Default: "K".</ span >
335
341
< span class ="sd "> device : {None, string, SyclDevice, SyclQueue}, optional</ span >
336
342
< span class ="sd "> An array API concept of device where the output array is created.</ span >
337
343
< span class ="sd "> The `device` can be ``None`` (the default), an OneAPI filter selector</ span >
338
344
< span class ="sd "> string, an instance of :class:`dpctl.SyclDevice` corresponding to</ span >
339
345
< span class ="sd "> a non-partitioned SYCL device, an instance of :class:`dpctl.SyclQueue`,</ span >
340
346
< span class ="sd "> or a `Device` object returned by</ span >
341
347
< span class ="sd "> :obj:`dpnp.dpnp_array.dpnp_array.device` property.</ span >
348
+ < span class ="sd "> Default: ``None``.</ span >
342
349
< span class ="sd "> usm_type : {None, "device", "shared", "host"}, optional</ span >
343
350
< span class ="sd "> The type of SYCL USM allocation for the output array.</ span >
344
351
< span class ="sd "> Default: ``None``.</ span >
@@ -417,11 +424,6 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
417
424
< span class ="sa "> f</ span > < span class ="s2 "> "default value ``0``, but got </ span > < span class ="si "> {</ span > < span class ="n "> ndmin</ span > < span class ="si "> }</ span > < span class ="s2 "> "</ span >
418
425
< span class ="p "> )</ span >
419
426
420
- < span class ="c1 "> # `False`` in numpy means exactly the same like `None` in python array API:</ span >
421
- < span class ="c1 "> # that is to reuse existing memory buffer if possible or to copy otherwise.</ span >
422
- < span class ="k "> if</ span > < span class ="n "> copy</ span > < span class ="ow "> is</ span > < span class ="kc "> False</ span > < span class ="p "> :</ span >
423
- < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
424
-
425
427
< span class ="k "> return</ span > < span class ="n "> dpnp_container</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
426
428
< span class ="n "> a</ span > < span class ="p "> ,</ span >
427
429
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
@@ -544,10 +546,12 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
544
546
< span class ="n "> a</ span > < span class ="p "> ,</ span >
545
547
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
546
548
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
547
- < span class ="n " > like </ span > < span class =" o "> = </ span > < span class =" kc " > None </ span > < span class ="p "> ,</ span >
549
+ < span class ="o "> * </ span > < span class ="p "> ,</ span >
548
550
< span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
549
551
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
550
552
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
553
+ < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
554
+ < span class ="n "> like</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
551
555
< span class ="p "> ):</ span >
552
556
< span class ="w "> </ span > < span class ="sd "> """</ span >
553
557
< span class ="sd "> Converts an input object into array.</ span >
@@ -564,15 +568,18 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
564
568
< span class ="sd "> The desired dtype for the array. If not given, a default dtype will be</ span >
565
569
< span class ="sd "> used that can represent the values (by considering Promotion Type Rule</ span >
566
570
< span class ="sd "> and device capabilities when necessary).</ span >
571
+ < span class ="sd "> Default: ``None``.</ span >
567
572
< span class ="sd "> order : {None, "C", "F", "A", "K"}, optional</ span >
568
- < span class ="sd "> Memory layout of the newly output array. Default: "K".</ span >
573
+ < span class ="sd "> Memory layout of the newly output array.</ span >
574
+ < span class ="sd "> Default: "K".</ span >
569
575
< span class ="sd "> device : {None, string, SyclDevice, SyclQueue}, optional</ span >
570
576
< span class ="sd "> An array API concept of device where the output array is created.</ span >
571
577
< span class ="sd "> The `device` can be ``None`` (the default), an OneAPI filter selector</ span >
572
578
< span class ="sd "> string, an instance of :class:`dpctl.SyclDevice` corresponding to</ span >
573
579
< span class ="sd "> a non-partitioned SYCL device, an instance of :class:`dpctl.SyclQueue`,</ span >
574
580
< span class ="sd "> or a `Device` object returned by</ span >
575
581
< span class ="sd "> :obj:`dpnp.dpnp_array.dpnp_array.device` property.</ span >
582
+ < span class ="sd "> Default: ``None``.</ span >
576
583
< span class ="sd "> usm_type : {None, "device", "shared", "host"}, optional</ span >
577
584
< span class ="sd "> The type of SYCL USM allocation for the output array.</ span >
578
585
< span class ="sd "> Default: ``None``.</ span >
@@ -582,6 +589,12 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
582
589
< span class ="sd "> to get the SYCL queue from `device` keyword if present or to use</ span >
583
590
< span class ="sd "> a default queue.</ span >
584
591
< span class ="sd "> Default: ``None``.</ span >
592
+ < span class ="sd "> copy : {None, bool}, optional</ span >
593
+ < span class ="sd "> If ``True``, then the array data is copied. If ``None``, a copy will</ span >
594
+ < span class ="sd "> only be made if a copy is needed to satisfy any of the requirements</ span >
595
+ < span class ="sd "> (``dtype``, ``order``, etc.). For ``False`` it raises a ``ValueError``</ span >
596
+ < span class ="sd "> exception if a copy can not be avoided.</ span >
597
+ < span class ="sd "> Default: ``True``.</ span >
585
598
586
599
< span class ="sd "> Returns</ span >
587
600
< span class ="sd "> -------</ span >
@@ -634,6 +647,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
634
647
< span class ="k "> return</ span > < span class ="n "> dpnp_container</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
635
648
< span class ="n "> a</ span > < span class ="p "> ,</ span >
636
649
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
650
+ < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="n "> copy</ span > < span class ="p "> ,</ span >
637
651
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
638
652
< span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span >
639
653
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
0 commit comments