14
14
</ script >
15
15
16
16
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
17
- < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.17.0dev4+15.gc27669de689 documentation</ title >
17
+ < title > dpnp.dpnp_array — Data Parallel Extension for NumPy 0.17.0dev4+19.ga5ec191972b documentation</ title >
18
18
< link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=03e43079 " />
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=9cc1dd46 "> </ script >
24
+ < script src ="../../_static/documentation_options.js?v=0c60159b "> </ script >
25
25
< script src ="../../_static/doctools.js?v=9bcbadda "> </ script >
26
26
< script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
27
27
< script src ="../../_static/js/theme.js "> </ script >
@@ -804,14 +804,63 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
804
804
805
805
< div class ="viewcode-block " id ="dpnp_array.argsort ">
806
806
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.argsort.html#dpnp.dpnp_array.dpnp_array.argsort "> [docs]</ a >
807
- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> argsort</ 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 ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
807
+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> argsort</ span > < span class ="p "> (</ span >
808
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="o "> =-</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> order</ 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 "> descending</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> stable</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
809
+ < span class ="p "> ):</ span >
808
810
< span class ="w "> </ span > < span class ="sd "> """</ span >
809
811
< span class ="sd "> Return an ndarray of indices that sort the array along the specified axis.</ span >
810
812
811
813
< span class ="sd "> Refer to :obj:`dpnp.argsort` for full documentation.</ span >
812
814
815
+ < span class ="sd "> Parameters</ span >
816
+ < span class ="sd "> ----------</ span >
817
+ < span class ="sd "> axis : {None, int}, optional</ span >
818
+ < span class ="sd "> Axis along which to sort. If ``None``, the array is flattened</ span >
819
+ < span class ="sd "> before sorting. The default is ``-1``, which sorts along the last</ span >
820
+ < span class ="sd "> axis.</ span >
821
+ < span class ="sd "> Default: ``-1``.</ span >
822
+ < span class ="sd "> kind : {None, "stable", "mergesort", "radixsort"}, optional</ span >
823
+ < span class ="sd "> Sorting algorithm. The default is ``None``, which uses parallel</ span >
824
+ < span class ="sd "> merge-sort or parallel radix-sort algorithms depending on the array</ span >
825
+ < span class ="sd "> data type.</ span >
826
+ < span class ="sd "> Default: ``None``.</ span >
827
+ < span class ="sd "> descending : bool, optional</ span >
828
+ < span class ="sd "> Sort order. If ``True``, the array must be sorted in descending</ span >
829
+ < span class ="sd "> order (by value). If ``False``, the array must be sorted in</ span >
830
+ < span class ="sd "> ascending order (by value).</ span >
831
+ < span class ="sd "> Default: ``False``.</ span >
832
+ < span class ="sd "> stable : {None, bool}, optional</ span >
833
+ < span class ="sd "> Sort stability. If ``True``, the returned array will maintain the</ span >
834
+ < span class ="sd "> relative order of `a` values which compare as equal. The same</ span >
835
+ < span class ="sd "> behavior applies when set to ``False`` or ``None``.</ span >
836
+ < span class ="sd "> Internally, this option selects ``kind="stable"``.</ span >
837
+ < span class ="sd "> Default: ``None``.</ span >
838
+
839
+ < span class ="sd "> See Also</ span >
840
+ < span class ="sd "> --------</ span >
841
+ < span class ="sd "> :obj:`dpnp.sort` : Return a sorted copy of an array.</ span >
842
+ < span class ="sd "> :obj:`dpnp.argsort` : Return the indices that would sort an array.</ span >
843
+ < span class ="sd "> :obj:`dpnp.lexsort` : Indirect stable sort on multiple keys.</ span >
844
+ < span class ="sd "> :obj:`dpnp.searchsorted` : Find elements in a sorted array.</ span >
845
+ < span class ="sd "> :obj:`dpnp.partition` : Partial sort.</ span >
846
+
847
+ < span class ="sd "> Examples</ span >
848
+ < span class ="sd "> --------</ span >
849
+ < span class ="sd "> >>> import dpnp as np</ span >
850
+ < span class ="sd "> >>> a = np.array([3, 1, 2])</ span >
851
+ < span class ="sd "> >>> a.argsort()</ span >
852
+ < span class ="sd "> array([1, 2, 0])</ span >
853
+
854
+ < span class ="sd "> >>> a = np.array([[0, 3], [2, 2]])</ span >
855
+ < span class ="sd "> >>> a.argsort(axis=0)</ span >
856
+ < span class ="sd "> array([[0, 1],</ span >
857
+ < span class ="sd "> [1, 0]])</ span >
858
+
813
859
< span class ="sd "> """</ span >
814
- < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> argsort</ 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 "> kind</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="p "> )</ span > </ div >
860
+
861
+ < span class ="k "> return</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> argsort</ span > < span class ="p "> (</ span >
862
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span > < span class ="n "> descending</ span > < span class ="o "> =</ span > < span class ="n "> descending</ span > < span class ="p "> ,</ span > < span class ="n "> stable</ span > < span class ="o "> =</ span > < span class ="n "> stable</ span >
863
+ < span class ="p "> )</ span > </ div >
815
864
816
865
817
866
< div class ="viewcode-block " id ="dpnp_array.asnumpy ">
@@ -1777,12 +1826,45 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1777
1826
1778
1827
< div class ="viewcode-block " id ="dpnp_array.sort ">
1779
1828
< a class ="viewcode-back " href ="../../reference/generated/dpnp.dpnp_array.dpnp_array.sort.html#dpnp.dpnp_array.dpnp_array.sort "> [docs]</ a >
1780
- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> sort</ 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 ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
1829
+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> sort</ span > < span class ="p "> (</ span >
1830
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> axis</ span > < span class ="o "> =-</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> order</ 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 "> descending</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> stable</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
1831
+ < span class ="p "> ):</ span >
1781
1832
< span class ="w "> </ span > < span class ="sd "> """</ span >
1782
1833
< span class ="sd "> Sort an array in-place.</ span >
1783
1834
1784
1835
< span class ="sd "> Refer to :obj:`dpnp.sort` for full documentation.</ span >
1785
1836
1837
+ < span class ="sd "> Parameters</ span >
1838
+ < span class ="sd "> ----------</ span >
1839
+ < span class ="sd "> axis : int, optional</ span >
1840
+ < span class ="sd "> Axis along which to sort. The default is ``-1``, which sorts along</ span >
1841
+ < span class ="sd "> the last axis.</ span >
1842
+ < span class ="sd "> Default: ``-1``.</ span >
1843
+ < span class ="sd "> kind : {None, "stable", "mergesort", "radixsort"}, optional</ span >
1844
+ < span class ="sd "> Sorting algorithm. The default is ``None``, which uses parallel</ span >
1845
+ < span class ="sd "> merge-sort or parallel radix-sort algorithms depending on the array</ span >
1846
+ < span class ="sd "> data type.</ span >
1847
+ < span class ="sd "> Default: ``None``.</ span >
1848
+ < span class ="sd "> descending : bool, optional</ span >
1849
+ < span class ="sd "> Sort order. If ``True``, the array must be sorted in descending</ span >
1850
+ < span class ="sd "> order (by value). If ``False``, the array must be sorted in</ span >
1851
+ < span class ="sd "> ascending order (by value).</ span >
1852
+ < span class ="sd "> Default: ``False``.</ span >
1853
+ < span class ="sd "> stable : {None, bool}, optional</ span >
1854
+ < span class ="sd "> Sort stability. If ``True``, the returned array will maintain the</ span >
1855
+ < span class ="sd "> relative order of `a` values which compare as equal. The same</ span >
1856
+ < span class ="sd "> behavior applies when set to ``False`` or ``None``.</ span >
1857
+ < span class ="sd "> Internally, this option selects ``kind="stable"``.</ span >
1858
+ < span class ="sd "> Default: ``None``.</ span >
1859
+
1860
+ < span class ="sd "> See Also</ span >
1861
+ < span class ="sd "> --------</ span >
1862
+ < span class ="sd "> :obj:`dpnp.sort` : Return a sorted copy of an array.</ span >
1863
+ < span class ="sd "> :obj:`dpnp.argsort` : Return the indices that would sort an array.</ span >
1864
+ < span class ="sd "> :obj:`dpnp.lexsort` : Indirect stable sort on multiple keys.</ span >
1865
+ < span class ="sd "> :obj:`dpnp.searchsorted` : Find elements in a sorted array.</ span >
1866
+ < span class ="sd "> :obj:`dpnp.partition` : Partial sort.</ span >
1867
+
1786
1868
< span class ="sd "> Note</ span >
1787
1869
< span class ="sd "> ----</ span >
1788
1870
< span class ="sd "> `axis` in :obj:`dpnp.sort` could be integer or ``None``. If ``None``,</ span >
@@ -1793,7 +1875,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1793
1875
< span class ="sd "> Examples</ span >
1794
1876
< span class ="sd "> --------</ span >
1795
1877
< span class ="sd "> >>> import dpnp as np</ span >
1796
- < span class ="sd "> >>> a = np.array([[1,4],[3,1]])</ span >
1878
+ < span class ="sd "> >>> a = np.array([[1, 4], [3, 1]])</ span >
1797
1879
< span class ="sd "> >>> a.sort(axis=1)</ span >
1798
1880
< span class ="sd "> >>> a</ span >
1799
1881
< span class ="sd "> array([[1, 4],</ span >
@@ -1809,7 +1891,14 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
1809
1891
< span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span >
1810
1892
< span class ="s2 "> "'NoneType' object cannot be interpreted as an integer"</ span >
1811
1893
< span class ="p "> )</ span >
1812
- < span class ="bp "> self</ span > < span class ="p "> [</ span > < span class ="o "> ...</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> sort</ 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 ="n "> axis</ span > < span class ="p "> ,</ span > < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="n "> kind</ span > < span class ="p "> ,</ span > < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> )</ span > </ div >
1894
+ < span class ="bp "> self</ span > < span class ="p "> [</ span > < span class ="o "> ...</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> sort</ span > < span class ="p "> (</ span >
1895
+ < span class ="bp "> self</ span > < span class ="p "> ,</ span >
1896
+ < span class ="n "> axis</ span > < span class ="o "> =</ span > < span class ="n "> axis</ span > < span class ="p "> ,</ span >
1897
+ < span class ="n "> kind</ span > < span class ="o "> =</ span > < span class ="n "> kind</ span > < span class ="p "> ,</ span >
1898
+ < span class ="n "> order</ span > < span class ="o "> =</ span > < span class ="n "> order</ span > < span class ="p "> ,</ span >
1899
+ < span class ="n "> descending</ span > < span class ="o "> =</ span > < span class ="n "> descending</ span > < span class ="p "> ,</ span >
1900
+ < span class ="n "> stable</ span > < span class ="o "> =</ span > < span class ="n "> stable</ span > < span class ="p "> ,</ span >
1901
+ < span class ="p "> )</ span > </ div >
1813
1902
1814
1903
1815
1904
< div class ="viewcode-block " id ="dpnp_array.squeeze ">
0 commit comments