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.13.1dev1+23.gd469a12e52 documentation</ title >
15
+ < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.13.1dev2+30.geafb369c67 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=7183143b "> </ script >
26
+ < script src ="../../_static/documentation_options.js?v=c6f38219 "> </ 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+23.gd469a12e52
46
+ 0.13.1dev2+30.geafb369c67
47
47
</ div >
48
48
< div role ="search ">
49
49
< form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
90
90
< h1 > Source code for dpnp.dpnp_array</ h1 > < div class ="highlight "> < pre >
91
91
< span > </ span > < span class ="c1 "> # -*- coding: utf-8 -*-</ span >
92
92
< span class ="c1 "> # *****************************************************************************</ span >
93
- < span class ="c1 "> # Copyright (c) 2016-2023 , Intel Corporation</ span >
93
+ < span class ="c1 "> # Copyright (c) 2016-2024 , Intel Corporation</ span >
94
94
< span class ="c1 "> # All rights reserved.</ span >
95
95
< span class ="c1 "> #</ span >
96
96
< span class ="c1 "> # Redistribution and use in source and binary forms, with or without</ span >
@@ -777,7 +777,19 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
777
777
< span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> choose</ span > < span class ="p "> (</ span > < span class ="nb "> input</ span > < span class ="p "> ,</ span > < span class ="n "> choices</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="n "> mode</ span > < span class ="p "> )</ span > </ div >
778
778
779
779
780
- < span class ="c1 "> # 'clip',</ span >
780
+ < div class ="viewcode-block " id ="dpnp_array.clip ">
781
+ < a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.clip "> [docs]</ a >
782
+ < span class ="k "> def</ span > < span class ="nf "> clip</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="nb "> min</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="nb "> max</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> ):</ span >
783
+ < span class ="w "> </ span > < span class ="sd "> """</ span >
784
+ < span class ="sd "> Clip (limit) the values in an array.</ span >
785
+
786
+ < span class ="sd "> Refer to :obj:`dpnp.clip` for full documentation.</ span >
787
+
788
+ < span class ="sd "> """</ span >
789
+
790
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> clip</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="nb "> min</ span > < span class ="p "> ,</ span > < span class ="nb "> max</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="o "> =</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="o "> **</ span > < span class ="n "> kwargs</ span > < span class ="p "> )</ span > </ div >
791
+
792
+
781
793
< span class ="c1 "> # 'compress',</ span >
782
794
783
795
< div class ="viewcode-block " id ="dpnp_array.conj ">
@@ -1381,15 +1393,23 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1381
1393
1382
1394
< div class ="viewcode-block " id ="dpnp_array.std ">
1383
1395
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.std "> [docs]</ a >
1384
- < span class ="k "> def</ span > < span class ="nf "> std</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="o "> =</ span > < span class ="kc "> None</ 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 ="n "> out</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="o "> =</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
1385
- < span class ="w "> </ span > < span class ="sd "> """Returns the variance of the array elements, along given axis.</ span >
1386
-
1387
- < span class ="sd "> .. seealso::</ span >
1388
- < span class ="sd "> :obj:`dpnp.var` for full documentation,</ span >
1396
+ < span class ="k "> def</ span > < span class ="nf "> std</ span > < span class ="p "> (</ span >
1397
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span >
1398
+ < span class ="n "> axis</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1399
+ < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1400
+ < span class ="n "> out</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1401
+ < span class ="n "> ddof</ span > < span class ="o "> =</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span >
1402
+ < span class ="n "> keepdims</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
1403
+ < span class ="o "> *</ span > < span class ="p "> ,</ span >
1404
+ < span class ="n "> where</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
1405
+ < span class ="p "> ):</ span >
1406
+ < span class ="w "> </ span > < span class ="sd "> """</ span >
1407
+ < span class ="sd "> Returns the standard deviation of the array elements, along given axis.</ span >
1389
1408
1409
+ < span class ="sd "> Refer to :obj:`dpnp.std` for full documentation.</ span >
1390
1410
< span class ="sd "> """</ span >
1391
1411
1392
- < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> std</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="p "> )</ span > </ div >
1412
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> std</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="p "> , </ span > < span class =" n " > where </ span > < span class =" o " > = </ span > < span class =" n " > where </ span > < span class =" p " > )</ span > </ div >
1393
1413
1394
1414
1395
1415
< span class ="nd "> @property</ span >
@@ -1424,10 +1444,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1424
1444
< span class ="w "> </ span > < span class ="sd "> """</ span >
1425
1445
< span class ="sd "> Returns the sum along a given axis.</ span >
1426
1446
1427
- < span class ="sd "> .. seealso::</ span >
1428
- < span class ="sd "> :obj:`dpnp.sum` for full documentation,</ span >
1429
- < span class ="sd "> :meth:`dpnp.dparray.sum`</ span >
1430
-
1447
+ < span class ="sd "> For full documentation refer to :obj:`dpnp.sum`.</ span >
1431
1448
< span class ="sd "> """</ span >
1432
1449
1433
1450
< span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> sum</ span > < span class ="p "> (</ span >
@@ -1536,23 +1553,22 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1536
1553
1537
1554
< div class ="viewcode-block " id ="dpnp_array.var ">
1538
1555
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.var "> [docs]</ a >
1539
- < span class ="k "> def</ span > < span class ="nf "> var</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="o "> =</ span > < span class ="kc "> None</ 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 ="n "> out</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="o "> =</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
1556
+ < span class ="k "> def</ span > < span class ="nf "> var</ span > < span class ="p "> (</ span >
1557
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span >
1558
+ < span class ="n "> axis</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1559
+ < span class ="n "> dtype</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1560
+ < span class ="n "> out</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
1561
+ < span class ="n "> ddof</ span > < span class ="o "> =</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span >
1562
+ < span class ="n "> keepdims</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
1563
+ < span class ="o "> *</ span > < span class ="p "> ,</ span >
1564
+ < span class ="n "> where</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
1565
+ < span class ="p "> ):</ span >
1540
1566
< span class ="w "> </ span > < span class ="sd "> """</ span >
1541
- < span class ="sd "> Returns the variance of the array elements along given axis.</ span >
1542
-
1543
- < span class ="sd "> Masked entries are ignored, and result elements which are not</ span >
1544
- < span class ="sd "> finite will be masked.</ span >
1545
-
1546
- < span class ="sd "> Refer to `numpy.var` for full documentation.</ span >
1547
-
1548
- < span class ="sd "> See Also</ span >
1549
- < span class ="sd "> --------</ span >
1550
- < span class ="sd "> :obj:`numpy.ndarray.var` : corresponding function for ndarrays</ span >
1551
- < span class ="sd "> :obj:`numpy.var` : Equivalent function</ span >
1567
+ < span class ="sd "> Returns the variance of the array elements, along given axis.</ span >
1552
1568
1569
+ < span class ="sd "> Refer to :obj:`dpnp.var` for full documentation.</ span >
1553
1570
< span class ="sd "> """</ span >
1554
-
1555
- < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> var</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="p "> )</ span > </ div >
1571
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> var</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> out</ span > < span class ="p "> ,</ span > < span class ="n "> ddof</ span > < span class ="p "> ,</ span > < span class ="n "> keepdims</ span > < span class ="p "> ,</ span > < span class ="n "> where</ span > < span class ="o "> =</ span > < span class ="n "> where</ span > < span class ="p "> )</ span > </ div >
1556
1572
</ div >
1557
1573
1558
1574
@@ -1567,7 +1583,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1567
1583
< hr />
1568
1584
1569
1585
< div role ="contentinfo ">
1570
- < p > © Copyright 2020-2023 , Intel Corporation.</ p >
1586
+ < p > © Copyright 2020-2024 , Intel Corporation.</ p >
1571
1587
</ div >
1572
1588
1573
1589
Built with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > using a
0 commit comments