summaryrefslogtreecommitdiff
path: root/doc/release
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2019-02-08 17:45:28 -0700
committerCharles Harris <charlesr.harris@gmail.com>2019-02-08 17:45:28 -0700
commit107e45b82021ba04f651f0ef89aa2f419d404d64 (patch)
treebb3b703b40de42e9fde20369d6a67680cf2e5dbe /doc/release
parentd3eb626ef41e1302631b5154037567b9cc02630d (diff)
downloadnumpy-107e45b82021ba04f651f0ef89aa2f419d404d64.tar.gz
DOC: Update sorting documention.
Update the sorting documentation to reflect the reality that 'mergesort' and 'stable' are aliases and may refer to any of several stable sorting algorithms depending on data type. [ci skip]
Diffstat (limited to 'doc/release')
-rw-r--r--doc/release/1.17.0-notes.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/release/1.17.0-notes.rst b/doc/release/1.17.0-notes.rst
index ab09f85bd..d3a7779c8 100644
--- a/doc/release/1.17.0-notes.rst
+++ b/doc/release/1.17.0-notes.rst
@@ -54,14 +54,15 @@ identity, it is necessary to also pass in an initial value (e.g.,
``initial=np.inf`` for ``np.min``). For instance, the equivalent of
``nansum`` would be, ``np.sum(a, where=~np.isnan(a))``.
-Timsort is added to available sorting algorithms and is now the default stable sort
------------------------------------------------------------------------------------
-The ``kind`` keyword argument for ``sort`` and ``argsort`` now accepts ``'t'``
-or ``'timsort'`` for Timsort. The ``stable`` option of ``kind`` argument is now
-mapped to Timsort. Timsort features great performace
-on already or nearly sorted data and resembles Mergesort on random data.
-The algorithm is stable and requires O(n/2) additional space.
-For details of the algorithm, refer to
+Timsort has replaced mergesort as the stable sorting implementation
+-------------------------------------------------------------------
+Timsort has been implemented and is now used in place of mergesort. Due to the
+need to maintain backward compatibility, the sorting ``kind`` options ``"stable"``
+and ``"mergesort"`` have been made aliases of each other with the actual sort
+implementation used a function of the array type. Timsort features improved
+performace on already or nearly sorted data and performs like mergesort on
+random data. The algorithm is stable and requires O(n/2) working space. For
+details of the algorithm, refer to
`CPython listsort.txt <https://github.com/python/cpython/blob/3.7/Objects/listsort.txt>`_.
``np.linalg.svd`` and ``np.linalg.pinv`` can be faster on hermitian inputs