Merge pull request #197 from Morwenn/develop

Release 1.12.1

Author: Morwenn

CMakeLists.txt

@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.8.0)
 
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
 
-project(cpp-sort VERSION 1.12.0 LANGUAGES CXX)
+project(cpp-sort VERSION 1.12.1 LANGUAGES CXX)
 
 include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)

README.md

@@ -1,5 +1,5 @@
-[![Latest Release](https://img.shields.io/badge/release-1.12.0-blue.svg)](https://github.com/Morwenn/cpp-sort/releases/tag/1.12.0)
-[![Conan Package](https://img.shields.io/badge/conan-cpp--sort%2F1.12.0-blue.svg)](https://conan.io/center/cpp-sort?version=1.12.0)
+[![Latest Release](https://img.shields.io/badge/release-1.12.1-blue.svg)](https://github.com/Morwenn/cpp-sort/releases/tag/1.12.1)
+[![Conan Package](https://img.shields.io/badge/conan-cpp--sort%2F1.12.1-blue.svg)](https://conan.io/center/cpp-sort?version=1.12.1)
 [![Code Coverage](https://codecov.io/gh/Morwenn/cpp-sort/branch/develop/graph/badge.svg)](https://codecov.io/gh/Morwenn/cpp-sort)
 
 > *It would be nice if only one or two of the sorting methods would dominate all of the others,

conanfile.py

@@ -10,7 +10,7 @@
 
 class CppSortConan(ConanFile):
     name = "cpp-sort"
-    version = "1.12.0"
+    version = "1.12.1"
     description = "Additional sorting algorithms & related tools"
     topics = "conan", "cpp-sort", "sorting", "algorithms"
     url = "https://github.com/Morwenn/cpp-sort"

docs/Home.md

@@ -1,4 +1,4 @@
-Welcome to the **cpp-sort 1.12.0** documentation!
+Welcome to the **cpp-sort 1.12.1** documentation!
 
 You probably read the introduction in the README, so I won't repeat it here. This wiki contains documentation about the library: basic documentation about the many sorting tools and how to use them, documentation about the additional utilities provided by the library and even some detailed tutorials if you ever want to write your own sorters or sorter adapters. This main page explains a few general things that didn't quite fit in other parts of the documentation.
 

docs/Miscellaneous-utilities.md

@@ -247,6 +247,8 @@ using make_index_range = make_integer_range<std::size_t, Begin, End, Step>;
 
 `size` is a function that can be used to get the size of an iterable. It is equivalent to the C++17 function [`std::size`][std-size] but has an additional tweak so that, if the iterable is not a fixed-size C array and doesn't have a `size` method, it calls `std::distance(std::begin(iter), std::end(iter))` on the iterable. Therefore, this function can also be used for `std::forward_list` as well as some implementations of ranges.
 
+*Changed in version 1.12.1:* `utility::size()` now also works for collections that only provide non-`const` `begin()` and `end()`.
+
 ### Sorting network tools
 
 ```cpp

docs/Sorters.md

@@ -309,7 +309,7 @@ This sorter also has the following dedicated algorithms when used together with
 
 None of the container-aware algorithms invalidates iterators.
 
-### `slab_sort`
+### `slab_sorter`
 
 ```cpp
 #include <cpp-sort/sorters/slab_sorter.h>
@@ -319,12 +319,14 @@ Implements a variant of slabsort, a rather slow but highly adaptive algorithm de
 
 | Best        | Average     | Worst       | Memory      | Stable      | Iterators     |
 | ----------- | ----------- | ----------- | ----------- | ----------- | ------------- |
-| n           | n log n     | n log n     | n           | No          | Random-access |
+| n           | n log n     | n log n     | n           | No          | Bidirectional |
 
 This algorithm actually uses a rather big amount of memory but scales better than other O(n log n) algorithms of the library described as "slow" when the collections get bigger.
 
 *New in version 1.10.0*
 
+*Changed in version 1.12.1:* `slab_sorter` now works with bidirectional iterators.
+
 ### `smooth_sorter`
 
 ```cpp

docs/Tooling.md

@@ -51,10 +51,10 @@ The same options exist without the `CPPSORT_` prefix exist, but are deprecated.
 conan search cpp-sort --remote=conan-center
 ```
 
-And then install any version to your local cache as follows (here with version 1.12.0):
+And then install any version to your local cache as follows (here with version 1.12.1):
 
 ```sh
-conan install cpp-sort/1.12.0
+conan install cpp-sort/1.12.1
 ```
 
 The packages downloaded from conan-center are minimal and only contain the files required to use **cpp-sort** as a library: the headers, CMake files and licensing information. If you need anything else you have to build your own package with the `conanfile.py` available in this repository.

docs/Writing-a-bubble_sorter.md

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015-2017 Morwenn
+ * Copyright (c) 2015-2021 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <cstddef>
@@ -15,22 +15,18 @@
 
 namespace detail
 {
-    template<
-        typename ForwardIterator,
-        typename StrictWeakOrdering
-    >
-    auto bubble_sort(ForwardIterator first, std::size_t size,
-                     StrictWeakOrdering compare)
+    template<typename ForwardIterator, typename Compare>
+    auto bubble_sort(ForwardIterator first, std::size_t size, Compare compare)
         -> void
     {
         if (size < 2) return;
 
         auto&& comp = cppsort::utility::as_function(compare);
 
         while (--size) {
-            ForwardIterator current = first;
-            ForwardIterator next = std::next(current);
-            for (std::size_t i = 0 ; i < size ; ++i) {
+            auto current = first;
+            auto next = std::next(current);
+            for (std::size_t i = 0; i < size; ++i) {
                 if (comp(*next, *current)) {
                     using cppsort::utility::iter_swap;
                     iter_swap(current, next);
@@ -46,18 +42,17 @@ namespace detail
         // Pair of iterators overload
         template<
             typename ForwardIterator,
-            typename StrictWeakOrdering = std::less<>,
+            typename Compare = std::less<>,
             typename = std::enable_if_t<not cppsort::is_projection_iterator_v<
-                StrictWeakOrdering, ForwardIterator
+                Compare, ForwardIterator
             >>
         >
-        auto operator()(ForwardIterator first, ForwardIterator last,
-                        StrictWeakOrdering compare={}) const
+        auto operator()(ForwardIterator first, ForwardIterator last, Compare compare={}) const
             -> void
         {
             static_assert(
                 std::is_base_of<
-                    std::forward_iterator_tag,
+                    iterator_category,
                     typename std::iterator_traits<ForwardIterator>::iterator_category
                 >::value,
                 "bubble_sorter requires at least forward iterators"
@@ -70,17 +65,17 @@ namespace detail
         // Iterable overload
         template<
             typename ForwardIterable,
-            typename StrictWeakOrdering = std::less<>,
+            typename Compare = std::less<>,
             typename = std::enable_if_t<not cppsort::is_projection_v<
-                StrictWeakOrdering, ForwardIterable
+                Compare, ForwardIterable
             >>
         >
-        auto operator()(ForwardIterable&& iterable, StrictWeakOrdering compare={}) const
+        auto operator()(ForwardIterable&& iterable, Compare compare={}) const
             -> void
         {
             static_assert(
                 std::is_base_of<
-                    std::forward_iterator_tag,
+                    iterator_category,
                     typename std::iterator_traits<decltype(std::begin(iterable))>::iterator_category
                 >::value,
                 "bubble_sorter requires at least forward iterators"
@@ -118,7 +113,7 @@ int main()
 
     // Fill the collection in sorted order
     std::array<int, 8> collection;
-    std::iota(std::begin(collection), std::end(collection), 0);
+    std::iota(collection.begin(), collection.end(), 0);
 
     // Projection to sort in descending order
     auto projection = [](int n) { return -n; };
@@ -130,6 +125,6 @@ int main()
         // Bubble sort the collection
         bubble_sort(to_sort, projection);
         // Check that it is sorted in descending order
-        assert(std::is_sorted(std::begin(to_sort), std::end(to_sort), std::greater<>{}));
-    } while (std::next_permutation(std::begin(collection), std::end(collection)));
+        assert(std::is_sorted(to_sort.begin(), to_sort.end(), std::greater<>{}));
+    } while (std::next_permutation(collection.begin(), collection.end()));
 }

examples/bubble_sorter.cpp

@@ -51,7 +51,7 @@ namespace cppsort
             {
                 static_assert(
                     std::is_base_of<
-                        std::random_access_iterator_tag,
+                        iterator_category,
                         iterator_category_t<RandomAccessIterator>
                     >::value,
                     "verge_adapter requires at least random-access iterators"