From d26742747b4ba4e1dff0b078382b00a36676dcba Mon Sep 17 00:00:00 2001 From: Sayan Date: Tue, 16 Apr 2024 20:56:20 -0400 Subject: [PATCH 01/36] compare const and non-const chained iterators; all tests pass --- chain.hpp | 55 +++++++++++++++++++++++++++++---------------- test/test_chain.cpp | 9 +++----- 2 files changed, 39 insertions(+), 25 deletions(-) diff --git a/chain.hpp b/chain.hpp index 23d1e054..55338c9d 100644 --- a/chain.hpp +++ b/chain.hpp @@ -1,10 +1,6 @@ #ifndef ITER_CHAIN_HPP_ #define ITER_CHAIN_HPP_ -#include "internal/iter_tuples.hpp" -#include "internal/iterator_wrapper.hpp" -#include "internal/iterbase.hpp" - #include #include #include @@ -12,6 +8,10 @@ #include #include +#include "internal/iter_tuples.hpp" +#include "internal/iterator_wrapper.hpp" +#include "internal/iterbase.hpp" + namespace iter { namespace impl { template @@ -43,6 +43,26 @@ class iter::impl::Chained { private: friend ChainMaker; + template + class IteratorDataPair { + IteratorDataPair() = delete; + + public: + using IterTupTypeA = iterator_tuple_type; + using IterTupTypeB = iterator_tuple_type; + + template + static bool get_and_check_not_equal( + const IterTupTypeA& lhs, const IterTupTypeB& rhs) { + return std::get(lhs) != std::get(rhs); + } + + using NeqFunc = bool (*)(const IterTupTypeA&, const IterTupTypeB&); + + constexpr static std::array neq_comparers{ + {get_and_check_not_equal...}}; + }; + template class IteratorData { IteratorData() = delete; @@ -76,16 +96,9 @@ class iter::impl::Chained { ++std::get(iters); } - template - static bool get_and_check_not_equal( - const IterTupType& lhs, const IterTupType& rhs) { - return std::get(lhs) != std::get(rhs); - } - using DerefFunc = DerefType (*)(IterTupType&); using ArrowFunc = ArrowType (*)(IterTupType&); using IncFunc = void (*)(IterTupType&); - using NeqFunc = bool (*)(const IterTupType&, const IterTupType&); constexpr static std::array derefers{ {get_and_deref...}}; @@ -96,9 +109,6 @@ class iter::impl::Chained { constexpr static std::array incrementers{ {get_and_increment...}}; - constexpr static std::array neq_comparers{ - {get_and_check_not_equal...}}; - using TraitsValue = iterator_traits_deref>; }; @@ -119,12 +129,16 @@ class iter::impl::Chained { void check_for_end_and_adjust() { while (index_ < sizeof...(Is) - && !(IterData::neq_comparers[index_](iters_, ends_))) { + && !(IteratorDataPair::neq_comparers[index_]( + iters_, ends_))) { ++index_; } } public: + template + friend class Iterator; + using iterator_category = std::input_iterator_tag; using value_type = typename IteratorData::TraitsValue; using difference_type = std::ptrdiff_t; @@ -141,7 +155,7 @@ class iter::impl::Chained { return IterData::derefers[index_](iters_); } - decltype(auto) operator-> () { + decltype(auto) operator->() { return IterData::arrowers[index_](iters_); } @@ -158,13 +172,16 @@ class iter::impl::Chained { } // TODO make const and non-const iterators comparable - bool operator!=(const Iterator& other) const { + template + bool operator!=(const Iterator& other) const { return index_ != other.index_ || (index_ != sizeof...(Is) - && IterData::neq_comparers[index_](iters_, other.iters_)); + && IteratorDataPair::neq_comparers[index_]( + iters_, other.iters_)); } - bool operator==(const Iterator& other) const { + template + bool operator==(const Iterator& other) const { return !(*this != other); } }; diff --git a/test/test_chain.cpp b/test/test_chain.cpp index b4b77cf2..5ad9c361 100644 --- a/test/test_chain.cpp +++ b/test/test_chain.cpp @@ -1,6 +1,4 @@ #include -#include "helpers.hpp" - #include #include #include @@ -8,6 +6,7 @@ #include #include "catch.hpp" +#include "helpers.hpp" using iter::chain; using itertest::BasicIterable; @@ -37,14 +36,12 @@ TEST_CASE("chain: const iteration", "[chain][const]") { REQUIRE(v == vc); } -// TODO make this work -#if 0 -TEST_CASE("chain: const iterators can be compared to non-const itertors", "[chain][const]") { +TEST_CASE("chain: const iterators can be compared to non-const itertors", + "[chain][const]") { auto ch = chain(std::string{}, std::string{}); const auto& cch = ch; (void)(std::begin(ch) == std::end(cch)); } -#endif TEST_CASE("chain: with different container types", "[chain]") { std::string s1{"abc"}; From f857d4ad101b5635842e6216e4d962c71da41cec Mon Sep 17 00:00:00 2001 From: Sayan Date: Sun, 5 May 2024 09:28:10 -0400 Subject: [PATCH 02/36] remove stale comments; improve tests for const non-const comparisons [chain] --- chain.hpp | 1 - test/test_chain.cpp | 54 ++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 49 insertions(+), 6 deletions(-) diff --git a/chain.hpp b/chain.hpp index 55338c9d..85dd6555 100644 --- a/chain.hpp +++ b/chain.hpp @@ -171,7 +171,6 @@ class iter::impl::Chained { return ret; } - // TODO make const and non-const iterators comparable template bool operator!=(const Iterator& other) const { return index_ != other.index_ diff --git a/test/test_chain.cpp b/test/test_chain.cpp index 5ad9c361..47360d97 100644 --- a/test/test_chain.cpp +++ b/test/test_chain.cpp @@ -38,9 +38,31 @@ TEST_CASE("chain: const iteration", "[chain][const]") { TEST_CASE("chain: const iterators can be compared to non-const itertors", "[chain][const]") { - auto ch = chain(std::string{}, std::string{}); - const auto& cch = ch; - (void)(std::begin(ch) == std::end(cch)); + std::string s1{"abc"}; + std::list li{'m', 'n', 'o'}; + auto ch = chain(s1, li); + + const auto cch = chain(s1, li); + SECTION("begin and const begin compare equal") { + REQUIRE(std::begin(ch) == std::begin(cch)); + } + SECTION("begin and const end compare not-equal") { + REQUIRE_FALSE(std::begin(ch) == std::end(cch)); + } + SECTION("end and const end compare equal") { + REQUIRE(std::end(ch) == std::end(cch)); + } + SECTION( + "const and non-const iterator compare equal/not-equal at appropriate " + "pos.") { + auto iter = ch.begin(); + iter++; + auto citer = cch.begin(); + citer++; + REQUIRE(iter == citer); + citer++; + REQUIRE_FALSE(iter == citer); + } } TEST_CASE("chain: with different container types", "[chain]") { @@ -215,10 +237,32 @@ TEST_CASE( "chain.from_iterable: const iterators can be compared to non-const " "iterators", "[chain.from_iterable][const]") { - std::vector> v{}; + std::vector> v{{1, 2}, {4, 6}}; auto ch = chain.from_iterable(v); const auto& cch = ch; - (void)(std::begin(ch) == std::end(cch)); + + SECTION("begin and const end compare not-equal") { + REQUIRE_FALSE(std::begin(ch) == std::end(cch)); + } + SECTION("begin and const begin compare equal") { + REQUIRE(std::begin(ch) == std::begin(cch)); + } + SECTION("end and const end compare not-equal") { + REQUIRE(std::end(ch) == std::end(cch)); + } + SECTION( + "const and non-const iterator compare equal/not-equal at appropriate " + "pos.") { + auto iter = ch.begin(); + iter++; + auto citer = cch.begin(); + citer++; + REQUIRE(iter == citer); + citer++; + REQUIRE_FALSE(iter == citer); + iter++; + REQUIRE(iter == citer); + } } TEST_CASE("chain.fromm_iterable: Works with different begin and end types", From 87ad8a0b3de4a10cf475c01e0ccdf517529b4142 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 21 Jun 2024 11:46:33 -0700 Subject: [PATCH 03/36] Adds bazel lockfiles to gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index ac51a054..553aa4a3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ bazel-* +MODULE.bazel +MODULE.bazel.lock From 69d3b3f510847bdb953894f81cf6f52b9b533b8f Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 21 Jun 2024 11:53:32 -0700 Subject: [PATCH 04/36] Removes anonymous namespace around chain definition Fixes #104 --- cppitertools/chain.hpp | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/cppitertools/chain.hpp b/cppitertools/chain.hpp index 85dd6555..76759eeb 100644 --- a/cppitertools/chain.hpp +++ b/cppitertools/chain.hpp @@ -343,9 +343,7 @@ class iter::impl::ChainMaker { }; namespace iter { - namespace { - constexpr auto chain = iter::impl::ChainMaker{}; - } + inline constexpr auto chain = iter::impl::ChainMaker{}; } #endif From ab4999407f73ca09cc2e5efff2b8724ac40b071a Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 21 Jun 2024 11:54:29 -0700 Subject: [PATCH 05/36] Adds inline specifier to itertools callable objects in headers Related to issue #104 --- cppitertools/accumulate.hpp | 2 +- cppitertools/batched.hpp | 2 +- cppitertools/chunked.hpp | 2 +- cppitertools/combinations.hpp | 2 +- cppitertools/combinations_with_replacement.hpp | 2 +- cppitertools/cycle.hpp | 2 +- cppitertools/dropwhile.hpp | 2 +- cppitertools/enumerate.hpp | 2 +- cppitertools/filter.hpp | 2 +- cppitertools/filterfalse.hpp | 2 +- cppitertools/groupby.hpp | 2 +- cppitertools/imap.hpp | 2 +- cppitertools/permutations.hpp | 2 +- cppitertools/powerset.hpp | 2 +- cppitertools/reversed.hpp | 2 +- cppitertools/slice.hpp | 2 +- cppitertools/sliding_window.hpp | 2 +- cppitertools/sorted.hpp | 2 +- cppitertools/starmap.hpp | 2 +- cppitertools/takewhile.hpp | 2 +- cppitertools/unique_everseen.hpp | 2 +- cppitertools/unique_justseen.hpp | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) diff --git a/cppitertools/accumulate.hpp b/cppitertools/accumulate.hpp index 94c0c369..2c5bc54e 100644 --- a/cppitertools/accumulate.hpp +++ b/cppitertools/accumulate.hpp @@ -17,7 +17,7 @@ namespace iter { using AccumulateFn = IterToolFnOptionalBindSecond>; } - constexpr impl::AccumulateFn accumulate{}; + inline constexpr impl::AccumulateFn accumulate{}; } template diff --git a/cppitertools/batched.hpp b/cppitertools/batched.hpp index e5eadf13..f3d00ece 100644 --- a/cppitertools/batched.hpp +++ b/cppitertools/batched.hpp @@ -20,7 +20,7 @@ namespace iter { using BatchedFn = IterToolFnBindSizeTSecond; } - constexpr impl::BatchedFn batched{}; + inline constexpr impl::BatchedFn batched{}; } template diff --git a/cppitertools/chunked.hpp b/cppitertools/chunked.hpp index 1d03b6e1..13fa652f 100644 --- a/cppitertools/chunked.hpp +++ b/cppitertools/chunked.hpp @@ -20,7 +20,7 @@ namespace iter { using ChunkedFn = IterToolFnBindSizeTSecond; } - constexpr impl::ChunkedFn chunked{}; + inline constexpr impl::ChunkedFn chunked{}; } template diff --git a/cppitertools/combinations.hpp b/cppitertools/combinations.hpp index 7aca3115..cdee9cdd 100644 --- a/cppitertools/combinations.hpp +++ b/cppitertools/combinations.hpp @@ -15,7 +15,7 @@ namespace iter { using CombinationsFn = IterToolFnBindSizeTSecond; } - constexpr impl::CombinationsFn combinations{}; + inline constexpr impl::CombinationsFn combinations{}; } template diff --git a/cppitertools/combinations_with_replacement.hpp b/cppitertools/combinations_with_replacement.hpp index d501c6e1..39db37bd 100644 --- a/cppitertools/combinations_with_replacement.hpp +++ b/cppitertools/combinations_with_replacement.hpp @@ -15,7 +15,7 @@ namespace iter { using CombinationsWithReplacementFn = IterToolFnBindSizeTSecond; } - constexpr impl::CombinationsWithReplacementFn combinations_with_replacement{}; + inline constexpr impl::CombinationsWithReplacementFn combinations_with_replacement{}; } template diff --git a/cppitertools/cycle.hpp b/cppitertools/cycle.hpp index 1d3ecaef..fb3ca9c7 100644 --- a/cppitertools/cycle.hpp +++ b/cppitertools/cycle.hpp @@ -15,7 +15,7 @@ namespace iter { using CycleFn = IterToolFn; } - constexpr impl::CycleFn cycle{}; + inline constexpr impl::CycleFn cycle{}; } template diff --git a/cppitertools/dropwhile.hpp b/cppitertools/dropwhile.hpp index dc1874b0..e751bfe3 100644 --- a/cppitertools/dropwhile.hpp +++ b/cppitertools/dropwhile.hpp @@ -16,7 +16,7 @@ namespace iter { using DropWhileFn = IterToolFnOptionalBindFirst; } - constexpr impl::DropWhileFn dropwhile{}; + inline constexpr impl::DropWhileFn dropwhile{}; } template diff --git a/cppitertools/enumerate.hpp b/cppitertools/enumerate.hpp index e2dda12b..5d59feab 100644 --- a/cppitertools/enumerate.hpp +++ b/cppitertools/enumerate.hpp @@ -33,7 +33,7 @@ namespace iter { using EnumerateFn = IterToolFnOptionalBindSecond; } - constexpr impl::EnumerateFn enumerate{}; + inline constexpr impl::EnumerateFn enumerate{}; } namespace std { diff --git a/cppitertools/filter.hpp b/cppitertools/filter.hpp index 2a632be2..1e069070 100644 --- a/cppitertools/filter.hpp +++ b/cppitertools/filter.hpp @@ -24,7 +24,7 @@ namespace iter { using FilterFn = IterToolFnOptionalBindFirst; } - constexpr impl::FilterFn filter{}; + inline constexpr impl::FilterFn filter{}; } template diff --git a/cppitertools/filterfalse.hpp b/cppitertools/filterfalse.hpp index f0f22628..4056c402 100644 --- a/cppitertools/filterfalse.hpp +++ b/cppitertools/filterfalse.hpp @@ -38,7 +38,7 @@ namespace iter { using FilterFalseFn = IterToolFnOptionalBindFirst; } - constexpr impl::FilterFalseFn filterfalse{}; + inline constexpr impl::FilterFalseFn filterfalse{}; } // Delegates to Filtered with PredicateFlipper diff --git a/cppitertools/groupby.hpp b/cppitertools/groupby.hpp index cac82426..6d7453f9 100644 --- a/cppitertools/groupby.hpp +++ b/cppitertools/groupby.hpp @@ -20,7 +20,7 @@ namespace iter { using GroupByFn = IterToolFnOptionalBindSecond; } - constexpr impl::GroupByFn groupby{}; + inline constexpr impl::GroupByFn groupby{}; } template diff --git a/cppitertools/imap.hpp b/cppitertools/imap.hpp index 1e84faf0..80b8cc3d 100644 --- a/cppitertools/imap.hpp +++ b/cppitertools/imap.hpp @@ -21,7 +21,7 @@ namespace iter { using PipeableAndBindFirst::operator(); }; } - constexpr impl::IMapFn imap{}; + inline constexpr impl::IMapFn imap{}; } #endif diff --git a/cppitertools/permutations.hpp b/cppitertools/permutations.hpp index e10872d4..f567bc68 100644 --- a/cppitertools/permutations.hpp +++ b/cppitertools/permutations.hpp @@ -17,7 +17,7 @@ namespace iter { class Permuter; using PermutationsFn = IterToolFn; } - constexpr impl::PermutationsFn permutations{}; + inline constexpr impl::PermutationsFn permutations{}; } template diff --git a/cppitertools/powerset.hpp b/cppitertools/powerset.hpp index 3439069d..d6131ca8 100644 --- a/cppitertools/powerset.hpp +++ b/cppitertools/powerset.hpp @@ -18,7 +18,7 @@ namespace iter { using PowersetFn = IterToolFn; } - constexpr impl::PowersetFn powerset{}; + inline constexpr impl::PowersetFn powerset{}; } template diff --git a/cppitertools/reversed.hpp b/cppitertools/reversed.hpp index 3b914bb1..022088f6 100644 --- a/cppitertools/reversed.hpp +++ b/cppitertools/reversed.hpp @@ -45,7 +45,7 @@ namespace iter { using ReversedFn = IterToolFn; } - constexpr impl::ReversedFn reversed{}; + inline constexpr impl::ReversedFn reversed{}; } template diff --git a/cppitertools/slice.hpp b/cppitertools/slice.hpp index a926ecbb..38557016 100644 --- a/cppitertools/slice.hpp +++ b/cppitertools/slice.hpp @@ -172,7 +172,7 @@ struct iter::impl::SliceFn { }; namespace iter { - constexpr impl::SliceFn slice{}; + inline constexpr impl::SliceFn slice{}; } #endif diff --git a/cppitertools/sliding_window.hpp b/cppitertools/sliding_window.hpp index d4ab6cbc..01c348ba 100644 --- a/cppitertools/sliding_window.hpp +++ b/cppitertools/sliding_window.hpp @@ -16,7 +16,7 @@ namespace iter { class WindowSlider; using SlidingWindowFn = IterToolFnBindSizeTSecond; } - constexpr impl::SlidingWindowFn sliding_window{}; + inline constexpr impl::SlidingWindowFn sliding_window{}; } template diff --git a/cppitertools/sorted.hpp b/cppitertools/sorted.hpp index 4e963228..a704af3f 100644 --- a/cppitertools/sorted.hpp +++ b/cppitertools/sorted.hpp @@ -15,7 +15,7 @@ namespace iter { class SortedView; using SortedFn = IterToolFnOptionalBindSecond>; } - constexpr impl::SortedFn sorted{}; + inline constexpr impl::SortedFn sorted{}; } template diff --git a/cppitertools/starmap.hpp b/cppitertools/starmap.hpp index fbeaad68..f9c2d260 100644 --- a/cppitertools/starmap.hpp +++ b/cppitertools/starmap.hpp @@ -252,7 +252,7 @@ struct iter::impl::StarMapFn : PipeableAndBindFirst { }; namespace iter { - constexpr impl::StarMapFn starmap{}; + inline constexpr impl::StarMapFn starmap{}; } #endif diff --git a/cppitertools/takewhile.hpp b/cppitertools/takewhile.hpp index a04d86b2..338e43aa 100644 --- a/cppitertools/takewhile.hpp +++ b/cppitertools/takewhile.hpp @@ -16,7 +16,7 @@ namespace iter { using TakeWhileFn = IterToolFnOptionalBindFirst; } - constexpr impl::TakeWhileFn takewhile{}; + inline constexpr impl::TakeWhileFn takewhile{}; } template diff --git a/cppitertools/unique_everseen.hpp b/cppitertools/unique_everseen.hpp index 1e138d63..2195a4bd 100644 --- a/cppitertools/unique_everseen.hpp +++ b/cppitertools/unique_everseen.hpp @@ -45,7 +45,7 @@ namespace iter { }; } - constexpr impl::UniqueEverseenFn unique_everseen{}; + inline constexpr impl::UniqueEverseenFn unique_everseen{}; } #endif diff --git a/cppitertools/unique_justseen.hpp b/cppitertools/unique_justseen.hpp index 5a566e78..c4ca47f5 100644 --- a/cppitertools/unique_justseen.hpp +++ b/cppitertools/unique_justseen.hpp @@ -23,7 +23,7 @@ namespace iter { } }; } - constexpr impl::UniqueJustseenFn unique_justseen{}; + inline constexpr impl::UniqueJustseenFn unique_justseen{}; } #endif From 78a4eaa8a3b3b45aeea1022fd8a9402321729358 Mon Sep 17 00:00:00 2001 From: Udaya Prakash Date: Wed, 21 Aug 2024 16:33:29 +0000 Subject: [PATCH 06/36] Add bzlmod support to cppitertools --- .bazelrc | 2 ++ .bazelversion | 1 + .gitignore | 1 - MODULE.bazel | 3 +++ 4 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .bazelrc create mode 100644 .bazelversion create mode 100644 MODULE.bazel diff --git a/.bazelrc b/.bazelrc new file mode 100644 index 00000000..cbb8025a --- /dev/null +++ b/.bazelrc @@ -0,0 +1,2 @@ +# workspace support is deprecated in Bazel 7 +common --enable_bzlmod \ No newline at end of file diff --git a/.bazelversion b/.bazelversion new file mode 100644 index 00000000..34a8f745 --- /dev/null +++ b/.bazelversion @@ -0,0 +1 @@ +7.3.1 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 553aa4a3..0d4fed27 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ bazel-* -MODULE.bazel MODULE.bazel.lock diff --git a/MODULE.bazel b/MODULE.bazel new file mode 100644 index 00000000..d8dc8f72 --- /dev/null +++ b/MODULE.bazel @@ -0,0 +1,3 @@ +module( + name = "cppitertools" +) \ No newline at end of file From 88de5d7cb3316231fce6e2a87e904cf3077a3def Mon Sep 17 00:00:00 2001 From: Udaya Prakash Date: Wed, 21 Aug 2024 16:36:26 +0000 Subject: [PATCH 07/36] add new line --- .bazelversion | 2 +- MODULE.bazel | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.bazelversion b/.bazelversion index 34a8f745..643916c0 100644 --- a/.bazelversion +++ b/.bazelversion @@ -1 +1 @@ -7.3.1 \ No newline at end of file +7.3.1 diff --git a/MODULE.bazel b/MODULE.bazel index d8dc8f72..b4a4568e 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -1,3 +1,3 @@ module( name = "cppitertools" -) \ No newline at end of file +) From e06f15357cc9ca78029e4158bee67da9f110e34f Mon Sep 17 00:00:00 2001 From: Udaya Prakash Date: Wed, 21 Aug 2024 16:37:36 +0000 Subject: [PATCH 08/36] remove bazelrc file --- .bazelrc | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 .bazelrc diff --git a/.bazelrc b/.bazelrc deleted file mode 100644 index cbb8025a..00000000 --- a/.bazelrc +++ /dev/null @@ -1,2 +0,0 @@ -# workspace support is deprecated in Bazel 7 -common --enable_bzlmod \ No newline at end of file From 5a7f4aa357ed9b0ad59823e3d2acd57217d5beaf Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 18 Oct 2024 09:55:13 -0700 Subject: [PATCH 09/36] Escapes '<' and '>' in zip_longest description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64c1430f..7b43c218 100644 --- a/README.md +++ b/README.md @@ -579,7 +579,7 @@ Repeatedly yields a tuple of `boost::optional`s where `T` is the type yielded by the sequences' respective iterators. Because of its boost dependency, `zip_longest` is not in `itertools.hpp` and must be included separately. -The following loop prints either "Just " or "Nothing" for each +The following loop prints either "Just \" or "Nothing" for each element in each tuple yielded. ```c++ From 516115a959c92f5b7f133e4f52bcd7e701c46069 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 5 Feb 2025 16:48:51 -0800 Subject: [PATCH 10/36] Updates .bazelversion to 8.0.1 --- .bazelversion | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.bazelversion b/.bazelversion index 643916c0..cd1d2e94 100644 --- a/.bazelversion +++ b/.bazelversion @@ -1 +1 @@ -7.3.1 +8.0.1 From 371888d0f9c1ee687c8c1241c8c86ebed26929d6 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Thu, 6 Feb 2025 16:41:33 -0800 Subject: [PATCH 11/36] Adds undefinide and address sanitizer to tests --- test/BUILD | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/test/BUILD b/test/BUILD index 9ceefecd..cc9aefe6 100644 --- a/test/BUILD +++ b/test/BUILD @@ -37,10 +37,13 @@ progs = [ "helpers", ] +SANITIZE = "-fsanitize=address,undefined" + cc_library( name = "test_main", srcs = ["test_main.cpp", "catch.hpp"], - copts = ["-std=c++17", "-g"] + copts = [SANITIZE, "-Wall", "-Wextra", "-std=c++17", "-g"], + linkopts = [SANITIZE], ) itertools_tests(progs) From d4c7340b44e141874b749a2c08489cb3ae180a71 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Thu, 6 Feb 2025 16:42:19 -0800 Subject: [PATCH 12/36] Suppresses bad dangling reference warning Fixes #108 --- cppitertools/internal/iterbase.hpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index 6f654828..9a8b33ba 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -353,6 +353,9 @@ namespace iter { template struct Pipeable { template +#if defined(__GNUC__) && !defined(__clang__) + [[gnu::no_dangling]] +#endif friend decltype(auto) operator|(T&& x, const Pipeable& p) { return static_cast(p)(std::forward(x)); } From fa6ee1a8b93c374185abd69e374ce9f4fd054cb4 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Mon, 10 Feb 2025 12:44:31 -0800 Subject: [PATCH 13/36] Moves utility callables into helpers.hpp Cleanup while doing #89 --- test/helpers.hpp | 16 +++++++++++++++ test/test_dropwhile.cpp | 24 +--------------------- test/test_filter.cpp | 22 +------------------- test/test_filterfalse.cpp | 22 +------------------- test/test_takewhile.cpp | 43 +++++++++++++-------------------------- 5 files changed, 33 insertions(+), 94 deletions(-) diff --git a/test/helpers.hpp b/test/helpers.hpp index 80167980..57f8a372 100644 --- a/test/helpers.hpp +++ b/test/helpers.hpp @@ -414,4 +414,20 @@ class IntCharPairRange : DiffEndRange, IncIntCharPair>({0, 'a'}, stop) {} }; +inline bool less_than_five(int i) { + return i < 5; +} + +class LessThanValue { + private: + int compare_val; + + public: + LessThanValue(int v) : compare_val(v) {} + + bool operator()(int i) { + return i < this->compare_val; + } +}; + #endif diff --git a/test/test_dropwhile.cpp b/test/test_dropwhile.cpp index 2a41a671..97c947f4 100644 --- a/test/test_dropwhile.cpp +++ b/test/test_dropwhile.cpp @@ -1,31 +1,15 @@ #include - -#include "helpers.hpp" - #include #include #include #include "catch.hpp" +#include "helpers.hpp" using iter::dropwhile; using Vec = const std::vector; -namespace { - class LessThanValue { - private: - int compare_val; - - public: - LessThanValue(int v) : compare_val(v) {} - - bool operator()(int i) { - return i < this->compare_val; - } - }; -} - TEST_CASE("dropwhile: skips initial elements", "[dropwhile]") { Vec ns{1, 2, 3, 4, 5, 6, 7, 8}; std::vector v; @@ -147,12 +131,6 @@ TEST_CASE("dropwhile: operator->", "[dropwhile]") { REQUIRE(it->size() == 6); } -namespace { - int less_than_five(int i) { - return i < 5; - } -} - TEST_CASE("dropwhile: works with function pointer", "[dropwhile]") { Vec ns{1, 2, 3, 4, 5, 6, 7, 8}; auto d = dropwhile(less_than_five, ns); diff --git a/test/test_filter.cpp b/test/test_filter.cpp index f160785b..a990844a 100644 --- a/test/test_filter.cpp +++ b/test/test_filter.cpp @@ -1,35 +1,15 @@ #include - -#include "helpers.hpp" - #include #include #include #include "catch.hpp" +#include "helpers.hpp" using iter::filter; using Vec = const std::vector; -namespace { - bool less_than_five(int i) { - return i < 5; - } - - class LessThanValue { - private: - int compare_val; - - public: - LessThanValue(int v) : compare_val(v) {} - - bool operator()(int i) { - return i < this->compare_val; - } - }; -} - TEST_CASE("filter: handles different callable types", "[filter]") { Vec ns = {1, 2, 5, 6, 3, 1, 7, -1, 5}; Vec vc = {1, 2, 3, 1, -1}; diff --git a/test/test_filterfalse.cpp b/test/test_filterfalse.cpp index 93d50d6a..9a1dd4bc 100644 --- a/test/test_filterfalse.cpp +++ b/test/test_filterfalse.cpp @@ -1,35 +1,15 @@ #include - -#include "helpers.hpp" - #include #include #include #include "catch.hpp" +#include "helpers.hpp" using iter::filterfalse; using Vec = const std::vector; -namespace { - bool less_than_five(int i) { - return i < 5; - } - - class LessThanValue { - private: - int compare_val; - - public: - LessThanValue(int v) : compare_val(v) {} - - bool operator()(int i) { - return i < this->compare_val; - } - }; -} - TEST_CASE("filterfalse: handles different callable types", "[filterfalse]") { Vec ns = {1, 2, 5, 6, 3, 1, 7, -1, 5}; Vec vc = {5, 6, 7, 5}; diff --git a/test/test_takewhile.cpp b/test/test_takewhile.cpp index e3dade73..0be43f84 100644 --- a/test/test_takewhile.cpp +++ b/test/test_takewhile.cpp @@ -1,6 +1,5 @@ -#include - #include +#include #include #include #include @@ -11,48 +10,34 @@ using iter::takewhile; using Vec = const std::vector; -namespace { - bool under_ten(int i) { - return i < 10; - } - - struct UnderTen { - bool operator()(int i) { - return i < 10; - } - }; -} - TEST_CASE("takewhile: works with lambda, callable, and function pointer", "[takewhile]") { - Vec ns = {1, 3, 5, 20, 2, 4, 6, 8}; + Vec ns = {1, 3, 4, 20, 2, 4, 6, 8}; + const Vec vc = {1, 3, 4}; SECTION("function pointer") { - auto tw = takewhile(under_ten, ns); + auto tw = takewhile(less_than_five, ns); Vec v(std::begin(tw), std::end(tw)); - Vec vc = {1, 3, 5}; REQUIRE(v == vc); } SECTION("callable object") { std::vector v; SECTION("Normal call") { - auto tw = takewhile(UnderTen{}, ns); + auto tw = takewhile(LessThanValue{10}, ns); v.assign(std::begin(tw), std::end(tw)); } SECTION("Pipe") { - auto tw = ns | takewhile(UnderTen{}); + auto tw = ns | takewhile(LessThanValue{10}); v.assign(std::begin(tw), std::end(tw)); } - Vec vc = {1, 3, 5}; REQUIRE(v == vc); } SECTION("lambda") { auto tw = takewhile([](int i) { return i < 10; }, ns); Vec v(std::begin(tw), std::end(tw)); - Vec vc = {1, 3, 5}; REQUIRE(v == vc); } } @@ -78,7 +63,7 @@ TEST_CASE("takewhile: handles pointer to member", "[takewhile]") { TEST_CASE("takewhile: supports const iteration", "[takewhile][const]") { Vec ns = {1, 3, 5, 20, 2, 4, 6, 8}; - const auto tw = takewhile(UnderTen{}, ns); + const auto tw = takewhile(LessThanValue{10}, ns); Vec v(std::begin(tw), std::end(tw)); Vec vc = {1, 3, 5}; REQUIRE(v == vc); @@ -86,7 +71,7 @@ TEST_CASE("takewhile: supports const iteration", "[takewhile][const]") { TEST_CASE("takewhile: const iterator and non-const iterator are comparable", "[takewhile][const]") { - auto tw = takewhile(UnderTen{}, Vec{}); + auto tw = takewhile(LessThanValue{10}, Vec{}); const auto& ctw = tw; (void)(std::begin(tw) == std::end(ctw)); } @@ -117,14 +102,14 @@ TEST_CASE("takewhile: identity", "[takewhile]") { TEST_CASE("takewhile: everything passes predicate", "[takewhile]") { Vec ns{1, 2, 3}; - auto tw = takewhile(under_ten, ns); + auto tw = takewhile(less_than_five, ns); Vec v(std::begin(tw), std::end(tw)); Vec vc = {1, 2, 3}; } TEST_CASE("takewhile: empty iterable is empty", "[takewhile]") { Vec ns{}; - auto tw = takewhile(under_ten, ns); + auto tw = takewhile(less_than_five, ns); SECTION("normal compare") { REQUIRE(std::begin(tw) == std::end(tw)); } @@ -138,7 +123,7 @@ TEST_CASE( "[takewhile]") { SECTION("First element is only element") { Vec ns = {20}; - auto tw = takewhile(under_ten, ns); + auto tw = takewhile(less_than_five, ns); SECTION("normal compare") { REQUIRE(std::begin(tw) == std::end(tw)); } @@ -149,7 +134,7 @@ TEST_CASE( SECTION("First element followed by elements that pass") { Vec ns = {20, 1, 1}; - auto tw = takewhile(under_ten, ns); + auto tw = takewhile(less_than_five, ns); SECTION("normal compare") { REQUIRE(std::begin(tw) == std::end(tw)); } @@ -161,10 +146,10 @@ TEST_CASE( TEST_CASE("takewhile: moves rvalues, binds to lvalues", "[takewhile]") { itertest::BasicIterable bi{1, 2}; - takewhile(under_ten, bi); + takewhile(less_than_five, bi); REQUIRE_FALSE(bi.was_moved_from()); - takewhile(under_ten, std::move(bi)); + takewhile(less_than_five, std::move(bi)); REQUIRE(bi.was_moved_from()); } From f9ce3d8d4eff145061df406f14265a4cc8946d6f Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Mon, 10 Feb 2025 13:03:10 -0800 Subject: [PATCH 14/36] Adds MoveOnlyLessThanValue for testing For #89 --- test/helpers.hpp | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/test/helpers.hpp b/test/helpers.hpp index 57f8a372..94fd08f1 100644 --- a/test/helpers.hpp +++ b/test/helpers.hpp @@ -430,4 +430,22 @@ class LessThanValue { } }; +class MoveOnlyLessThanValue { + private: + int compare_val; + + public: + MoveOnlyLessThanValue(int v) : compare_val(v) {} + + MoveOnlyLessThanValue(const MoveOnlyLessThanValue&) = delete; + MoveOnlyLessThanValue& operator=(const MoveOnlyLessThanValue&) = delete; + + MoveOnlyLessThanValue(MoveOnlyLessThanValue&&) = default; + MoveOnlyLessThanValue& operator=(MoveOnlyLessThanValue&&) = default; + + bool operator()(int i) { + return i < this->compare_val; + } +}; + #endif From 420583c1df803566942e1c70c61ef5986d85006e Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Mon, 10 Feb 2025 13:10:55 -0800 Subject: [PATCH 15/36] IncludeBlocks: Preserve in clang-format --- .clang-format | 1 + 1 file changed, 1 insertion(+) diff --git a/.clang-format b/.clang-format index 650739d3..d9d9622a 100644 --- a/.clang-format +++ b/.clang-format @@ -8,5 +8,6 @@ BreakBeforeBinaryOperators: NonAssignment DerivePointerAlignment: false NamespaceIndentation: All FixNamespaceComments: false +IncludeBlocks: Preserve ... From 1c828d06d73d6bdd1ee6649619ef61b459d0957a Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Mon, 10 Feb 2025 13:11:58 -0800 Subject: [PATCH 16/36] Adds move-only callable support to filter Issue #89 --- cppitertools/filter.hpp | 4 +++- test/test_filter.cpp | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/cppitertools/filter.hpp b/cppitertools/filter.hpp index 1e069070..53ed15cc 100644 --- a/cppitertools/filter.hpp +++ b/cppitertools/filter.hpp @@ -29,6 +29,8 @@ namespace iter { template class iter::impl::Filtered { + static_assert(!std::is_reference_v); + private: Container container_; mutable FilterFunc filter_func_; @@ -39,7 +41,7 @@ class iter::impl::Filtered { // Value constructor for use only in the filter function Filtered(FilterFunc filter_func, Container&& container) : container_(std::forward(container)), - filter_func_(filter_func) {} + filter_func_(std::move(filter_func)) {} public: Filtered(Filtered&&) = default; diff --git a/test/test_filter.cpp b/test/test_filter.cpp index a990844a..a0f5db96 100644 --- a/test/test_filter.cpp +++ b/test/test_filter.cpp @@ -25,6 +25,12 @@ TEST_CASE("filter: handles different callable types", "[filter]") { REQUIRE(v == vc); } + SECTION("with move-only callable object") { + auto f = filter(MoveOnlyLessThanValue{5}, ns); + Vec v(std::begin(f), std::end(f)); + REQUIRE(v == vc); + } + SECTION("with lambda") { auto ltf = [](int i) { return i < 5; }; auto f = filter(ltf, ns); From d45c47b75f28c976ae06cb472fcd29905b1bc207 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 16:30:40 -0800 Subject: [PATCH 17/36] Updates FnPartials to move stored_arg when rvalue Overloads `operator|` for rvalue and lvalue `Pipeable`s and downcasts accordingly. Adds rvalue-reference qualified overloads to FnPartial `operator|` that calls `std::move(stored_arg)` when creating the actual iterable object. This allows a move-only callable to get passed by value, but only moves, all the way into the itertool. ``` // both should work iter::some_itertool(sequence, MoveOnlyCallable{}); sequence | iter::some_itertool(MoveOnlyCallable{}); ``` I did attempt passing a `std::reference_wrapper` from the `FnPartial` but the iteration happens after the `FnPartial` is destroyed, So the following is unsafe: ``` // unsafe, wrong template auto operator()(Container&& container) const { if constexpr (std::is_copy_constructible_v) { return F{}(stored_arg, std::forward(container)); } else { return F{}(std::ref(stored_arg), std::forward(container)); } } ``` Setting the stage to fix #89 --- cppitertools/internal/iterbase.hpp | 38 +++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index 9a8b33ba..9cb97442 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -353,9 +353,14 @@ namespace iter { template struct Pipeable { template -#if defined(__GNUC__) && !defined(__clang__) - [[gnu::no_dangling]] +#if defined(__GNUC__) && !defined(__clang__) + [[gnu::no_dangling]] #endif + friend decltype(auto) operator|(T&& x, Pipeable&& p) { + return static_cast(p)(std::forward(x)); + } + + template friend decltype(auto) operator|(T&& x, const Pipeable& p) { return static_cast(p)(std::forward(x)); } @@ -378,11 +383,17 @@ namespace iter { protected: template struct FnPartial : Pipeable> { + static_assert(!std::is_reference_v); mutable T stored_arg; - constexpr FnPartial(T in_t) : stored_arg(in_t) {} + constexpr FnPartial(T in_t) : stored_arg(std::move(in_t)) {} template - auto operator()(Container&& container) const { + auto operator()(Container&& container) && { + return F{}(std::move(stored_arg), std::forward(container)); + } + + template + auto operator()(Container&& container) const& { return F{}(stored_arg, std::forward(container)); } }; @@ -403,10 +414,15 @@ namespace iter { template struct FnPartial : Pipeable> { mutable T stored_arg; - constexpr FnPartial(T in_t) : stored_arg(in_t) {} + constexpr FnPartial(T in_t) : stored_arg(std::move(in_t)) {} template - auto operator()(Container&& container) const { + auto operator()(Container&& container) && { + return F{}(std::forward(container), std::move(stored_arg)); + } + + template + auto operator()(Container&& container) const& { return F{}(std::forward(container), stored_arg); } }; @@ -469,10 +485,16 @@ namespace iter { template struct FnPartial : Pipeable> { mutable T stored_arg; - constexpr FnPartial(T in_t) : stored_arg(in_t) {} + constexpr FnPartial(T in_t) : stored_arg(std::move(in_t)) {} template - auto operator()(Container&& container) const { + auto operator()(Container&& container) && { + return IterToolFnOptionalBindSecond{}( + std::forward(container), std::move(stored_arg)); + } + + template + auto operator()(Container&& container) const& { return IterToolFnOptionalBindSecond{}( std::forward(container), stored_arg); } From dcc59d65c5036693c114f5a03b611b900180c83e Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 16:52:11 -0800 Subject: [PATCH 18/36] Uses unique_ptr in move-only callable for louder error Issue #89 --- test/helpers.hpp | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/test/helpers.hpp b/test/helpers.hpp index 94fd08f1..f94250f3 100644 --- a/test/helpers.hpp +++ b/test/helpers.hpp @@ -3,6 +3,7 @@ #include #include +#include #include #include #include @@ -432,10 +433,12 @@ class LessThanValue { class MoveOnlyLessThanValue { private: - int compare_val; + // unique_ptr is better for triggering asan than an int if there's a dangling + // reference to the callable + std::unique_ptr compare_val; public: - MoveOnlyLessThanValue(int v) : compare_val(v) {} + MoveOnlyLessThanValue(int v) : compare_val{std::make_unique(v)} {} MoveOnlyLessThanValue(const MoveOnlyLessThanValue&) = delete; MoveOnlyLessThanValue& operator=(const MoveOnlyLessThanValue&) = delete; @@ -444,7 +447,7 @@ class MoveOnlyLessThanValue { MoveOnlyLessThanValue& operator=(MoveOnlyLessThanValue&&) = default; bool operator()(int i) { - return i < this->compare_val; + return i < *compare_val; } }; From 0fc1cf1a3d889da8a8d390faedf4e4dcfc68e437 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 16:53:13 -0800 Subject: [PATCH 19/36] Adds filter tests with pipe and move-only Issue #89 --- test/test_filter.cpp | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/test/test_filter.cpp b/test/test_filter.cpp index a0f5db96..445476c8 100644 --- a/test/test_filter.cpp +++ b/test/test_filter.cpp @@ -13,30 +13,46 @@ using Vec = const std::vector; TEST_CASE("filter: handles different callable types", "[filter]") { Vec ns = {1, 2, 5, 6, 3, 1, 7, -1, 5}; Vec vc = {1, 2, 3, 1, -1}; + std::vector v; SECTION("with function pointer") { auto f = filter(less_than_five, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + v = Vec(std::begin(f), std::end(f)); } SECTION("with callable object") { auto f = filter(LessThanValue{5}, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + v = Vec(std::begin(f), std::end(f)); + } + + SECTION("with lvalue callable object") { + auto lt = LessThanValue{5}; + SECTION("normal call") { + auto f = filter(lt, ns); + v = Vec(std::begin(f), std::end(f)); + } + SECTION("pipe") { + auto f = ns | filter(lt); + v = Vec(std::begin(f), std::end(f)); + } } SECTION("with move-only callable object") { - auto f = filter(MoveOnlyLessThanValue{5}, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + SECTION("normal call") { + auto f = filter(MoveOnlyLessThanValue{5}, ns); + v = Vec(std::begin(f), std::end(f)); + } + SECTION("pipe") { + auto f = ns | filter(MoveOnlyLessThanValue{5}); + v = Vec(std::begin(f), std::end(f)); + } } SECTION("with lambda") { auto ltf = [](int i) { return i < 5; }; auto f = filter(ltf, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + v = Vec(std::begin(f), std::end(f)); } + REQUIRE(v == vc); } TEST_CASE("filter: handles pointer to member", "[filter]") { From 020f99db7570a39f281fcde6e59da154de58995d Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:04:21 -0800 Subject: [PATCH 20/36] Adds support for move-only callables in filterfalse Issue #89 --- cppitertools/filterfalse.hpp | 3 ++- test/test_filterfalse.cpp | 39 +++++++++++++++++++++++++----------- 2 files changed, 29 insertions(+), 13 deletions(-) diff --git a/cppitertools/filterfalse.hpp b/cppitertools/filterfalse.hpp index 4056c402..269724dd 100644 --- a/cppitertools/filterfalse.hpp +++ b/cppitertools/filterfalse.hpp @@ -48,7 +48,8 @@ class iter::impl::FilterFalsed friend FilterFalseFn; FilterFalsed(FilterFunc in_filter_func, Container&& in_container) : Filtered, Container>( - {in_filter_func}, std::forward(in_container)) {} + {std::move(in_filter_func)}, + std::forward(in_container)) {} }; #endif diff --git a/test/test_filterfalse.cpp b/test/test_filterfalse.cpp index 9a1dd4bc..ad79646a 100644 --- a/test/test_filterfalse.cpp +++ b/test/test_filterfalse.cpp @@ -13,31 +13,46 @@ using Vec = const std::vector; TEST_CASE("filterfalse: handles different callable types", "[filterfalse]") { Vec ns = {1, 2, 5, 6, 3, 1, 7, -1, 5}; Vec vc = {5, 6, 7, 5}; + std::vector v; SECTION("with function pointer") { auto f = filterfalse(less_than_five, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + v = Vec(std::begin(f), std::end(f)); } SECTION("with callable object") { - std::vector v; - SECTION("Normal call") { - auto f = filterfalse(LessThanValue{5}, ns); - v.assign(std::begin(f), std::end(f)); + auto f = filterfalse(LessThanValue{5}, ns); + v = Vec(std::begin(f), std::end(f)); + } + + SECTION("with lvalue callable object") { + auto lt = LessThanValue{5}; + SECTION("normal call") { + auto f = filterfalse(lt, ns); + v = Vec(std::begin(f), std::end(f)); + } + SECTION("pipe") { + auto f = ns | filterfalse(lt); + v = Vec(std::begin(f), std::end(f)); } - SECTION("Pipe") { - auto f = ns | filterfalse(LessThanValue{5}); - v.assign(std::begin(f), std::end(f)); + } + + SECTION("with move-only callable object") { + SECTION("normal call") { + auto f = filterfalse(MoveOnlyLessThanValue{5}, ns); + v = Vec(std::begin(f), std::end(f)); + } + SECTION("pipe") { + auto f = ns | filterfalse(MoveOnlyLessThanValue{5}); + v = Vec(std::begin(f), std::end(f)); } - REQUIRE(v == vc); } SECTION("with lambda") { auto ltf = [](int i) { return i < 5; }; auto f = filterfalse(ltf, ns); - Vec v(std::begin(f), std::end(f)); - REQUIRE(v == vc); + v = Vec(std::begin(f), std::end(f)); } + REQUIRE(v == vc); } TEST_CASE("filterfalse: handles pointer to member", "[filterfalse]") { From f9f7de419c7360c97281cc35db02c3d689aa005b Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:04:52 -0800 Subject: [PATCH 21/36] Adds support for move-only callables in dropwhile Issue #89 --- cppitertools/dropwhile.hpp | 2 +- test/test_dropwhile.cpp | 45 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 1 deletion(-) diff --git a/cppitertools/dropwhile.hpp b/cppitertools/dropwhile.hpp index e751bfe3..86942826 100644 --- a/cppitertools/dropwhile.hpp +++ b/cppitertools/dropwhile.hpp @@ -29,7 +29,7 @@ class iter::impl::Dropper { Dropper(FilterFunc filter_func, Container&& container) : container_(std::forward(container)), - filter_func_(filter_func) {} + filter_func_(std::move(filter_func)) {} public: Dropper(Dropper&&) = default; diff --git a/test/test_dropwhile.cpp b/test/test_dropwhile.cpp index 97c947f4..077bfd73 100644 --- a/test/test_dropwhile.cpp +++ b/test/test_dropwhile.cpp @@ -10,6 +10,51 @@ using iter::dropwhile; using Vec = const std::vector; +TEST_CASE("dropwhile: handles different callable types", "[dropwhile]") { + Vec ns = {1, 3, 4, 20, 2, 4, 6, 8}; + Vec vc = {20, 2, 4, 6, 8}; + std::vector v; + SECTION("with function pointer") { + auto d = dropwhile(less_than_five, ns); + v = Vec(std::begin(d), std::end(d)); + } + + SECTION("with callable object") { + auto d = dropwhile(LessThanValue{5}, ns); + v = Vec(std::begin(d), std::end(d)); + } + + SECTION("with lvalue callable object") { + auto lt = LessThanValue{5}; + SECTION("normal call") { + auto d = dropwhile(lt, ns); + v = Vec(std::begin(d), std::end(d)); + } + SECTION("pipe") { + auto d = ns | dropwhile(lt); + v = Vec(std::begin(d), std::end(d)); + } + } + + SECTION("with move-only callable object") { + SECTION("normal call") { + auto d = dropwhile(MoveOnlyLessThanValue{5}, ns); + v = Vec(std::begin(d), std::end(d)); + } + SECTION("pipe") { + auto d = ns | dropwhile(MoveOnlyLessThanValue{5}); + v = Vec(std::begin(d), std::end(d)); + } + } + + SECTION("with lambda") { + auto ltf = [](int i) { return i < 5; }; + auto d = dropwhile(ltf, ns); + v = Vec(std::begin(d), std::end(d)); + } + REQUIRE(v == vc); +} + TEST_CASE("dropwhile: skips initial elements", "[dropwhile]") { Vec ns{1, 2, 3, 4, 5, 6, 7, 8}; std::vector v; From 35fdf0c9fba07476d4d07f608396640d6d6d2c47 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:05:23 -0800 Subject: [PATCH 22/36] Adds support for move-only callables to groupby Issue #89 --- cppitertools/groupby.hpp | 3 +- test/test_groupby.cpp | 74 +++++++++++++++++++++++++++++++++++----- 2 files changed, 67 insertions(+), 10 deletions(-) diff --git a/cppitertools/groupby.hpp b/cppitertools/groupby.hpp index 6d7453f9..313f088a 100644 --- a/cppitertools/groupby.hpp +++ b/cppitertools/groupby.hpp @@ -35,7 +35,8 @@ class iter::impl::GroupProducer { using key_func_ret = std::invoke_result_t>; GroupProducer(Container&& container, KeyFunc key_func) - : container_(std::forward(container)), key_func_(key_func) {} + : container_(std::forward(container)), + key_func_(std::move(key_func)) {} public: GroupProducer(GroupProducer&&) = default; diff --git a/test/test_groupby.cpp b/test/test_groupby.cpp index 6ce9d479..5904c78d 100644 --- a/test/test_groupby.cpp +++ b/test/test_groupby.cpp @@ -3,6 +3,7 @@ #include "helpers.hpp" #include +#include #include #include @@ -21,22 +22,38 @@ namespace { } }; + struct MoveOnlySizer { + // here to trigger asan if a dangling reference gets used + std::unique_ptr counter_ = std::make_unique(); + + MoveOnlySizer(const MoveOnlySizer&) = delete; + MoveOnlySizer& operator=(const MoveOnlySizer&) = delete; + + MoveOnlySizer(MoveOnlySizer&&) = default; + MoveOnlySizer& operator=(MoveOnlySizer&&) = default; + + int operator()(const std::string& s) { + ++*counter_; + return s.size(); + } + }; + const std::vector vec = { "hi", "ab", "ho", "abc", "def", "abcde", "efghi"}; } -TEST_CASE("groupby: works with lambda, callable, and function pointer") { +TEST_CASE("groupby: handles different callable types", "[groupby]") { std::vector keys; std::vector> groups; - SECTION("Function pointer") { - SECTION("Normal call") { + SECTION("with function pointer") { + SECTION("normal call") { for (auto&& gb : groupby(vec, length)) { keys.push_back(gb.first); groups.emplace_back(std::begin(gb.second), std::end(gb.second)); } } - SECTION("Pipe") { + SECTION("pipe") { for (auto&& gb : vec | groupby(length)) { keys.push_back(gb.first); groups.emplace_back(std::begin(gb.second), std::end(gb.second)); @@ -44,14 +61,53 @@ TEST_CASE("groupby: works with lambda, callable, and function pointer") { } } - SECTION("Callable object") { - for (auto&& gb : groupby(vec, Sizer{})) { - keys.push_back(gb.first); - groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + SECTION("with callable object") { + SECTION("normal call") { + for (auto&& gb : groupby(vec, Sizer{})) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } + } + SECTION("pipe") { + for (auto&& gb : vec | groupby(Sizer{})) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } } } - SECTION("lambda function") { + SECTION("with lvalue callable object") { + auto sizer = Sizer{}; + SECTION("normal call") { + for (auto&& gb : groupby(vec, sizer)) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } + } + SECTION("pipe") { + for (auto&& gb : vec | groupby(sizer)) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } + } + } + + SECTION("with move-only callable object") { + SECTION("normal call") { + for (auto&& gb : groupby(vec, MoveOnlySizer{})) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } + } + SECTION("pipe") { + for (auto&& gb : vec | groupby(MoveOnlySizer{})) { + keys.push_back(gb.first); + groups.emplace_back(std::begin(gb.second), std::end(gb.second)); + } + } + } + + SECTION("with lambda") { for (auto&& gb : groupby(vec, [](const std::string& s) { return s.size(); })) { keys.push_back(gb.first); From 417b1ebe067a381585def401c2f94a8c1ae20476 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:06:29 -0800 Subject: [PATCH 23/36] Adds support for move-only callables to imap Issue #89 --- cppitertools/imap.hpp | 3 +- test/test_imap.cpp | 72 ++++++++++++++++++++++++++++++++----------- 2 files changed, 56 insertions(+), 19 deletions(-) diff --git a/cppitertools/imap.hpp b/cppitertools/imap.hpp index 80b8cc3d..21ca2e81 100644 --- a/cppitertools/imap.hpp +++ b/cppitertools/imap.hpp @@ -16,7 +16,8 @@ namespace iter { // See #66 -> StarMapper(containers)...))> { - return starmap(map_func, zip(std::forward(containers)...)); + return starmap( + std::move(map_func), zip(std::forward(containers)...)); } using PipeableAndBindFirst::operator(); }; diff --git a/test/test_imap.cpp b/test/test_imap.cpp index 40a9d3e3..cfda992b 100644 --- a/test/test_imap.cpp +++ b/test/test_imap.cpp @@ -17,10 +17,29 @@ namespace { return i + 1; } - class PlusOner { + struct PlusOner { + int operator()(int i) const { + return i + 1; + } + }; + + class MoveOnlyAdder { + private: + // unique_ptr is better for triggering asan than an int if there's a + // dangling reference to the callable + std::unique_ptr add_amount_; + public: + MoveOnlyAdder(int v) : add_amount_{std::make_unique(v)} {} + + MoveOnlyAdder(const MoveOnlyAdder&) = delete; + MoveOnlyAdder& operator=(const MoveOnlyAdder&) = delete; + + MoveOnlyAdder(MoveOnlyAdder&&) = default; + MoveOnlyAdder& operator=(MoveOnlyAdder&&) = default; + int operator()(int i) { - return i + 1; + return i + *add_amount_; } }; @@ -33,31 +52,48 @@ namespace { } } -TEST_CASE("imap: works with lambda, callable, and function", "[imap]") { - Vec ns = {10, 20, 30}; +TEST_CASE("imap: handles different callable types", "[imap]") { + Vec ns = {10, 15, 300}; + Vec vc = {11, 16, 301}; std::vector v; - SECTION("with lambda") { - auto im = imap([](int i) { return i + 1; }, ns); - v.assign(std::begin(im), std::end(im)); + SECTION("with function pointer") { + auto m = imap(plusone, ns); + v = Vec(std::begin(m), std::end(m)); } - SECTION("with callable") { - SECTION("Normal call") { - auto im = imap(PlusOner{}, ns); - v.assign(std::begin(im), std::end(im)); + SECTION("with callable object") { + auto m = imap(PlusOner{}, ns); + v = Vec(std::begin(m), std::end(m)); + } + + SECTION("with lvalue callable object") { + auto lt = PlusOner{}; + SECTION("normal call") { + auto m = imap(lt, ns); + v = Vec(std::begin(m), std::end(m)); } - SECTION("Pipe") { - auto im = ns | imap(PlusOner{}); - v.assign(std::begin(im), std::end(im)); + SECTION("pipe") { + auto m = ns | imap(lt); + v = Vec(std::begin(m), std::end(m)); } } - SECTION("with function") { - auto im = imap(PlusOner{}, ns); - v.assign(std::begin(im), std::end(im)); + SECTION("with move-only callable object") { + SECTION("normal call") { + auto m = imap(MoveOnlyAdder{1}, ns); + v = Vec(std::begin(m), std::end(m)); + } + SECTION("pipe") { + auto m = ns | imap(MoveOnlyAdder{1}); + v = Vec(std::begin(m), std::end(m)); + } } - Vec vc = {11, 21, 31}; + SECTION("with lambda") { + auto ltf = [](int i) { return i + 1; }; + auto m = imap(ltf, ns); + v = Vec(std::begin(m), std::end(m)); + } REQUIRE(v == vc); } From 6a23fdae0ac40524a53ffa3d6a72689fb60aa990 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:07:08 -0800 Subject: [PATCH 24/36] Adds tests for move-only callables to starmap Issue #89 --- test/test_starmap.cpp | 81 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 74 insertions(+), 7 deletions(-) diff --git a/test/test_starmap.cpp b/test/test_starmap.cpp index e3958c84..c8758669 100644 --- a/test/test_starmap.cpp +++ b/test/test_starmap.cpp @@ -47,16 +47,42 @@ namespace { return a; } }; + + struct Adder { + long operator()(long a, int b) { + return a + b; + } + }; + + struct MoveOnlyAddAndPlus { + private: + // unique_ptr is better for triggering asan than an int if there's a + // dangling reference to the callable + std::unique_ptr add_amount_; + + public: + MoveOnlyAddAndPlus(int v) : add_amount_{std::make_unique(v)} {} + + MoveOnlyAddAndPlus(const MoveOnlyAddAndPlus&) = delete; + MoveOnlyAddAndPlus& operator=(const MoveOnlyAddAndPlus&) = delete; + + MoveOnlyAddAndPlus(MoveOnlyAddAndPlus&&) = default; + MoveOnlyAddAndPlus& operator=(MoveOnlyAddAndPlus&&) = default; + + int operator()(long a, int b) { + return a + b + *add_amount_; + } + }; } TEST_CASE("starmap: works with function pointer and lambda", "[starmap]") { - using Vec = const std::vector; const std::vector> v1 = {{1l, 2}, {3l, 11}, {6l, 7}}; - Vec vc = {2l, 33l, 42l}; + const std::vector greater_vc = {2l, 33l, 42l}; + const std::vector added_vc = {3l, 14l, 13l}; - std::vector v; - SECTION("with function") { - SECTION("Normal call") { + SECTION("with function pointer") { + std::vector v; + SECTION("normal call") { auto sm = starmap(f, v1); v.assign(std::begin(sm), std::end(sm)); } @@ -64,13 +90,54 @@ TEST_CASE("starmap: works with function pointer and lambda", "[starmap]") { auto sm = v1 | starmap(f); v.assign(std::begin(sm), std::end(sm)); } + REQUIRE(v == greater_vc); + } + + SECTION("with callable object") { + std::vector v; + SECTION("normal call") { + auto sm = starmap(Adder{}, v1); + v.assign(std::begin(sm), std::end(sm)); + } + SECTION("pipe") { + auto sm = v1 | starmap(Adder{}); + v.assign(std::begin(sm), std::end(sm)); + } + REQUIRE(v == added_vc); + } + + SECTION("with lvalue callable object") { + std::vector v; + auto adder = Adder{}; + SECTION("normal call") { + auto sm = starmap(adder, v1); + v.assign(std::begin(sm), std::end(sm)); + } + SECTION("pipe") { + auto sm = v1 | starmap(adder); + v.assign(std::begin(sm), std::end(sm)); + } + REQUIRE(v == std::vector{3l, 14l, 13l}); + } + + SECTION("with move-only callable object") { + const std::vector sum_plus_one_vc = {4l, 14l, 13l}; + std::vector v; + SECTION("normal call") { + auto m = starmap(MoveOnlyAddAndPlus{1}, v1); + v.assign(std::begin(m), std::end(m)); + } + SECTION("pipe") { + auto m = v1 | starmap(MoveOnlyAddAndPlus{1}); + v.assign(std::begin(m), std::end(m)); + } } SECTION("with lambda") { auto sm = starmap([](long a, int b) { return a * b; }, v1); - v.assign(std::begin(sm), std::end(sm)); + std::vector v(std::begin(sm), std::end(sm)); + REQUIRE(v == greater_vc); } - REQUIRE(v == vc); } TEST_CASE("starmap: works with pointer to member function", "[starmap]") { From 7242a9aadbbd70026a5e3b4059df9075fe465a7f Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:07:54 -0800 Subject: [PATCH 25/36] Adds support for move-only callables to takewhile Issue #89 --- cppitertools/takewhile.hpp | 2 +- test/test_takewhile.cpp | 53 ++++++++++++++++++++++++-------------- 2 files changed, 34 insertions(+), 21 deletions(-) diff --git a/cppitertools/takewhile.hpp b/cppitertools/takewhile.hpp index 338e43aa..3a351d0c 100644 --- a/cppitertools/takewhile.hpp +++ b/cppitertools/takewhile.hpp @@ -29,7 +29,7 @@ class iter::impl::Taker { Taker(FilterFunc filter_func, Container&& container) : container_(std::forward(container)), - filter_func_(filter_func) {} + filter_func_(std::move(filter_func)) {} public: Taker(Taker&&) = default; diff --git a/test/test_takewhile.cpp b/test/test_takewhile.cpp index 0be43f84..f562b438 100644 --- a/test/test_takewhile.cpp +++ b/test/test_takewhile.cpp @@ -10,36 +10,49 @@ using iter::takewhile; using Vec = const std::vector; -TEST_CASE("takewhile: works with lambda, callable, and function pointer", - "[takewhile]") { +TEST_CASE("takewhile: handles different callable types", "[takewhile]") { Vec ns = {1, 3, 4, 20, 2, 4, 6, 8}; - const Vec vc = {1, 3, 4}; - SECTION("function pointer") { + Vec vc = {1, 3, 4}; + std::vector v; + SECTION("with function pointer") { auto tw = takewhile(less_than_five, ns); - Vec v(std::begin(tw), std::end(tw)); - REQUIRE(v == vc); + v = Vec(std::begin(tw), std::end(tw)); } - SECTION("callable object") { - std::vector v; - SECTION("Normal call") { - auto tw = takewhile(LessThanValue{10}, ns); - v.assign(std::begin(tw), std::end(tw)); - } + SECTION("with callable object") { + auto tw = takewhile(LessThanValue{5}, ns); + v = Vec(std::begin(tw), std::end(tw)); + } - SECTION("Pipe") { - auto tw = ns | takewhile(LessThanValue{10}); - v.assign(std::begin(tw), std::end(tw)); + SECTION("with lvalue callable object") { + auto lt = LessThanValue{5}; + SECTION("normal call") { + auto tw = takewhile(lt, ns); + v = Vec(std::begin(tw), std::end(tw)); + } + SECTION("pipe") { + auto tw = ns | takewhile(lt); + v = Vec(std::begin(tw), std::end(tw)); } + } - REQUIRE(v == vc); + SECTION("with move-only callable object") { + SECTION("normal call") { + auto tw = takewhile(MoveOnlyLessThanValue{5}, ns); + v = Vec(std::begin(tw), std::end(tw)); + } + SECTION("pipe") { + auto tw = ns | takewhile(MoveOnlyLessThanValue{5}); + v = Vec(std::begin(tw), std::end(tw)); + } } - SECTION("lambda") { - auto tw = takewhile([](int i) { return i < 10; }, ns); - Vec v(std::begin(tw), std::end(tw)); - REQUIRE(v == vc); + SECTION("with lambda") { + auto ltf = [](int i) { return i < 5; }; + auto tw = takewhile(ltf, ns); + v = Vec(std::begin(tw), std::end(tw)); } + REQUIRE(v == vc); } TEST_CASE("takewhile: handles pointer to member", "[takewhile]") { From 051d8f9830c401697213dc538477d41c5709b213 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:08:09 -0800 Subject: [PATCH 26/36] Adds support for move-only callables to unique_justseen Issue #89 --- cppitertools/unique_justseen.hpp | 8 ++++--- test/test_unique_justseen.cpp | 40 +++++++++++++++++++++++++------- 2 files changed, 37 insertions(+), 11 deletions(-) diff --git a/cppitertools/unique_justseen.hpp b/cppitertools/unique_justseen.hpp index c4ca47f5..e86d20ba 100644 --- a/cppitertools/unique_justseen.hpp +++ b/cppitertools/unique_justseen.hpp @@ -9,9 +9,11 @@ namespace iter { namespace impl { - struct UniqueJustseenFn : PipeableAndBindOptionalSecond { + struct UniqueJustseenFn + : PipeableAndBindOptionalSecond { public: - using PipeableAndBindOptionalSecond::operator(); + using PipeableAndBindOptionalSecond:: + operator(); template auto operator()(Container&& container, KeyFunc key_fn) const { // decltype(auto) return type in lambda so reference types are preserved @@ -19,7 +21,7 @@ namespace iter { [](auto&& group) -> decltype(auto) { return *get_begin(group.second); }, - groupby(std::forward(container), key_fn)); + groupby(std::forward(container), std::move(key_fn))); } }; } diff --git a/test/test_unique_justseen.cpp b/test/test_unique_justseen.cpp index 6147b477..530ab869 100644 --- a/test/test_unique_justseen.cpp +++ b/test/test_unique_justseen.cpp @@ -102,21 +102,45 @@ struct IntWrapperKey { } }; -TEST_CASE("unique_justseen: works with key function", - "[unique_justseen]") { +struct MoveOnlyIntWrapperKey { + MoveOnlyIntWrapperKey(const MoveOnlyIntWrapperKey&) = delete; + MoveOnlyIntWrapperKey& operator=(const MoveOnlyIntWrapperKey&) = delete; + + MoveOnlyIntWrapperKey(MoveOnlyIntWrapperKey&&) = default; + MoveOnlyIntWrapperKey& operator=(MoveOnlyIntWrapperKey&&) = default; + int operator()(const IntWrapper& iw) const { + return iw.n; + } +}; + +TEST_CASE("unique_justseen: works with key function", "[unique_justseen]") { std::vector iwv = { {2}, {3}, {4}, {2}, {10}, {2}, {2}, {12}, {10}}; Vec vc{2, 3, 4, 2, 10, 2, 12, 10}; std::vector v; - SECTION("Normal call") { - for (auto&& iw : unique_justseen(iwv, IntWrapperKey{})) { - v.push_back(iw.n); + SECTION("with callable") { + SECTION("Normal call") { + for (auto&& iw : unique_justseen(iwv, IntWrapperKey{})) { + v.push_back(iw.n); + } + } + SECTION("Pipe") { + for (auto&& iw : iwv | unique_justseen(IntWrapperKey{})) { + v.push_back(iw.n); + } } } - SECTION("Pipe") { - for (auto&& iw : iwv | unique_justseen(IntWrapperKey{})) { - v.push_back(iw.n); + SECTION("with move-only callable") { + SECTION("Normal call") { + for (auto&& iw : unique_justseen(iwv, MoveOnlyIntWrapperKey{})) { + v.push_back(iw.n); + } + } + SECTION("Pipe") { + for (auto&& iw : iwv | unique_justseen(MoveOnlyIntWrapperKey{})) { + v.push_back(iw.n); + } } } From 7ce67a6e4602651130bab0b71bb31d877c5a66f4 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Wed, 12 Feb 2025 17:48:27 -0800 Subject: [PATCH 27/36] Replaces true/false tag dispatches with if constexpr --- cppitertools/internal/iterbase.hpp | 48 ++++++++++-------------------- 1 file changed, 16 insertions(+), 32 deletions(-) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index 9cb97442..34abd934 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -214,28 +214,20 @@ namespace iter { } } - template - void dumb_advance_impl( - Iter& iter, const EndIter& end, Distance distance, std::false_type) { - for (Distance i(0); i < distance && iter != end; ++i) { - ++iter; - } - } - - template - void dumb_advance_impl( - Iter& iter, const EndIter& end, Distance distance, std::true_type) { - if (static_cast(end - iter) < distance) { - iter = end; - } else { - iter += distance; - } - } - // iter will not be incremented past end template void dumb_advance(Iter& iter, const EndIter& end, Distance distance) { - dumb_advance_impl(iter, end, distance, is_random_access_iter{}); + if constexpr (is_random_access_iter{}) { + if (static_cast(end - iter) < distance) { + iter = end; + } else { + iter += distance; + } + } else { + for (Distance i(0); i < distance && iter != end; ++i) { + ++iter; + } + } } template @@ -452,22 +444,14 @@ namespace iter { using Base = PipeableAndBindFirst>; - protected: - template - auto operator()(Container&& container, std::false_type) const { - return static_cast(*this)( - std::forward(container)); - } - - template - auto operator()(Container&& container, std::true_type) const { - return (*this)(DefaultT{}, std::forward(container)); - } - public: template auto operator()(T&& t) const { - return (*this)(std::forward(t), IsIterable{}); + if constexpr (IsIterable{}) { + return (*this)(DefaultT{}, std::forward(t)); + } else { + return static_cast(*this)(std::forward(t)); + } } template Date: Thu, 13 Feb 2025 16:36:06 -0800 Subject: [PATCH 28/36] Sets bazelversion to 8.* --- .bazelversion | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.bazelversion b/.bazelversion index cd1d2e94..f4abeaad 100644 --- a/.bazelversion +++ b/.bazelversion @@ -1 +1 @@ -8.0.1 +8.* From da33b531264fe1604871c8a2765f2ef3dcd98d99 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 14 Feb 2025 14:39:17 -0800 Subject: [PATCH 29/36] Forwards key to `Group` If we knew the key type was not a reference, we could just call std::move, but there might be an lvalue reference hiding in there. --- cppitertools/groupby.hpp | 8 ++++++-- test/test_groupby.cpp | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 2 deletions(-) diff --git a/cppitertools/groupby.hpp b/cppitertools/groupby.hpp index 313f088a..1c73f9f6 100644 --- a/cppitertools/groupby.hpp +++ b/cppitertools/groupby.hpp @@ -178,6 +178,8 @@ class iter::impl::GroupProducer { friend class Iterator; friend class GroupIterator; Iterator& owner_; + // The key function may return a reference, so we need to call forward, not + // move, when going for efficiency. key_func_ret key_; // completed is set if a Group is iterated through @@ -192,7 +194,7 @@ class iter::impl::GroupProducer { bool completed = false; Group(Iterator& owner, key_func_ret key) - : owner_(owner), key_(key) {} + : owner_(owner), key_(std::forward>(key)) {} public: ~Group() { @@ -204,7 +206,9 @@ class iter::impl::GroupProducer { // move-constructible, non-copy-constructible, non-assignable Group(Group&& other) noexcept - : owner_(other.owner_), key_{other.key_}, completed{other.completed} { + : owner_(other.owner_), + key_{std::forward>(other.key_)}, + completed{other.completed} { other.completed = true; } diff --git a/test/test_groupby.cpp b/test/test_groupby.cpp index 5904c78d..02798f39 100644 --- a/test/test_groupby.cpp +++ b/test/test_groupby.cpp @@ -40,6 +40,43 @@ namespace { const std::vector vec = { "hi", "ab", "ho", "abc", "def", "abcde", "efghi"}; + + struct Person { + std::string name; + int id; + bool operator==(const Person& other) const { + return id == other.id; + } + }; + + std::string& get_name(Person& p) { + return p.name; + } + + template + std::vector extract_person_group(G g) { + return {std::begin(g), std::end(g)}; + } +} + +TEST_CASE("groupby: handle key function that returns reference", "[groupby]") { + std::vector people = {{"first", 1}, {"first", 2}, {"first", 3}}; + std::vector keys; + std::vector> groups; + + for (auto&& gb : groupby(people, get_name)) { + groups.push_back(extract_person_group(std::move(gb.second))); + keys.push_back(gb.first); + } + + const std::vector kc = {"first"}; + const std::vector> gc = { + {{"first", 1}, {"first", 2}, {"first", 3}}}; + + REQUIRE(people[0].name == "first"); + REQUIRE(gc[0][0].name == "first"); + REQUIRE(keys == kc); + REQUIRE(groups == gc); } TEST_CASE("groupby: handles different callable types", "[groupby]") { From cf16b06cee79c7216233448cd25e4cb925efd7d2 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Fri, 14 Feb 2025 14:47:19 -0800 Subject: [PATCH 30/36] Only uses gnu::nodangling when it's available in gcc --- cppitertools/internal/iterbase.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index 34abd934..a21489dc 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -345,7 +345,7 @@ namespace iter { template struct Pipeable { template -#if defined(__GNUC__) && !defined(__clang__) +#if defined(__GNUC__) && !defined(__clang__) && __GNUC__ >= 14 [[gnu::no_dangling]] #endif friend decltype(auto) operator|(T&& x, Pipeable&& p) { From 5bc867a1ee8fbcee322f072d700171e1901214dc Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Tue, 18 Feb 2025 14:02:50 -0800 Subject: [PATCH 31/36] Removes cv qualifiers from value_type --- cppitertools/internal/iterbase.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index a21489dc..f4d8792e 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -117,7 +117,7 @@ namespace iter { template using iterator_traits_deref = - std::remove_reference_t>; + std::remove_cv_t>>; template struct IsIterable : std::false_type {}; From 392734a2991980f25fe18c91d8bee05c99477d0f Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Tue, 18 Feb 2025 17:03:48 -0800 Subject: [PATCH 32/36] Removes cv qualifiers from iterator iterator value_type --- cppitertools/internal/iteratoriterator.hpp | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/cppitertools/internal/iteratoriterator.hpp b/cppitertools/internal/iteratoriterator.hpp index 3993a4d0..0ab23bad 100644 --- a/cppitertools/internal/iteratoriterator.hpp +++ b/cppitertools/internal/iteratoriterator.hpp @@ -24,7 +24,8 @@ namespace iter { template class IteratorIterator { - template friend class IteratorIterator; + template + friend class IteratorIterator; using Diff = std::ptrdiff_t; static_assert( std::is_same< @@ -37,10 +38,14 @@ namespace iter { public: using iterator_category = std::random_access_iterator_tag; - using value_type = std::remove_reference_t())>; + using value_type = std::remove_cv_t< + std::remove_reference_t())>>; using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; + using pointer = + std::remove_reference_t())>*; + using reference = std::add_lvalue_reference_t< + std::remove_reference_t())>>; + IteratorIterator() = default; IteratorIterator(const TopIter& it) : sub_iter{it} {} @@ -84,7 +89,7 @@ namespace iter { return **this->sub_iter; } - auto operator-> () const -> decltype(*sub_iter) { + auto operator->() const -> decltype(*sub_iter) { return *this->sub_iter; } From 1bbe5a437f5039d242b0fb6983faa2a3f005edc5 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Tue, 18 Feb 2025 17:10:03 -0800 Subject: [PATCH 33/36] Removes cv qualifiers from DerefHolder when storing value --- cppitertools/internal/iterbase.hpp | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/cppitertools/internal/iterbase.hpp b/cppitertools/internal/iterbase.hpp index f4d8792e..e9627079 100644 --- a/cppitertools/internal/iterbase.hpp +++ b/cppitertools/internal/iterbase.hpp @@ -262,9 +262,8 @@ namespace iter { std::is_same::value && are_same::value> {}; // DerefHolder holds the value gotten from an iterator dereference - // if the iterate dereferences to an lvalue references, a pointer to the - // element is stored - // if it does not, a value is stored instead + // if the iterator dereferences to an lvalue references, a pointer to the + // element is stored. if it does not, a value is stored instead // get() returns a reference to the held item // get_ptr() returns a pointer to the held item // reset() replaces the currently held item @@ -274,7 +273,7 @@ namespace iter { static_assert(!std::is_lvalue_reference::value, "Non-lvalue-ref specialization used for lvalue ref type"); // it could still be an rvalue reference - using TPlain = std::remove_reference_t; + using TPlain = std::remove_cv_t>; std::optional item_p_; From 674e8b9a6d2f2319ea38312b6ada073937843e70 Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Tue, 18 Feb 2025 17:10:52 -0800 Subject: [PATCH 34/36] Specifies pointer and reference to match operators exactly --- cppitertools/filter.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cppitertools/filter.hpp b/cppitertools/filter.hpp index 53ed15cc..d743d8b1 100644 --- a/cppitertools/filter.hpp +++ b/cppitertools/filter.hpp @@ -86,8 +86,8 @@ class iter::impl::Filtered { using iterator_category = std::input_iterator_tag; using value_type = iterator_traits_deref; using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; + using pointer = typename Holder::pointer; + using reference = typename Holder::reference; Iterator(IteratorWrapper&& sub_iter, IteratorWrapper&& sub_end, FilterFunc& filter_func) From 13947eb68f464cb014343de7a155016290655d1a Mon Sep 17 00:00:00 2001 From: Ryan Haining Date: Tue, 18 Feb 2025 17:13:09 -0800 Subject: [PATCH 35/36] Specifies chain pointer and reference to match calls exactly --- cppitertools/chain.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cppitertools/chain.hpp b/cppitertools/chain.hpp index 76759eeb..05557387 100644 --- a/cppitertools/chain.hpp +++ b/cppitertools/chain.hpp @@ -142,8 +142,8 @@ class iter::impl::Chained { using iterator_category = std::input_iterator_tag; using value_type = typename IteratorData::TraitsValue; using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; + using pointer = typename IteratorData::ArrowType; + using reference = typename IteratorData::DerefType; Iterator(std::size_t i, typename IterData::IterTupType&& iters, typename IterData::IterTupType&& ends) From bb59879a7dbea29cc70d204b8c4889e35bb1110e Mon Sep 17 00:00:00 2001 From: Cristi Popa Date: Sat, 6 Dec 2025 15:55:05 +0100 Subject: [PATCH 36/36] Update readme to use google style markdown rendering --- README.md | 382 +++++++++++++++++++++++++++++------------------------- 1 file changed, 206 insertions(+), 176 deletions(-) diff --git a/README.md b/README.md index 7b43c218..740dacbd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ - - CPPItertools ============ Range-based for loop add-ons inspired by the Python builtins and itertools -library. Like itertools and the Python3 builtins, this library uses lazy +library. Like itertools and the Python3 builtins, this library uses lazy evaluation wherever possible. *Note*: Everything is inside the `iter` namespace. @@ -44,7 +42,7 @@ Status | Compilers [chunked](#chunked)
[batched](#batched)
-##### Combinatoric fuctions +##### Combinatorial functions [product](#product)
[combinations](#combinations)
[combinations\_with\_replacement](#combinations_with_replacement)
@@ -55,11 +53,10 @@ Status | Compilers This library is **header-only** and relies only on the C++ standard library. The only exception is `zip_longest` which uses `boost::optional`. `#include ` will include all of the provided -tools except for `zip_longest` which must be included separately. You may +tools except for `zip_longest` which must be included separately. You may also include individual pieces with the relevant header (`#include ` for example). - ### Running tests You may use either `scons` or `bazel` to build the tests. `scons` seems to work better with viewing the test output, but the same `bazel` command @@ -86,7 +83,7 @@ $ bazel test //test:test_enumerate # runs a specific test #### Requirements of passed objects Most itertools will work with iterables using InputIterators and not copy -or move any underlying elements. The itertools that need ForwardIterators or +or move any underlying elements. The itertools that need ForwardIterators or have additional requirements are noted in this document. However, the cases should be fairly obvious: any time an element needs to appear multiple times (as in `combinations` or `cycle`) or be looked at more than once (specifically, @@ -110,7 +107,7 @@ appropriate as a GitHub issue (or you just don't want to open one), you can email me directly with whatever code you have that describes the problem; I've been pretty responsive in the past. If I believe you are "misusing" the library, I'll try to put the blame on myself for being unclear -in this document and take the steps to clarify it. So please, contact me with +in this document and take the steps to clarify it. So please, contact me with any concerns, I'm open to feedback. #### How (not) to use this library @@ -125,41 +122,42 @@ know. #### Handling of rvalues vs lvalues The rules are pretty simple, and the library can be largely used without -knowledge of them. -Let's take an example +knowledge of them. Let's take an example + ```c++ std::vector vec{2,4,6,8}; for (auto&& p : enumerate(vec)) { /* ... */ } ``` + In this case, `enumerate` will return an object that has bound a reference to `vec`. No copies are produced here, neither of `vec` nor of the elements it holds. If an rvalue was passed to enumerate, binding a reference would be unsafe. Consider: + ```c++ for (auto&& p : enumerate(std::vector{2,4,6,8})) { /* ... */ } ``` + Instead, `enumerate` will return an object that has the temporary *moved* into -it. That is, the returned object will contain a `std::vector` rather than +it. That is, the returned object will contain a `std::vector` rather than just a reference to one. This may seem like a contrived example, but it matters when `enumerate` is passed the result of a function call like `enumerate(f())`, -or, more obviously, something like `enumerate(zip(a, b))`. The object returned +or, more obviously, something like `enumerate(zip(a, b))`. The object returned from `zip` must be moved into the `enumerate` object. As a more specific result, itertools can be mixed and nested. - - #### Pipe syntax Wherever it makes sense, I've implemented the "pipe" operator that has become common in similar libraries. When the syntax is available, it is done by pulling out the iterable from the call and placing it before the tool. For example: ```c++ -filter(pred, seq); // regular call -seq | filter(pred); // pipe-style -enumerate(seq); // regular call -seq | enumerate; // pipe-style. +filter(pred, seq); // regular call +seq | filter(pred); // pipe-style +enumerate(seq); // regular call +seq | enumerate; // pipe-style. ``` The following tools support pipe. The remaining I left out because although @@ -193,46 +191,50 @@ would expect them to behave: I don't personally care for the piping style, but it seemed to be desired by the users. - range ----- Uses an underlying iterator to achieve the same effect of the python range -function. `range` can be used in three different ways: +function. `range` can be used in three different ways: + +Only the stopping point is provided. Prints `0 1 2 3 4 5 6 7 8 9` -Only the stopping point is provided. Prints `0 1 2 3 4 5 6 7 8 9` ```c++ for (auto i : range(10)) { - cout << i << '\n'; + cout << i << '\n'; } ``` -The start and stop are both provided. Prints `10 11 12 13 14` +The start and stop are both provided. Prints `10 11 12 13 14` + ```c++ for (auto i : range(10, 15)) { - cout << i << '\n'; + cout << i << '\n'; } ``` -The start, stop, and step are all provided. Prints `20 22 24 26 28` +The start, stop, and step are all provided. Prints `20 22 24 26 28` + ```c++ for (auto i : range(20, 30, 2)) { - cout << i << '\n'; + cout << i << '\n'; } ``` -Negative values are allowed as well. Prints `2 1 0 -1 -2` +Negative values are allowed as well. Prints `2 1 0 -1 -2` + ```c++ for (auto i : range(2, -3, -1)) { - cout << i << '\n'; + cout << i << '\n'; } ``` A step size of 0 results in an empty range (Python's raises an exception). The following prints nothing + ```c++ for (auto i : range(0, 10, 0)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -240,9 +242,10 @@ In addition to normal integer range operations, doubles and other numeric types are supported through the template Prints: `5.0 5.5 6.0` ... `9.5` + ```c++ for(auto i : range(5.0, 10.0, 0.5)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -253,46 +256,45 @@ recomputed at each step to avoid accumulating floating point inaccuracies slower but more accurate. `range` also supports the following operations: - - `.size()` to get the number of elements in the range (not enabled for - floating point ranges). - - Accessors for `.start()`, `.stop()`, and `.step()`. - - Indexing. Given a range `r`, `r[n]` is the `n`th element in the range. + - `.size()` to get the number of elements in the range (not enabled for + floating point ranges). + - Accessors for `.start()`, `.stop()`, and `.step()`. + - Indexing. Given a range `r`, `r[n]` is the `n`th element in the range. enumerate --------- - -Continually "yields" containers similar to pairs. They are structs with -the index in `.first`, and the element in `.second`, and also work with structured -binding declarations. -Usage appears as: +Continually "yields" containers similar to pairs. They are structs with the +index in `.first`, and the element in `.second`, and also work with structured +binding declarations. Usage appears as: ```c++ vector vec{2, 4, 6, 8}; for (auto&& [i, e] : enumerate(vec)) { - cout << i << ": " << e << '\n'; + cout << i << ": " << e << '\n'; } ``` filter ------ -Called as `filter(predicate, iterable)`. The predicate can be any callable. +Called as `filter(predicate, iterable)`. The predicate can be any callable. `filter` will only yield values that are true under the predicate. -Prints values greater than 4: `5 6 7 8` +Prints values greater than 4: `5 6 7 8` + ```c++ vector vec{1, 5, 4, 0, 6, 7, 3, 0, 2, 8, 3, 2, 1}; for (auto&& i : filter([] (int i) { return i > 4; }, vec)) { - cout << i <<'\n'; + cout << i <<'\n'; } - ``` If no predicate is passed, the elements themselves are tested for truth Prints only non-zero values. + ```c++ for(auto&& i : filter(vec)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -300,36 +302,38 @@ filterfalse ----------- Similar to filter, but only prints values that are false under the predicate. -Prints values not greater than 4: `1 4 3 2 3 2 1 ` +Prints values not greater than 4: `1 4 3 2 3 2 1` + ```c++ vector vec{1, 5, 4, 0, 6, 7, 3, 0, 2, 8, 3, 2, 1}; for (auto&& i : filterfalse([] (int i) { return i > 4; }, vec)) { - cout << i <<'\n'; + cout << i <<'\n'; } - ``` If no predicate is passed, the elements themselves are tested for truth. Prints only zero values. + ```c++ for(auto&& i : filterfalse(vec)) { - cout << i << '\n'; + cout << i << '\n'; } - ``` + unique\_everseen ---------------- +---------------- *Additional Requirements*: Underlying values must be copy-constructible. This is a filter adaptor that only generates values that have never been seen before. Prints `1 2 3 4 5 6 7 8 9` + ```c++ vector v {1,2,3,4,3,2,1,5,6,7,7,8,9,8,9,6}; for (auto&& i : unique_everseen(v)) { - cout << i << ' '; + cout << i << ' '; } ``` @@ -341,29 +345,30 @@ This **does not** work with the pipe syntax. ```c++ vector v { /* ... */ }; for (auto&& w : unique_everseen(v, WidgetHash{}, WidgetEq{})) { - cout << w.name() << ' '; + cout << w.name() << ' '; } ``` unique\_justseen --------------- +---------------- Another filter adaptor that only omits consecutive duplicates. Prints `1 2 3 4 3 2 1` -Example Usage: + ```c++ vector v {1,1,1,2,2,3,3,3,4,3,2,1,1,1}; for (auto&& i : unique_justseen(v)) { - cout << i << ' '; + cout << i << ' '; } ``` If elements cannot be directly compared with equality, you can pass in a key callable. + ```c++ vector v { /* ... */ }; -for (auto&& p : unique_justseen(v, [] (const Person& p) { return p.name; })) - cout << p.name() << ' ' << p.age() << '\n'; +for (auto&& p : unique_justseen(v, [] (const Person& p) { return p.name; })) { + cout << p.name() << ' ' << p.age() << '\n'; } ``` @@ -372,11 +377,12 @@ takewhile Yields elements from an iterable until the first element that is false under the predicate is encountered. -Prints `1 2 3 4`. (5 is false under the predicate) +Prints `1 2 3 4`. (5 is false under the predicate) + ```c++ vector ivec{1, 2, 3, 4, 5, 6, 7, 6, 5, 4, 3, 2, 1}; for (auto&& i : takewhile([] (int i) {return i < 5;}, ivec)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -386,10 +392,11 @@ Yields all elements after and including the first element that is true under the predicate. Prints `5 6 7 1 2` + ```c++ vector ivec{1, 2, 3, 4, 5, 6, 7, 1, 2}; for (auto&& i : dropwhile([] (int i) {return i < 5;}, ivec)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -397,18 +404,18 @@ cycle ----- *Additional Requirements*: Input must have a ForwardIterator - -Repeatedly produces all values of an iterable. The loop will be infinite, so a +Repeatedly produces all values of an iterable. The loop will be infinite, so a `break` or other control flow structure is necessary to exit. Prints `1 2 3` repeatedly until `some_condition` is true + ```c++ vector vec{1, 2, 3}; for (auto&& i : cycle(vec)) { - cout << i << '\n'; - if (some_condition) { - break; - } + cout << i << '\n'; + if (some_condition) { + break; + } } ``` @@ -416,19 +423,21 @@ repeat ------ Repeatedly produces a single argument forever, or a given number of times. `repeat` will bind a reference when passed an lvalue and move when given -an rvalue. It will then yield a reference to the same item until completion. +an rvalue. It will then yield a reference to the same item until completion. The below prints `1` five times. + ```c++ for (auto&& e : repeat(1, 5)) { - cout << e << '\n'; + cout << e << '\n'; } ``` The below prints `2` forever + ```c++ for (auto&& e : repeat(2)) { - cout << e << '\n'; + cout << e << '\n'; } ``` @@ -448,9 +457,10 @@ being the `std::numeric_limits::max()` for the integral type (`long` by default) The below will print `0 1 2` ... etc + ```c++ for (auto&& i : count()) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -460,31 +470,32 @@ groupby a reference, the reference must remain valid after the iterator is incremented. Roughly equivalent to requiring the Input have a ForwardIterator. -Separate an iterable into groups sharing a common key. The following example +Separate an iterable into groups sharing a common key. The following example creates a new group whenever a string of a different length is encountered. + ```c++ vector vec = { - "hi", "ab", "ho", - "abc", "def", - "abcde", "efghi" + "hi", "ab", "ho", + "abc", "def", + "abcde", "efghi" }; for (auto&& gb : groupby(vec, [] (const string &s) {return s.length(); })) { - cout << "key: " << gb.first << '\n'; - cout << "content: "; - for (auto&& s : gb.second) { - cout << s << " "; - } - cout << '\n'; + cout << "key: " << gb.first << '\n'; + cout << "content: "; + for (auto&& s : gb.second) { + cout << s << " "; + } + cout << '\n'; } ``` + *Note*: Just like Python's `itertools.groupby`, this doesn't do any sorting. It just iterates through, making a new group each time there is a key change. Thus, if the group is unsorted, the same key may appear multiple times. starmap ------- - Takes a sequence of tuple-like objects (anything that works with `std::get`) and unpacks each object into individual arguments for each function call. The below example takes a `vector` of `pairs` of ints, and passes them @@ -494,21 +505,21 @@ the first and second arguments to the function. ```c++ vector> v = {{2, 3}, {5, 2}, {3, 4}}; // {base, exponent} for (auto&& i : starmap([](int b, int e){return pow(b, e);}, v)) { - // ... + // ... } ``` `starmap` can also work over a tuple-like object of tuple-like objects even when the contained objects are different as long as the functor works with -multiple types of calls. For example, a `Callable` struct with overloads +multiple types of calls. For example, a `Callable` struct with overloads for its `operator()` will work as long as all overloads have the same return type ```c++ struct Callable { - int operator()(int i) const; - int operator()(int i, char c) const; - int operator()(double d, int i, char c) const; + int operator()(int i) const; + int operator()(int i, char c) const; + int operator()(double d, int i, char c) const; }; ``` @@ -516,36 +527,40 @@ This will work with a tuple of mixed types ```c++ auto t = make_tuple( - make_tuple(5), // first form - make_pair(3, 'c'), // second - make_tuple(1.0, 1, '1')); // third + make_tuple(5), // first form + make_pair(3, 'c'), // second + make_tuple(1.0, 1, '1')); // third for (auto&& i : starmap(Callable{}, t)) { - // ... + // ... } ``` accumulate -------- +---------- *Additional Requirements*: Type return from functor (with reference removed) must be assignable. Differs from `std::accumulate` (which in my humble opinion should be named -`std::reduce` or `std::foldl`). It is similar to a functional reduce where one -can see all of the intermediate results. By default, it keeps a running sum. +`std::reduce` or `std::foldl`). It is similar to a functional reduce where one +can see all of the intermediate results. By default, it keeps a running sum. + Prints: `1 3 6 10 15` + ```c++ for (auto&& i : accumulate(range(1, 6))) { - cout << i << '\n'; + cout << i << '\n'; } ``` + A second, optional argument may provide an alternative binary function -to compute results. The following example multiplies the numbers, rather +to compute results. The following example multiplies the numbers, rather than adding them. + Prints: `1 2 6 24 120` ```c++ for (auto&& i : accumulate(range(1, 6), std::multiplies{})) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -556,10 +571,11 @@ zip --- Takes an arbitrary number of ranges of different types and efficiently iterates over them in parallel (so an iterator to each container is incremented -simultaneously). When you dereference an iterator to "zipped" range you get a +simultaneously). When you dereference an iterator to "zipped" range you get a tuple of the elements the iterators were holding. Example usage: + ```c++ array iseq{{1,2,3,4}}; vector fseq{1.2,1.4,12.3,4.5,9.9}; @@ -567,16 +583,16 @@ vector sseq{"i","like","apples","a lot","dude"}; array dseq{{1.2,1.2,1.2,1.2,1.2}}; for (auto&& [i, f, s, d] : zip(iseq, fseq, sseq, dseq)) { - cout << i << ' ' << f << ' ' << s << ' ' << d << '\n'; - f = 2.2f; // modifies the underlying 'fseq' sequence + cout << i << ' ' << f << ' ' << s << ' ' << d << '\n'; + f = 2.2f; // modifies the underlying 'fseq' sequence } ``` zip\_longest ------------ +------------ Terminates on the longest sequence instead of the shortest. Repeatedly yields a tuple of `boost::optional`s where `T` is the type -yielded by the sequences' respective iterators. Because of its boost +yielded by the sequences' respective iterators. Because of its boost dependency, `zip_longest` is not in `itertools.hpp` and must be included separately. The following loop prints either "Just \" or "Nothing" for each @@ -586,23 +602,24 @@ element in each tuple yielded. vector v1 = {0, 1, 2, 3}; vector v2 = {10, 11}; for (auto&& [x, y] : zip_longest(v1, v2)) { - cout << '{'; - if (x) { - cout << "Just " << *x; - } else { - cout << "Nothing"; - } - cout << ", "; - if (y) { - cout << "Just " << *y; - } else { - cout << "Nothing"; - } - cout << "}\n"; + cout << '{'; + if (x) { + cout << "Just " << *x; + } else { + cout << "Nothing"; + } + cout << ", "; + if (y) { + cout << "Just " << *y; + } else { + cout << "Nothing"; + } + cout << "}\n"; } ``` The output is: + ``` {Just 0, Just 10} {Just 1, Just 11} @@ -612,27 +629,27 @@ The output is: imap ---- - -Takes a function and one or more iterables. The number of iterables must -match the number of arguments to the function. Applies the function to -each element (or elements) in the iterable(s). Terminates on the shortest +Takes a function and one or more iterables. The number of iterables must +match the number of arguments to the function. Applies the function to +each element (or elements) in the iterable(s). Terminates on the shortest sequence. Prints the squares of the numbers in vec: `1 4 9 16 25` ```c++ vector vec{1, 2, 3, 4, 5}; for (auto&& i : imap([] (int x) {return x * x;}, vec)) { - cout << i << '\n'; + cout << i << '\n'; } ``` With more than one sequence, the below adds corresponding elements from each vector together, printing `11 23 35 47 59 71` + ```c++ vector vec1{1, 3, 5, 7, 9, 11}; vector vec2{10, 20, 30, 40, 50, 60}; for (auto&& i : imap([] (int x, int y) { return x + y; }, vec1, vec2)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -640,10 +657,8 @@ for (auto&& i : imap([] (int x, int y) { return x + y; }, vec1, vec2)) { `std::map`, and because it is more related to `itertools.imap` than the python builtin `map`. - compress -------- - Yields only the values corresponding to true in the selectors iterable. Terminates on the shortest sequence. @@ -652,7 +667,7 @@ Prints `2 6` vector ivec{1, 2, 3, 4, 5, 6}; vector bvec{false, true, false, false, false, true}; for (auto&& i : compress(ivec, bvec) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -662,10 +677,10 @@ sorted Allows iteration over a sequence in sorted order. `sorted` does **not** produce a new sequence, copy elements, or modify the original -sequence. It only provides a way to iterate over existing elements. +sequence. It only provides a way to iterate over existing elements. `sorted` also takes an optional second [comparator](http://en.cppreference.com/w/cpp/concept/Compare) -argument. If not provided, defaults to `std::less`.
+argument. If not provided, defaults to `std::less`.
Iterables passed to sorted are required to have an iterator with an `operator*() const` member. @@ -674,7 +689,7 @@ The below outputs `0 1 2 3 4`. ```c++ unordered_set nums{4, 0, 2, 1, 3}; for (auto&& i : sorted(nums)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -692,31 +707,31 @@ vector vec1{1,2,3,4,5,6}; array arr1{{7,8,9,10}}; for (auto&& i : chain(empty,vec1,arr1)) { - cout << i << '\n'; + cout << i << '\n'; } ``` chain.from\_iterable -------------------- - +-------------------- Similar to chain, but rather than taking a variadic number of iterables, it takes an iterable of iterables and chains the contained iterables together. A simple example is shown below using a vector of vectors to represent a 2d ragged array, and prints it in row-major order. + ```c++ vector> matrix = { - {1, 2, 3}, - {4, 5}, - {6, 8, 9, 10, 11, 12} + {1, 2, 3}, + {4, 5}, + {6, 8, 9, 10, 11, 12} }; for (auto&& i : chain.from_iterable(matrix)) { - cout << i << '\n'; + cout << i << '\n'; } ``` reversed -------- +-------- *Additional Requirements*: Input must be compatible with `std::rbegin()` and `std::rend()` @@ -724,7 +739,7 @@ Iterates over elements of a sequence in reverse order. ```c++ for (auto&& i : reversed(a)) { - cout << i << '\n'; + cout << i << '\n'; } ``` @@ -735,18 +750,19 @@ Returns selected elements from a range, parameters are start, stop and step. the range returned is [start,stop) where you only take every step element This outputs `0 3 6 9 12` + ```c++ vector a{0,1,2,3,4,5,6,7,8,9,10,11,12,13}; for (auto&& i : slice(a,0,15,3)) { - cout << i << '\n'; + cout << i << '\n'; } ``` sliding\_window -------------- +--------------- *Additional Requirements*: Input must have a ForwardIterator -Takes a section from a range and increments the whole section. If the +Takes a section from a range and increments the whole section. If the window size is larger than the length of the input, the `sliding_window` will yield nothing (begin == end). @@ -764,60 +780,65 @@ take a section of size 4, output is: ``` Example Usage: + ```c++ vector v = {1,2,3,4,5,6,7,8,9}; for (auto&& sec : sliding_window(v,4)) { - for (auto&& i : sec) { - cout << i << ' '; - i.get() = 90; - } - cout << '\n'; + for (auto&& i : sec) { + cout << i << ' '; + i.get() = 90; + } + cout << '\n'; } ``` -chunked ------- +chunked +------- chunked will yield subsequent chunks of an iterable in blocks of a specified size. The final chunk may be shorter than the rest if the chunk size given does not evenly divide the length of the iterable. Example usage: + ```c++ vector v {1,2,3,4,5,6,7,8,9}; for (auto&& sec : chunked(v,4)) { - for (auto&& i : sec) { - cout << i << ' '; - } - cout << '\n'; + for (auto&& i : sec) { + cout << i << ' '; + } + cout << '\n'; } ``` The above prints: + ``` 1 2 3 4 5 6 7 8 9 ``` + batched ------- - batched will yield a given number N of batches containing subsequent elements from an iterable, assuming the iterable contains at least N elements. The size of each batch is immaterial, but the implementation guarantees that no two batches will differ in size by more than 1. Example usage: + ```c++ vector v {1,2,3,4,5,6,7,8,9}; for (auto&& sec : batched(v,4)) { - for (auto&& i : sec) { - cout << i << ' '; - } - cout << '\n'; + for (auto&& i : sec) { + cout << i << ' '; + } + cout << '\n'; } ``` The above prints: + ``` 1 2 3 4 5 @@ -826,54 +847,60 @@ The above prints: ``` product ------- +------- *Additional Requirements*: Input must have a ForwardIterator Generates the cartesian product of the given ranges put together. Example usage: + ```c++ vector v1{1,2,3}; vector v2{7,8}; vector v3{"the","cat"}; vector v4{"hi","what's","up","dude"}; for (auto&& [a, b, c, d] : product(v1,v2,v3,v4)) { - cout << a << ", " << b << ", " << c << ", " << d << '\n'; + cout << a << ", " << b << ", " << c << ", " << d << '\n'; } ``` -Product also accepts a "repeat" as a template argument. Currently this is the only way to do repeats. **If you are reading this and need `product(seq, 3)` instead of `product<3>(seq)` please open an issue**. +Product also accepts a "repeat" as a template argument. Currently this is the +only way to do repeats. **If you are reading this and need `product(seq, 3)` +instead of `product<3>(seq)` please open an issue**. Example usage: + ```c++ std::string s = "abc"; // equivalent of product(s, s, s); for (auto&& t : product<3>(s)) { - // ... + // ... } ``` combinations ------------ +------------ *Additional Requirements*: Input must have a ForwardIterator Generates n length unique sequences of the input range. Example usage: + ```c++ vector v = {1,2,3,4,5}; for (auto&& i : combinations(v,3)) { - for (auto&& j : i ) cout << j << " "; - cout << '\n'; + for (auto&& j : i ) cout << j << " "; + cout << '\n'; } ``` combinations\_with\_replacement ------------------------------ +------------------------------- *Additional Requirements*: Input must have a ForwardIterator -Like combinations, but with replacement of each element. The +Like combinations, but with replacement of each element. The below is printed by the loop that follows: + ``` {A, A} {A, B} @@ -882,43 +909,46 @@ below is printed by the loop that follows: {B, C} {C, C} ``` + ```c++ for (auto&& v : combinations_with_replacement(s, 2)) { - cout << '{' << v[0] << ", " << v[1] << "}\n"; + cout << '{' << v[0] << ", " << v[1] << "}\n"; } ``` permutations ------------ -*Additional Requirements*: Input must have a ForwardIterator. Iterator must +------------ +*Additional Requirements*: Input must have a ForwardIterator. Iterator must have an `operator*() const`. Generates all the permutations of a range using `std::next_permutation`. Example usage: + ```c++ vector v = {1,2,3,4,5}; for (auto&& vec : permutations(v)) { - for (auto&& i : vec) { - cout << i << ' '; - } - cout << '\n'; + for (auto&& i : vec) { + cout << i << ' '; + } + cout << '\n'; } ``` powerset -------- +-------- *Additional Requirements*: Input must have a ForwardIterator Generates every possible subset of a set, runs in O(2^n). Example usage: + ```c++ vector vec {1,2,3,4,5,6,7,8,9}; for (auto&& v : powerset(vec)) { - for (auto&& i : v) { - cout << i << " "; - } - cout << '\n'; + for (auto&& i : v) { + cout << i << " "; + } + cout << '\n'; } ```