diff --git a/libcxx/docs/ReleaseNotes/21.rst b/libcxx/docs/ReleaseNotes/21.rst index c52bc54f412bd..08b32bb508dc1 100644 --- a/libcxx/docs/ReleaseNotes/21.rst +++ b/libcxx/docs/ReleaseNotes/21.rst @@ -81,6 +81,9 @@ Improvements and New Features - The ``bitset::to_string`` function has been optimized, resulting in a performance improvement of up to 8.3x for bitsets with uniformly distributed zeros and ones, and up to 13.5x and 16.1x for sparse and dense bitsets, respectively. +- The ``flat_map::insert`` and ``flat_set::insert_range`` have been optimized, resulting in a performance improvement of up + to 10x for inserting elements into a ``flat_map`` when the input range is a ``flat_map`` or a ``zip_view``. + Deprecations and Removals ------------------------- diff --git a/libcxx/include/CMakeLists.txt b/libcxx/include/CMakeLists.txt index e386f31386b60..c334b25574305 100644 --- a/libcxx/include/CMakeLists.txt +++ b/libcxx/include/CMakeLists.txt @@ -498,6 +498,7 @@ set(files __iterator/ostreambuf_iterator.h __iterator/permutable.h __iterator/prev.h + __iterator/product_iterator.h __iterator/projected.h __iterator/ranges_iterator_traits.h __iterator/readable_traits.h diff --git a/libcxx/include/__flat_map/key_value_iterator.h b/libcxx/include/__flat_map/key_value_iterator.h index f163dfc28706d..d04a23d1f8606 100644 --- a/libcxx/include/__flat_map/key_value_iterator.h +++ b/libcxx/include/__flat_map/key_value_iterator.h @@ -13,9 +13,12 @@ #include <__compare/three_way_comparable.h> #include <__concepts/convertible_to.h> #include <__config> +#include <__cstddef/size_t.h> #include <__iterator/iterator_traits.h> +#include <__iterator/product_iterator.h> #include <__memory/addressof.h> #include <__type_traits/conditional.h> +#include <__utility/forward.h> #include <__utility/move.h> #include <__utility/pair.h> @@ -57,6 +60,8 @@ struct __key_value_iterator { template friend struct __key_value_iterator; + friend struct __product_iterator_traits<__key_value_iterator>; + public: using iterator_concept = random_access_iterator_tag; // `__key_value_iterator` only satisfy "Cpp17InputIterator" named requirements, because @@ -181,6 +186,29 @@ struct __key_value_iterator { } }; +template +struct __product_iterator_traits<__key_value_iterator<_Owner, _KeyContainer, _MappedContainer, _Const>> { + static constexpr size_t __size = 2; + + template + _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX26 static decltype(auto) __get_iterator_element(_Iter&& __it) + requires(_Nth <= 1) + { + if constexpr (_Nth == 0) { + return std::forward<_Iter>(__it).__key_iter_; + } else { + return std::forward<_Iter>(__it).__mapped_iter_; + } + } + + template + _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX26 static auto + __make_product_iterator(_KeyIter&& __key_iter, _MappedIter&& __mapped_iter) { + return __key_value_iterator<_Owner, _KeyContainer, _MappedContainer, _Const>( + std::forward<_KeyIter>(__key_iter), std::forward<_MappedIter>(__mapped_iter)); + } +}; + _LIBCPP_END_NAMESPACE_STD #endif // _LIBCPP_STD_VER >= 23 diff --git a/libcxx/include/__flat_map/utils.h b/libcxx/include/__flat_map/utils.h index 27687ae8de3bc..3a05c715660dc 100644 --- a/libcxx/include/__flat_map/utils.h +++ b/libcxx/include/__flat_map/utils.h @@ -11,6 +11,7 @@ #define _LIBCPP___FLAT_MAP_UTILS_H #include <__config> +#include <__iterator/product_iterator.h> #include <__type_traits/container_traits.h> #include <__utility/exception_guard.h> #include <__utility/forward.h> @@ -79,8 +80,6 @@ struct __flat_map_utils { return typename _Map::iterator(std::move(__key_it), std::move(__mapped_it)); } - // TODO: We could optimize this, see - // https://github.com/llvm/llvm-project/issues/108624 template _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX26 static typename _Map::size_type __append(_Map& __map, _InputIterator __first, _Sentinel __last) { @@ -93,6 +92,25 @@ struct __flat_map_utils { } return __num_appended; } + + template + _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX26 static typename _Map::size_type + __append(_Map& __map, _InputIterator __first, _InputIterator __last) + requires __is_product_iterator_of_size<_InputIterator, 2>::value + { + auto __s1 = __map.__containers_.keys.size(); + __map.__containers_.keys.insert( + __map.__containers_.keys.end(), + __product_iterator_traits<_InputIterator>::template __get_iterator_element<0>(__first), + __product_iterator_traits<_InputIterator>::template __get_iterator_element<0>(__last)); + + __map.__containers_.values.insert( + __map.__containers_.values.end(), + __product_iterator_traits<_InputIterator>::template __get_iterator_element<1>(__first), + __product_iterator_traits<_InputIterator>::template __get_iterator_element<1>(__last)); + + return __map.__containers_.keys.size() - __s1; + } }; _LIBCPP_END_NAMESPACE_STD diff --git a/libcxx/include/__iterator/product_iterator.h b/libcxx/include/__iterator/product_iterator.h new file mode 100644 index 0000000000000..1db673bafd337 --- /dev/null +++ b/libcxx/include/__iterator/product_iterator.h @@ -0,0 +1,76 @@ +//===----------------------------------------------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef _LIBCPP___ITERATOR_PRODUCT_ITERATOR_H +#define _LIBCPP___ITERATOR_PRODUCT_ITERATOR_H + +// Product iterators are iterators that contain two or more underlying iterators. +// +// For example, std::flat_map stores its data into two separate containers, and its iterator +// is a proxy over two separate underlying iterators. The concept of product iterators +// allows algorithms to operate over these underlying iterators separately, opening the +// door to various optimizations. +// +// If __product_iterator_traits can be instantiated, the following functions and associated types must be provided: +// - static constexpr size_t Traits::__size +// The number of underlying iterators inside the product iterator. +// +// - template +// static decltype(auto) Traits::__get_iterator_element(It&& __it) +// Returns the _Nth iterator element of the given product iterator. +// +// - template +// static _Iterator __make_product_iterator(_Iters&&...); +// Creates a product iterator from the given underlying iterators. + +#include <__config> +#include <__cstddef/size_t.h> +#include <__type_traits/enable_if.h> +#include <__type_traits/integral_constant.h> +#include <__utility/declval.h> + +#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER) +# pragma GCC system_header +#endif + +_LIBCPP_BEGIN_NAMESPACE_STD + +template +struct __product_iterator_traits; +/* exposition-only: +{ + static constexpr size_t __size = ...; + + template + static decltype(auto) __get_iterator_element(_Iter&&); + + template + static _Iterator __make_product_iterator(_Iters&&...); +}; +*/ + +template +struct __is_product_iterator : false_type {}; + +template +struct __is_product_iterator<_Tp, sizeof(__product_iterator_traits<_Tp>) * 0> : true_type {}; + +template +struct __is_product_iterator_of_size : false_type {}; + +template +struct __is_product_iterator_of_size<_Tp, _Size, __enable_if_t<__product_iterator_traits<_Tp>::__size == _Size> > + : true_type {}; + +template +using __product_iterator_element_t _LIBCPP_NODEBUG = + decltype(__product_iterator_traits<_Iterator>::template __get_iterator_element<_Nth>(std::declval<_Iterator>())); + +_LIBCPP_END_NAMESPACE_STD + +#endif // _LIBCPP___ITERATOR_PRODUCT_ITERATOR_H diff --git a/libcxx/include/__ranges/zip_view.h b/libcxx/include/__ranges/zip_view.h index 6d31f5ce0993c..e2a194efcfb4c 100644 --- a/libcxx/include/__ranges/zip_view.h +++ b/libcxx/include/__ranges/zip_view.h @@ -23,6 +23,7 @@ #include <__iterator/iter_move.h> #include <__iterator/iter_swap.h> #include <__iterator/iterator_traits.h> +#include <__iterator/product_iterator.h> #include <__ranges/access.h> #include <__ranges/all.h> #include <__ranges/concepts.h> @@ -251,6 +252,10 @@ class zip_view<_Views...>::__iterator : public __zip_view_iterator_category_base friend class zip_view<_Views...>; + static constexpr bool __is_zip_view_iterator = true; + + friend struct __product_iterator_traits<__iterator>; + public: using iterator_concept = decltype(ranges::__get_zip_view_iterator_tag<_Const, _Views...>()); using value_type = tuple>...>; @@ -468,6 +473,23 @@ inline constexpr auto zip = __zip::__fn{}; } // namespace views } // namespace ranges +template + requires _Iterator::__is_zip_view_iterator +struct __product_iterator_traits<_Iterator> { + static constexpr size_t __size = tuple_size().__current_)>::value; + + template + requires(_Nth < __size) + _LIBCPP_HIDE_FROM_ABI static constexpr decltype(auto) __get_iterator_element(_Iter&& __it) { + return std::get<_Nth>(std::forward<_Iter>(__it).__current_); + } + + template + _LIBCPP_HIDE_FROM_ABI static constexpr _Iterator __make_product_iterator(_Iters&&... __iters) { + return _Iterator(std::tuple(std::forward<_Iters>(__iters)...)); + } +}; + #endif // _LIBCPP_STD_VER >= 23 _LIBCPP_END_NAMESPACE_STD diff --git a/libcxx/include/module.modulemap.in b/libcxx/include/module.modulemap.in index adf80f2ac9acb..f878e15d70b1a 100644 --- a/libcxx/include/module.modulemap.in +++ b/libcxx/include/module.modulemap.in @@ -1522,6 +1522,7 @@ module std [system] { } module permutable { header "__iterator/permutable.h" } module prev { header "__iterator/prev.h" } + module product_iterator { header "__iterator/product_iterator.h" } module projected { header "__iterator/projected.h" } module ranges_iterator_traits { header "__iterator/ranges_iterator_traits.h" } module readable_traits { header "__iterator/readable_traits.h" } diff --git a/libcxx/test/benchmarks/containers/associative/associative_container_benchmarks.h b/libcxx/test/benchmarks/containers/associative/associative_container_benchmarks.h index fb4455c4aa9da..0e65f44fd483e 100644 --- a/libcxx/test/benchmarks/containers/associative/associative_container_benchmarks.h +++ b/libcxx/test/benchmarks/containers/associative/associative_container_benchmarks.h @@ -13,12 +13,14 @@ #include #include #include +#include #include #include #include #include "benchmark/benchmark.h" #include "../../GenerateInput.h" +#include "test_macros.h" namespace support { @@ -66,6 +68,8 @@ void associative_container_benchmarks(std::string container) { static constexpr bool is_ordered_container = requires(Container c, Key k) { c.lower_bound(k); }; + static constexpr bool is_map_like = requires { typename Container::mapped_type; }; + // These benchmarks are structured to perform the operation being benchmarked // a small number of times at each iteration, in order to offset the cost of // PauseTiming() and ResumeTiming(). @@ -321,6 +325,48 @@ void associative_container_benchmarks(std::string container) { } }); + if constexpr (is_map_like) { + bench("insert(iterator, iterator) (product_iterator from same type)", [=](auto& st) { + const std::size_t size = st.range(0); + std::vector in = make_value_types(generate_unique_keys(size + (size / 10))); + Container source(in.begin(), in.end()); + + Container c; + + for ([[maybe_unused]] auto _ : st) { + c.insert(source.begin(), source.end()); + benchmark::DoNotOptimize(c); + benchmark::ClobberMemory(); + + st.PauseTiming(); + c = Container(); + st.ResumeTiming(); + } + }); + +#if TEST_STD_VER >= 23 + bench("insert(iterator, iterator) (product_iterator from zip_view)", [=](auto& st) { + const std::size_t size = st.range(0); + std::vector keys = generate_unique_keys(size + (size / 10)); + std::sort(keys.begin(), keys.end()); + std::vector mapped(keys.size()); + + auto source = std::views::zip(keys, mapped); + + Container c; + + for ([[maybe_unused]] auto _ : st) { + c.insert(source.begin(), source.end()); + benchmark::DoNotOptimize(c); + benchmark::ClobberMemory(); + + st.PauseTiming(); + c = Container(); + st.ResumeTiming(); + } + }); +#endif + } ///////////////////////// // Erasure ///////////////////////// diff --git a/libcxx/test/benchmarks/containers/associative/flat_map.bench.cpp b/libcxx/test/benchmarks/containers/associative/flat_map.bench.cpp index 82902d50f31e6..f3b86554802ca 100644 --- a/libcxx/test/benchmarks/containers/associative/flat_map.bench.cpp +++ b/libcxx/test/benchmarks/containers/associative/flat_map.bench.cpp @@ -6,7 +6,7 @@ // //===----------------------------------------------------------------------===// -// REQUIRES: std-at-least-c++26 +// REQUIRES: std-at-least-c++23 #include #include diff --git a/libcxx/test/benchmarks/containers/associative/flat_multimap.bench.cpp b/libcxx/test/benchmarks/containers/associative/flat_multimap.bench.cpp index f752f79b3b454..80eaa549042c6 100644 --- a/libcxx/test/benchmarks/containers/associative/flat_multimap.bench.cpp +++ b/libcxx/test/benchmarks/containers/associative/flat_multimap.bench.cpp @@ -6,7 +6,7 @@ // //===----------------------------------------------------------------------===// -// REQUIRES: std-at-least-c++26 +// REQUIRES: std-at-least-c++23 #include diff --git a/libcxx/test/libcxx/iterators/product_iterator.pass.cpp b/libcxx/test/libcxx/iterators/product_iterator.pass.cpp new file mode 100644 index 0000000000000..604f3667c36e3 --- /dev/null +++ b/libcxx/test/libcxx/iterators/product_iterator.pass.cpp @@ -0,0 +1,66 @@ +//===----------------------------------------------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20 +// gcc 15 does not seem to recognize the __product_iterator_traits specializations +// UNSUPPORTED: gcc + +#include +#include +#include +#include +#include + +#include "test_macros.h" +#include "test_iterators.h" + +constexpr bool test() { + { + // Test that the __get_iterator_element can handle a non-copyable iterator + int Date[] = {1, 2, 3, 4}; + cpp20_input_iterator iter(Date); + sentinel_wrapper> sent{cpp20_input_iterator(Date + 4)}; + std::ranges::subrange r1(std::move(iter), std::move(sent)); + auto v = std::views::zip(std::move(r1), std::views::iota(0, 4)); + auto it = v.begin(); + + using Iter = decltype(it); + + static_assert(!std::is_copy_constructible_v); + + static_assert(std::__product_iterator_traits::__size == 2); + std::same_as&> decltype(auto) it1 = + std::__product_iterator_traits::__get_iterator_element<0>(it); + + assert(*it1 == 1); + } + if (!std::is_constant_evaluated()) { + // Test __make_product_iterator + using M = std::flat_map; + M m{{1, 1}, {2, 2}, {3, 3}}; + using Iter = std::ranges::iterator_t; + const auto& keys = m.keys(); + const auto& values = m.values(); + + auto it_keys = std::ranges::begin(keys); + auto it_values = std::ranges::begin(values); + + auto it = std::__product_iterator_traits::__make_product_iterator(it_keys, it_values); + assert(it->first == 1); + assert(it->second == 1); + } + + return true; +} + +int main(int, char**) { + test(); + static_assert(test()); + + return 0; +} diff --git a/libcxx/test/std/containers/container.adaptors/flat.map/flat.map.modifiers/insert_iter_iter.pass.cpp b/libcxx/test/std/containers/container.adaptors/flat.map/flat.map.modifiers/insert_iter_iter.pass.cpp index 66bd4022f321a..9bcdc9c1f2b9e 100644 --- a/libcxx/test/std/containers/container.adaptors/flat.map/flat.map.modifiers/insert_iter_iter.pass.cpp +++ b/libcxx/test/std/containers/container.adaptors/flat.map/flat.map.modifiers/insert_iter_iter.pass.cpp @@ -18,6 +18,7 @@ #include #include #include +#include #include "MinSequenceContainer.h" #include "../helpers.h" @@ -95,6 +96,26 @@ constexpr void test() { }); } +constexpr void test_product_iterator() { + using M = std::flat_map; + { + M m1{{1, 1}, {2, 1}, {3, 1}}; + M m2{{4, 1}, {5, 1}, {6, 1}}; + m1.insert(m2.begin(), m2.end()); + M expected{{1, 1}, {2, 1}, {3, 1}, {4, 1}, {5, 1}, {6, 1}}; + assert(m1 == expected); + } + { + std::vector keys{1, 2, 3}; + std::vector values{1, 1, 1}; + auto zv = std::views::zip(keys, values); + M m; + m.insert(zv.begin(), zv.end()); + M expected{{1, 1}, {2, 1}, {3, 1}}; + assert(m == expected); + } +} + constexpr bool test() { test, std::vector>(); #ifndef __cpp_lib_constexpr_deque @@ -105,7 +126,7 @@ constexpr bool test() { } test, MinSequenceContainer>(); test>, std::vector>>(); - + test_product_iterator(); if (!TEST_IS_CONSTANT_EVALUATED) { auto insert_func = [](auto& m, const auto& newValues) { m.insert(newValues.begin(), newValues.end()); }; test_insert_range_exception_guarantee(insert_func);