[libcxx-commits] [libcxx] 3b470d1 - [libc++][ranges] Implement ranges::min_element
Nikolas Klauser via libcxx-commits
libcxx-commits at lists.llvm.org
Fri Feb 11 08:20:34 PST 2022
Author: Nikolas Klauser
Date: 2022-02-11T17:20:27+01:00
New Revision: 3b470d1ce992407df81662c04cf0137850338af6
URL: https://github.com/llvm/llvm-project/commit/3b470d1ce992407df81662c04cf0137850338af6
DIFF: https://github.com/llvm/llvm-project/commit/3b470d1ce992407df81662c04cf0137850338af6.diff
LOG: [libc++][ranges] Implement ranges::min_element
Implement ranges::min_element
Reviewed By: Quuxplusone, Mordante, #libc
Spies: miscco, libcxx-commits, mgorny
Differential Revision: https://reviews.llvm.org/D117025
Added:
libcxx/include/__algorithm/ranges_min_element.h
libcxx/test/libcxx/diagnostics/detail.headers/algorithm/ranges_min_element.module.verify.cpp
libcxx/test/std/algorithms/alg.sorting/alg.min.max/ranges.min_element.pass.cpp
Modified:
libcxx/docs/Status/RangesAlgorithms.csv
libcxx/include/CMakeLists.txt
libcxx/include/algorithm
libcxx/include/module.modulemap
Removed:
################################################################################
diff --git a/libcxx/docs/Status/RangesAlgorithms.csv b/libcxx/docs/Status/RangesAlgorithms.csv
index 95940b4932b5f..d95c5bec71a2e 100644
--- a/libcxx/docs/Status/RangesAlgorithms.csv
+++ b/libcxx/docs/Status/RangesAlgorithms.csv
@@ -18,7 +18,7 @@ Search,binary_search,Christopher Di Bella,n/a,Not started
Search,min,Not assigned,n/a,Not started
Search,max,Not assigned,n/a,Not started
Search,minmax,Not assigned,n/a,Not started
-Search,min_element,Not assigned,n/a,Not started
+Search,min_element,Nikolas Klauser,n/a,Complete
Search,max_element,Not assigned,n/a,Not started
Search,minmax_element,Not assigned,n/a,Not started
Search,count,Not assigned,n/a,Not started
diff --git a/libcxx/include/CMakeLists.txt b/libcxx/include/CMakeLists.txt
index 39f2721ad943f..f2a85c717f843 100644
--- a/libcxx/include/CMakeLists.txt
+++ b/libcxx/include/CMakeLists.txt
@@ -64,6 +64,7 @@ set(files
__algorithm/pop_heap.h
__algorithm/prev_permutation.h
__algorithm/push_heap.h
+ __algorithm/ranges_min_element.h
__algorithm/ranges_swap_ranges.h
__algorithm/remove.h
__algorithm/remove_copy.h
diff --git a/libcxx/include/__algorithm/ranges_min_element.h b/libcxx/include/__algorithm/ranges_min_element.h
new file mode 100644
index 0000000000000..2af503dabf474
--- /dev/null
+++ b/libcxx/include/__algorithm/ranges_min_element.h
@@ -0,0 +1,72 @@
+//===----------------------------------------------------------------------===//
+//
+// 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___ALGORITHM_RANGES_MIN_ELEMENT_H
+#define _LIBCPP___ALGORITHM_RANGES_MIN_ELEMENT_H
+
+#include <__config>
+#include <__functional/identity.h>
+#include <__functional/invoke.h>
+#include <__functional/ranges_operations.h>
+#include <__iterator/concepts.h>
+#include <__iterator/projected.h>
+#include <__ranges/access.h>
+#include <__ranges/concepts.h>
+#include <__ranges/dangling.h>
+#include <__utility/forward.h>
+
+#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
+# pragma GCC system_header
+#endif
+
+#ifndef _LIBCPP_HAS_NO_CONCEPTS
+
+_LIBCPP_BEGIN_NAMESPACE_STD
+
+namespace ranges {
+namespace __min_element {
+struct __fn {
+ template <class _Ip, class _Sp, class _Proj, class _Comp>
+ _LIBCPP_HIDE_FROM_ABI static constexpr
+ _Ip __go(_Ip __first, _Sp __last, _Comp& __comp, _Proj& __proj) {
+ if (__first == __last)
+ return __first;
+
+ _Ip __i = __first;
+ while (++__i != __last)
+ if (std::invoke(__comp, std::invoke(__proj, *__i), std::invoke(__proj, *__first)))
+ __first = __i;
+ return __first;
+ }
+
+ template <forward_iterator _Ip, sentinel_for<_Ip> _Sp, class _Proj = identity,
+ indirect_strict_weak_order<projected<_Ip, _Proj>> _Comp = ranges::less>
+ _LIBCPP_HIDE_FROM_ABI constexpr
+ _Ip operator()(_Ip __first, _Sp __last, _Comp __comp = {}, _Proj __proj = {}) const {
+ return __go(__first, __last, __comp, __proj);
+ }
+
+ template <forward_range _Rp, class _Proj = identity,
+ indirect_strict_weak_order<projected<iterator_t<_Rp>, _Proj>> _Comp = ranges::less>
+ _LIBCPP_HIDE_FROM_ABI constexpr
+ borrowed_iterator_t<_Rp> operator()(_Rp&& __r, _Comp __comp = {}, _Proj __proj = {}) const {
+ return __go(ranges::begin(__r), ranges::end(__r), __comp, __proj);
+ }
+};
+} // namespace __min_element
+
+inline namespace __cpo {
+ inline constexpr auto min_element = __min_element::__fn{};
+} // namespace __cpo
+} // namespace ranges
+
+_LIBCPP_END_NAMESPACE_STD
+
+#endif // _LIBCPP_HAS_NO_RANGES
+
+#endif // _LIBCPP___ALGORITHM_RANGES_MIN_ELEMENT_H
diff --git a/libcxx/include/algorithm b/libcxx/include/algorithm
index be10e3065f2f0..b35ad674cbe77 100644
--- a/libcxx/include/algorithm
+++ b/libcxx/include/algorithm
@@ -31,8 +31,13 @@ namespace ranges {
template <class I, class O1, class O2>
struct in_out_out_result; // since C++20
- template<class I, class O>
- struct in_out_result; // since C++20
+ template<forward_iterator I, sentinel_for<I> S, class Proj = identity,
+ indirect_strict_weak_order<projected<I, Proj>> Comp = ranges::less> // since C++20
+ constexpr I min_element(I first, S last, Comp comp = {}, Proj proj = {});
+
+ template<forward_range R, class Proj = identity,
+ indirect_strict_weak_order<projected<iterator_t<R>, Proj>> Comp = ranges::less> // since C++20
+ constexpr borrowed_iterator_t<R> min_element(R&& r, Comp comp = {}, Proj proj = {});
}
template <class InputIterator, class Predicate>
@@ -749,6 +754,7 @@ template <class BidirectionalIterator, class Compare>
#include <__algorithm/pop_heap.h>
#include <__algorithm/prev_permutation.h>
#include <__algorithm/push_heap.h>
+#include <__algorithm/ranges_min_element.h>
#include <__algorithm/ranges_swap_ranges.h>
#include <__algorithm/remove.h>
#include <__algorithm/remove_copy.h>
diff --git a/libcxx/include/module.modulemap b/libcxx/include/module.modulemap
index 35e57be809fdf..5c21e5dba4b27 100644
--- a/libcxx/include/module.modulemap
+++ b/libcxx/include/module.modulemap
@@ -285,6 +285,7 @@ module std [system] {
module pop_heap { private header "__algorithm/pop_heap.h" }
module prev_permutation { private header "__algorithm/prev_permutation.h" }
module push_heap { private header "__algorithm/push_heap.h" }
+ module ranges_min_element { private header "__algorithm/ranges_min_element.h" }
module ranges_swap_ranges { private header "__algorithm/ranges_swap_ranges.h" }
module remove { private header "__algorithm/remove.h" }
module remove_copy { private header "__algorithm/remove_copy.h" }
diff --git a/libcxx/test/libcxx/diagnostics/detail.headers/algorithm/ranges_min_element.module.verify.cpp b/libcxx/test/libcxx/diagnostics/detail.headers/algorithm/ranges_min_element.module.verify.cpp
new file mode 100644
index 0000000000000..0b10fb5f5e8ee
--- /dev/null
+++ b/libcxx/test/libcxx/diagnostics/detail.headers/algorithm/ranges_min_element.module.verify.cpp
@@ -0,0 +1,15 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+// REQUIRES: modules-build
+
+// WARNING: This test was generated by 'generate_private_header_tests.py'
+// and should not be edited manually.
+
+// expected-error@*:* {{use of private header from outside its module: '__algorithm/ranges_min_element.h'}}
+#include <__algorithm/ranges_min_element.h>
diff --git a/libcxx/test/std/algorithms/alg.sorting/alg.min.max/ranges.min_element.pass.cpp b/libcxx/test/std/algorithms/alg.sorting/alg.min.max/ranges.min_element.pass.cpp
new file mode 100644
index 0000000000000..e9dcd252577cd
--- /dev/null
+++ b/libcxx/test/std/algorithms/alg.sorting/alg.min.max/ranges.min_element.pass.cpp
@@ -0,0 +1,194 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+// <algorithm>
+
+// UNSUPPORTED: c++03, c++11, c++14, c++17
+// UNSUPPORTED: libcpp-no-concepts
+// UNSUPPORTED: libcpp-has-no-incomplete-ranges
+
+// template<forward_iterator I, sentinel_for<I> S, class Proj = identity,
+// indirect_strict_weak_order<projected<I, Proj>> Comp = ranges::less>
+// constexpr I ranges::min_element(I first, S last, Comp comp = {}, Proj proj = {});
+//
+// template<forward_range R, class Proj = identity,
+// indirect_strict_weak_order<projected<iterator_t<R>, Proj>> Comp = ranges::less>
+// constexpr borrowed_iterator_t<R> ranges::min_element(R&& r, Comp comp = {}, Proj proj = {});
+
+#include <algorithm>
+#include <array>
+#include <cassert>
+#include <random>
+#include <ranges>
+
+#include "test_macros.h"
+#include "test_iterators.h"
+
+template <class T>
+concept HasMinElement = requires (T t) { std::ranges::min_element(t); };
+
+struct NoLessThanOp {};
+struct NotTotallyOrdered {
+ int i;
+ bool operator<(const NotTotallyOrdered& o) const { return i < o.i; }
+};
+
+static_assert(HasMinElement<std::array<int, 0>>);
+static_assert(!HasMinElement<int>);
+static_assert(!HasMinElement<NoLessThanOp>);
+static_assert(!HasMinElement<NotTotallyOrdered>);
+
+template <class Iter>
+constexpr void test_iterators(Iter first, Iter last) {
+ std::same_as<Iter> auto it = std::ranges::min_element(first, last);
+ if (first != last) {
+ for (Iter j = first; j != last; ++j)
+ assert(!(*j < *it));
+ } else {
+ assert(it == first);
+ }
+}
+
+template <class Range, class Iter>
+constexpr void test_range(Range&& rng, Iter begin, Iter end) {
+ std::same_as<Iter> auto it = std::ranges::min_element(std::forward<Range>(rng));
+ if (begin != end) {
+ for (Iter j = begin; j != end; ++j)
+ assert(!(*j < *it));
+ } else {
+ assert(it == begin);
+ }
+}
+
+template <class It>
+constexpr void test(std::initializer_list<int> a, int expected) {
+ const int* first = a.begin();
+ const int* last = a.end();
+ {
+ std::same_as<It> auto it = std::ranges::min_element(It(first), It(last));
+ assert(base(it) == first + expected);
+ }
+ {
+ using Sent = sentinel_wrapper<It>;
+ std::same_as<It> auto it = std::ranges::min_element(It(first), Sent(It(last)));
+ assert(base(it) == first + expected);
+ }
+ {
+ auto range = std::ranges::subrange(It(first), It(last));
+ std::same_as<It> auto it = std::ranges::min_element(range);
+ assert(base(it) == first + expected);
+ }
+ {
+ using Sent = sentinel_wrapper<It>;
+ auto range = std::ranges::subrange(It(first), Sent(It(last)));
+ std::same_as<It> auto it = std::ranges::min_element(range);
+ assert(base(it) == first + expected);
+ }
+}
+
+template <class It>
+constexpr bool test() {
+ test<It>({}, 0);
+ test<It>({1}, 0);
+ test<It>({1, 2}, 0);
+ test<It>({2, 1}, 1);
+ test<It>({2, 1, 2}, 1);
+ test<It>({2, 1, 1}, 1);
+
+ return true;
+}
+
+constexpr void test_borrowed_range_and_sentinel() {
+ int a[] = {7, 6, 1, 3, 5, 1, 2, 4};
+
+ int* ret = std::ranges::min_element(std::views::all(a));
+ assert(ret == a + 2);
+ assert(*ret == 1);
+}
+
+constexpr void test_comparator() {
+ int a[] = {7, 6, 9, 3, 5, 1, 2, 4};
+ int* ret = std::ranges::min_element(a, std::ranges::greater{});
+ assert(ret == a + 2);
+ assert(*ret == 9);
+}
+
+constexpr void test_projection() {
+ int a[] = {7, 6, 9, 3, 5, 1, 2, 4};
+ {
+ int* ret = std::ranges::min_element(a, std::ranges::less{}, [](int i) { return i == 5 ? -100 : i; });
+ assert(ret == a + 4);
+ assert(*ret == 5);
+ }
+ {
+ int* ret = std::ranges::min_element(a, std::less<int*>{}, [](int& i) { return &i; });
+ assert(ret == a);
+ assert(*ret == 7);
+ }
+}
+
+struct Immobile {
+ int i;
+
+ constexpr Immobile(int i_) : i(i_) {}
+ Immobile(const Immobile&) = delete;
+ Immobile(Immobile&&) = delete;
+
+ auto operator<=>(const Immobile&) const = default;
+};
+
+constexpr void test_immobile() {
+
+ Immobile arr[] {1, 2, 3};
+ assert(std::ranges::min_element(arr) == arr);
+ assert(std::ranges::min_element(arr, arr + 3) == arr);
+}
+
+constexpr void test_dangling() {
+ int compares = 0;
+ int projections = 0;
+ auto comparator = [&](int a, int b) {
+ ++compares;
+ return a < b;
+ };
+ auto projection = [&](int a) {
+ ++projections;
+ return a;
+ };
+ [[maybe_unused]] std::same_as<std::ranges::dangling> auto ret =
+ std::ranges::min_element(std::array{1, 2, 3}, comparator, projection);
+ assert(compares == 2);
+ assert(projections == 4);
+}
+
+constexpr bool test() {
+
+ test<forward_iterator<const int*>>();
+ test<bidirectional_iterator<const int*>>();
+ test<random_access_iterator<const int*>>();
+ test<const int*>();
+
+ int a[] = {7, 6, 5, 3, 4, 2, 1, 8};
+ test_iterators(a, a + 8);
+ int a2[] = {7, 6, 5, 3, 4, 2, 1, 8};
+ test_range(a2, a2, a2 + 8);
+
+ test_borrowed_range_and_sentinel();
+ test_comparator();
+ test_projection();
+ test_dangling();
+
+ return true;
+}
+
+int main(int, char**) {
+ test();
+ static_assert(test());
+
+ return 0;
+}
More information about the libcxx-commits
mailing list