14
14
</ script >
15
15
16
16
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
17
- < title > dpnp.dpnp_iface_arraycreation — Data Parallel Extension for NumPy 0.17.0dev0+82.g8216d23867b documentation</ title >
17
+ < title > dpnp.dpnp_iface_arraycreation — Data Parallel Extension for NumPy 0.17.0dev0+88.g8a8b3bbdb52 documentation</ title >
18
18
< link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=fa44fd50 " />
19
19
< link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=e59714d7 " />
20
20
21
21
22
22
< script src ="../../_static/jquery.js?v=5d32c60e "> </ script >
23
23
< script src ="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
24
- < script src ="../../_static/documentation_options.js?v=651849cb "> </ script >
24
+ < script src ="../../_static/documentation_options.js?v=7096ade7 "> </ script >
25
25
< script src ="../../_static/doctools.js?v=9a2dae69 "> </ script >
26
26
< script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
27
27
< script src ="../../_static/js/theme.js "> </ script >
@@ -409,6 +409,11 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
409
409
< span class ="sd "> order : {"C", "F", "A", "K"}, optional</ span >
410
410
< span class ="sd "> Memory layout of the newly output array.</ span >
411
411
< span class ="sd "> Default: ``"K"``.</ span >
412
+ < span class ="sd "> ndmin : int, optional</ span >
413
+ < span class ="sd "> Specifies the minimum number of dimensions that the resulting array</ span >
414
+ < span class ="sd "> should have. Ones will be prepended to the shape as needed to meet</ span >
415
+ < span class ="sd "> this requirement.</ span >
416
+ < span class ="sd "> Default: ``0``.</ span >
412
417
< span class ="sd "> device : {None, string, SyclDevice, SyclQueue}, optional</ span >
413
418
< span class ="sd "> An array API concept of device where the output array is created.</ span >
414
419
< span class ="sd "> The `device` can be ``None`` (the default), an OneAPI filter selector</ span >
@@ -435,7 +440,6 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
435
440
< span class ="sd "> Limitations</ span >
436
441
< span class ="sd "> -----------</ span >
437
442
< span class ="sd "> Parameter `subok` is supported only with default value ``False``.</ span >
438
- < span class ="sd "> Parameter `ndmin` is supported only with default value ``0``.</ span >
439
443
< span class ="sd "> Parameter `like` is supported only with default value ``None``.</ span >
440
444
< span class ="sd "> Otherwise, the function raises ``NotImplementedError`` exception.</ span >
441
445
@@ -463,6 +467,11 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
463
467
< span class ="sd "> >>> x</ span >
464
468
< span class ="sd "> array([1, 2, 3])</ span >
465
469
470
+ < span class ="sd "> Upcasting:</ span >
471
+
472
+ < span class ="sd "> >>> np.array([1, 2, 3.0])</ span >
473
+ < span class ="sd "> array([ 1., 2., 3.])</ span >
474
+
466
475
< span class ="sd "> More than one dimension:</ span >
467
476
468
477
< span class ="sd "> >>> x2 = np.array([[1, 2], [3, 4]])</ span >
@@ -472,6 +481,16 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
472
481
< span class ="sd "> array([[1, 2],</ span >
473
482
< span class ="sd "> [3, 4]])</ span >
474
483
484
+ < span class ="sd "> Minimum dimensions 2:</ span >
485
+
486
+ < span class ="sd "> >>> np.array([1, 2, 3], ndmin=2)</ span >
487
+ < span class ="sd "> array([[1, 2, 3]])</ span >
488
+
489
+ < span class ="sd "> Type provided:</ span >
490
+
491
+ < span class ="sd "> >>> np.array([1, 2, 3], dtype=complex)</ span >
492
+ < span class ="sd "> array([ 1.+0.j, 2.+0.j, 3.+0.j])</ span >
493
+
475
494
< span class ="sd "> Creating an array on a different device or with a specified usm_type</ span >
476
495
477
496
< span class ="sd "> >>> x = np.array([1, 2, 3]) # default case</ span >
@@ -489,21 +508,26 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
489
508
< span class ="sd "> """</ span >
490
509
491
510
< span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_limitations</ span > < span class ="p "> (</ span > < span class ="n "> subok</ span > < span class ="o "> =</ span > < span class ="n "> subok</ span > < span class ="p "> ,</ span > < span class ="n "> like</ span > < span class ="o "> =</ span > < span class ="n "> like</ span > < span class ="p "> )</ span >
492
- < span class ="k "> if</ span > < span class ="n "> ndmin</ span > < span class ="o "> !=</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
493
- < span class ="k "> raise</ span > < span class ="ne "> NotImplementedError</ span > < span class ="p "> (</ span >
494
- < span class ="s2 "> "Keyword argument `ndmin` is supported only with "</ span >
495
- < 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 >
496
- < span class ="p "> )</ span >
511
+ < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> ndmin</ span > < span class ="p "> ,</ span > < span class ="p "> (</ span > < span class ="nb "> int</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> integer</ span > < span class ="p "> )):</ span >
512
+ < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span > < span class ="sa "> f</ span > < span class ="s2 "> "`ndmin` should be an integer, got </ span > < span class ="si "> {</ span > < span class ="nb "> type</ span > < span class ="p "> (</ span > < span class ="n "> ndmin</ span > < span class ="p "> )</ span > < span class ="si "> }</ span > < span class ="s2 "> "</ span > < span class ="p "> )</ span >
497
513
498
- < span class ="k " > return </ span > < span class ="n "> dpnp_container</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
514
+ < span class ="n " > result </ span > < span class =" o " > = </ span > < span class ="n "> dpnp_container</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
499
515
< span class ="n "> a</ span > < span class ="p "> ,</ span >
500
516
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
501
517
< span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="n "> copy</ span > < span class ="p "> ,</ span >
502
518
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
503
519
< span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span >
504
520
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
505
521
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span > < span class ="p "> ,</ span >
506
- < span class ="p "> )</ span > </ div >
522
+ < span class ="p "> )</ span >
523
+
524
+ < span class ="n "> res_ndim</ span > < span class ="o "> =</ span > < span class ="n "> result</ span > < span class ="o "> .</ span > < span class ="n "> ndim</ span >
525
+ < span class ="k "> if</ span > < span class ="n "> res_ndim</ span > < span class ="o "> >=</ span > < span class ="n "> ndmin</ span > < span class ="p "> :</ span >
526
+ < span class ="k "> return</ span > < span class ="n "> result</ span >
527
+
528
+ < span class ="n "> num_axes</ span > < span class ="o "> =</ span > < span class ="n "> ndmin</ span > < span class ="o "> -</ span > < span class ="n "> res_ndim</ span >
529
+ < span class ="n "> new_shape</ 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 "> num_axes</ span > < span class ="o "> +</ span > < span class ="n "> result</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span >
530
+ < span class ="k "> return</ span > < span class ="n "> result</ span > < span class ="o "> .</ span > < span class ="n "> reshape</ span > < span class ="p "> (</ span > < span class ="n "> new_shape</ span > < span class ="p "> )</ span > </ div >
507
531
508
532
509
533
@@ -734,7 +758,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
734
758
< span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="o "> *</ span > < span class ="p "> ,</ span > < span class ="n "> like</ span > < span class ="o "> =</ span > < span class ="kc "> None</ 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 >
735
759
< span class ="p "> ):</ span >
736
760
< span class ="w "> </ span > < span class ="sd "> """</ span >
737
- < span class ="sd "> Return a contiguous array in memory (C order).</ span >
761
+ < span class ="sd "> Return a contiguous array ``(ndim >= 1)`` in memory (C order).</ span >
738
762
739
763
< span class ="sd "> For full documentation refer to :obj:`numpy.ascontiguousarray`.</ span >
740
764
@@ -830,14 +854,12 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
830
854
831
855
< span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_limitations</ span > < span class ="p "> (</ span > < span class ="n "> like</ span > < span class ="o "> =</ span > < span class ="n "> like</ span > < span class ="p "> )</ span >
832
856
833
- < span class ="c1 "> # at least 1-d array has to be returned</ span >
834
- < span class ="k "> if</ 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 ="nb "> hasattr</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="s2 "> "ndim"</ span > < span class ="p "> )</ span > < span class ="ow "> and</ span > < span class ="n "> a</ span > < span class ="o "> .</ span > < span class ="n "> ndim</ span > < span class ="o "> ==</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
835
- < span class ="n "> a</ span > < span class ="o "> =</ span > < span class ="p "> [</ span > < span class ="n "> a</ span > < span class ="p "> ]</ span >
836
-
837
- < span class ="k "> return</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
857
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> array</ span > < span class ="p "> (</ span >
838
858
< span class ="n "> a</ span > < span class ="p "> ,</ span >
839
859
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
860
+ < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
840
861
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "C"</ span > < span class ="p "> ,</ span >
862
+ < span class ="n "> ndmin</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span >
841
863
< span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span >
842
864
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
843
865
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span > < span class ="p "> ,</ span >
@@ -951,14 +973,12 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
951
973
952
974
< span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_limitations</ span > < span class ="p "> (</ span > < span class ="n "> like</ span > < span class ="o "> =</ span > < span class ="n "> like</ span > < span class ="p "> )</ span >
953
975
954
- < span class ="c1 "> # at least 1-d array has to be returned</ span >
955
- < span class ="k "> if</ 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 ="nb "> hasattr</ span > < span class ="p "> (</ span > < span class ="n "> a</ span > < span class ="p "> ,</ span > < span class ="s2 "> "ndim"</ span > < span class ="p "> )</ span > < span class ="ow "> and</ span > < span class ="n "> a</ span > < span class ="o "> .</ span > < span class ="n "> ndim</ span > < span class ="o "> ==</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
956
- < span class ="n "> a</ span > < span class ="o "> =</ span > < span class ="p "> [</ span > < span class ="n "> a</ span > < span class ="p "> ]</ span >
957
-
958
- < span class ="k "> return</ span > < span class ="n "> asarray</ span > < span class ="p "> (</ span >
976
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> array</ span > < span class ="p "> (</ span >
959
977
< span class ="n "> a</ span > < span class ="p "> ,</ span >
960
978
< span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span >
979
+ < span class ="n "> copy</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
961
980
< span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="s2 "> "F"</ span > < span class ="p "> ,</ span >
981
+ < span class ="n "> ndmin</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span >
962
982
< span class ="n "> device</ span > < span class ="o "> =</ span > < span class ="n "> device</ span > < span class ="p "> ,</ span >
963
983
< span class ="n "> usm_type</ span > < span class ="o "> =</ span > < span class ="n "> usm_type</ span > < span class ="p "> ,</ span >
964
984
< span class ="n "> sycl_queue</ span > < span class ="o "> =</ span > < span class ="n "> sycl_queue</ span > < span class ="p "> ,</ span >
0 commit comments