xref: /llvm-project/libcxx/include/__cxx03/__algorithm/ranges_minmax.h (revision ce7771902dc50d900de639d499a60486b83f70e0)
1e78f53d1SNikolas Klauser //===----------------------------------------------------------------------===//
2e78f53d1SNikolas Klauser //
3e78f53d1SNikolas Klauser // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4e78f53d1SNikolas Klauser // See https://llvm.org/LICENSE.txt for license information.
5e78f53d1SNikolas Klauser // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e78f53d1SNikolas Klauser //
7e78f53d1SNikolas Klauser //===----------------------------------------------------------------------===//
8e78f53d1SNikolas Klauser 
9*ce777190SNikolas Klauser #ifndef _LIBCPP___CXX03___ALGORITHM_RANGES_MINMAX_H
10*ce777190SNikolas Klauser #define _LIBCPP___CXX03___ALGORITHM_RANGES_MINMAX_H
11e78f53d1SNikolas Klauser 
1273fbae83SNikolas Klauser #include <__cxx03/__algorithm/min_max_result.h>
1373fbae83SNikolas Klauser #include <__cxx03/__algorithm/minmax_element.h>
1473fbae83SNikolas Klauser #include <__cxx03/__assert>
1573fbae83SNikolas Klauser #include <__cxx03/__concepts/copyable.h>
1673fbae83SNikolas Klauser #include <__cxx03/__concepts/same_as.h>
1773fbae83SNikolas Klauser #include <__cxx03/__config>
1873fbae83SNikolas Klauser #include <__cxx03/__functional/identity.h>
1973fbae83SNikolas Klauser #include <__cxx03/__functional/invoke.h>
2073fbae83SNikolas Klauser #include <__cxx03/__functional/ranges_operations.h>
2173fbae83SNikolas Klauser #include <__cxx03/__iterator/concepts.h>
2273fbae83SNikolas Klauser #include <__cxx03/__iterator/next.h>
2373fbae83SNikolas Klauser #include <__cxx03/__iterator/projected.h>
2473fbae83SNikolas Klauser #include <__cxx03/__ranges/access.h>
2573fbae83SNikolas Klauser #include <__cxx03/__ranges/concepts.h>
2673fbae83SNikolas Klauser #include <__cxx03/__type_traits/desugars_to.h>
2773fbae83SNikolas Klauser #include <__cxx03/__type_traits/is_reference.h>
2873fbae83SNikolas Klauser #include <__cxx03/__type_traits/is_trivially_copyable.h>
2973fbae83SNikolas Klauser #include <__cxx03/__type_traits/remove_cvref.h>
3073fbae83SNikolas Klauser #include <__cxx03/__utility/forward.h>
3173fbae83SNikolas Klauser #include <__cxx03/__utility/move.h>
3273fbae83SNikolas Klauser #include <__cxx03/__utility/pair.h>
3373fbae83SNikolas Klauser #include <__cxx03/initializer_list>
34e78f53d1SNikolas Klauser 
35e78f53d1SNikolas Klauser #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
36e78f53d1SNikolas Klauser #  pragma GCC system_header
37e78f53d1SNikolas Klauser #endif
38e78f53d1SNikolas Klauser 
39e78f53d1SNikolas Klauser #if _LIBCPP_STD_VER >= 20
40e78f53d1SNikolas Klauser 
41e78f53d1SNikolas Klauser _LIBCPP_PUSH_MACROS
4273fbae83SNikolas Klauser #  include <__cxx03/__undef_macros>
43e78f53d1SNikolas Klauser 
44e78f53d1SNikolas Klauser _LIBCPP_BEGIN_NAMESPACE_STD
45e78f53d1SNikolas Klauser 
46e78f53d1SNikolas Klauser namespace ranges {
47e78f53d1SNikolas Klauser template <class _T1>
48e78f53d1SNikolas Klauser using minmax_result = min_max_result<_T1>;
49e78f53d1SNikolas Klauser 
50e78f53d1SNikolas Klauser namespace __minmax {
51e78f53d1SNikolas Klauser struct __fn {
52e78f53d1SNikolas Klauser   template <class _Type,
53e78f53d1SNikolas Klauser             class _Proj                                                      = identity,
54e78f53d1SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
55e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<const _Type&>
56e78f53d1SNikolas Klauser   operator()(_LIBCPP_LIFETIMEBOUND const _Type& __a,
57e78f53d1SNikolas Klauser              _LIBCPP_LIFETIMEBOUND const _Type& __b,
58e78f53d1SNikolas Klauser              _Comp __comp = {},
59e78f53d1SNikolas Klauser              _Proj __proj = {}) const {
60e78f53d1SNikolas Klauser     if (std::invoke(__comp, std::invoke(__proj, __b), std::invoke(__proj, __a)))
61e78f53d1SNikolas Klauser       return {__b, __a};
62e78f53d1SNikolas Klauser     return {__a, __b};
63e78f53d1SNikolas Klauser   }
64e78f53d1SNikolas Klauser 
65e78f53d1SNikolas Klauser   template <copyable _Type,
66e78f53d1SNikolas Klauser             class _Proj                                                      = identity,
67e78f53d1SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
68e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<_Type>
69e78f53d1SNikolas Klauser   operator()(initializer_list<_Type> __il, _Comp __comp = {}, _Proj __proj = {}) const {
70e78f53d1SNikolas Klauser     _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(
71e78f53d1SNikolas Klauser         __il.begin() != __il.end(), "initializer_list has to contain at least one element");
72e78f53d1SNikolas Klauser     auto __iters = std::__minmax_element_impl(__il.begin(), __il.end(), __comp, __proj);
73e78f53d1SNikolas Klauser     return ranges::minmax_result<_Type>{*__iters.first, *__iters.second};
74e78f53d1SNikolas Klauser   }
75e78f53d1SNikolas Klauser 
76e78f53d1SNikolas Klauser   template <input_range _Range,
77e78f53d1SNikolas Klauser             class _Proj                                                            = identity,
78e78f53d1SNikolas Klauser             indirect_strict_weak_order<projected<iterator_t<_Range>, _Proj>> _Comp = ranges::less>
79e78f53d1SNikolas Klauser     requires indirectly_copyable_storable<iterator_t<_Range>, range_value_t<_Range>*>
80e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<range_value_t<_Range>>
81e78f53d1SNikolas Klauser   operator()(_Range&& __r, _Comp __comp = {}, _Proj __proj = {}) const {
82e78f53d1SNikolas Klauser     auto __first  = ranges::begin(__r);
83e78f53d1SNikolas Klauser     auto __last   = ranges::end(__r);
84e78f53d1SNikolas Klauser     using _ValueT = range_value_t<_Range>;
85e78f53d1SNikolas Klauser 
86e78f53d1SNikolas Klauser     _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(__first != __last, "range has to contain at least one element");
87e78f53d1SNikolas Klauser 
88e78f53d1SNikolas Klauser     // This optimiation is not in minmax_element because clang doesn't see through the pointers and as a result doesn't
89e78f53d1SNikolas Klauser     // vectorize the code.
90e78f53d1SNikolas Klauser     if constexpr (contiguous_range<_Range> && is_integral_v<_ValueT> &&
91e78f53d1SNikolas Klauser                   __is_cheap_to_copy<_ValueT> & __is_identity<_Proj>::value &&
92e78f53d1SNikolas Klauser                   __desugars_to_v<__less_tag, _Comp, _ValueT, _ValueT>) {
93e78f53d1SNikolas Klauser       minmax_result<_ValueT> __result = {__r[0], __r[0]};
94e78f53d1SNikolas Klauser       for (auto __e : __r) {
95e78f53d1SNikolas Klauser         if (__e < __result.min)
96e78f53d1SNikolas Klauser           __result.min = __e;
97e78f53d1SNikolas Klauser         if (__result.max < __e)
98e78f53d1SNikolas Klauser           __result.max = __e;
99e78f53d1SNikolas Klauser       }
100e78f53d1SNikolas Klauser       return __result;
101e78f53d1SNikolas Klauser     } else if constexpr (forward_range<_Range>) {
102e78f53d1SNikolas Klauser       // Special-case the one element case. Avoid repeatedly initializing objects from the result of an iterator
103e78f53d1SNikolas Klauser       // dereference when doing so might not be idempotent. The `if constexpr` avoids the extra branch in cases where
104e78f53d1SNikolas Klauser       // it's not needed.
105e78f53d1SNikolas Klauser       if constexpr (!same_as<remove_cvref_t<range_reference_t<_Range>>, _ValueT> ||
106e78f53d1SNikolas Klauser                     is_rvalue_reference_v<range_reference_t<_Range>>) {
107e78f53d1SNikolas Klauser         if (ranges::next(__first) == __last) {
108e78f53d1SNikolas Klauser           // During initialization, members are allowed to refer to already initialized members
109e78f53d1SNikolas Klauser           // (see http://eel.is/c++draft/dcl.init.aggr#6)
110e78f53d1SNikolas Klauser           minmax_result<_ValueT> __result = {*__first, __result.min};
111e78f53d1SNikolas Klauser           return __result;
112e78f53d1SNikolas Klauser         }
113e78f53d1SNikolas Klauser       }
114e78f53d1SNikolas Klauser       auto __result = std::__minmax_element_impl(__first, __last, __comp, __proj);
115e78f53d1SNikolas Klauser       return {*__result.first, *__result.second};
116e78f53d1SNikolas Klauser     } else {
117e78f53d1SNikolas Klauser       // input_iterators can't be copied, so the implementation for input_iterators has to store
118e78f53d1SNikolas Klauser       // the values instead of a pointer to the correct values
119e78f53d1SNikolas Klauser       auto __less = [&](auto&& __a, auto&& __b) -> bool {
120e78f53d1SNikolas Klauser         return std::invoke(__comp,
121e78f53d1SNikolas Klauser                            std::invoke(__proj, std::forward<decltype(__a)>(__a)),
122e78f53d1SNikolas Klauser                            std::invoke(__proj, std::forward<decltype(__b)>(__b)));
123e78f53d1SNikolas Klauser       };
124e78f53d1SNikolas Klauser 
125e78f53d1SNikolas Klauser       // During initialization, members are allowed to refer to already initialized members
126e78f53d1SNikolas Klauser       // (see http://eel.is/c++draft/dcl.init.aggr#6)
127e78f53d1SNikolas Klauser       ranges::minmax_result<_ValueT> __result = {*__first, __result.min};
128e78f53d1SNikolas Klauser       if (__first == __last || ++__first == __last)
129e78f53d1SNikolas Klauser         return __result;
130e78f53d1SNikolas Klauser 
131e78f53d1SNikolas Klauser       if (__less(*__first, __result.min))
132e78f53d1SNikolas Klauser         __result.min = *__first;
133e78f53d1SNikolas Klauser       else
134e78f53d1SNikolas Klauser         __result.max = *__first;
135e78f53d1SNikolas Klauser 
136e78f53d1SNikolas Klauser       while (++__first != __last) {
137e78f53d1SNikolas Klauser         _ValueT __i = *__first;
138e78f53d1SNikolas Klauser         if (++__first == __last) {
139e78f53d1SNikolas Klauser           if (__less(__i, __result.min))
140e78f53d1SNikolas Klauser             __result.min = __i;
141e78f53d1SNikolas Klauser           else if (!__less(__i, __result.max))
142e78f53d1SNikolas Klauser             __result.max = __i;
143e78f53d1SNikolas Klauser           return __result;
144e78f53d1SNikolas Klauser         }
145e78f53d1SNikolas Klauser 
146e78f53d1SNikolas Klauser         if (__less(*__first, __i)) {
147e78f53d1SNikolas Klauser           if (__less(*__first, __result.min))
148e78f53d1SNikolas Klauser             __result.min = *__first;
149e78f53d1SNikolas Klauser           if (!__less(__i, __result.max))
150e78f53d1SNikolas Klauser             __result.max = std::move(__i);
151e78f53d1SNikolas Klauser         } else {
152e78f53d1SNikolas Klauser           if (__less(__i, __result.min))
153e78f53d1SNikolas Klauser             __result.min = std::move(__i);
154e78f53d1SNikolas Klauser           if (!__less(*__first, __result.max))
155e78f53d1SNikolas Klauser             __result.max = *__first;
156e78f53d1SNikolas Klauser         }
157e78f53d1SNikolas Klauser       }
158e78f53d1SNikolas Klauser       return __result;
159e78f53d1SNikolas Klauser     }
160e78f53d1SNikolas Klauser   }
161e78f53d1SNikolas Klauser };
162e78f53d1SNikolas Klauser } // namespace __minmax
163e78f53d1SNikolas Klauser 
164e78f53d1SNikolas Klauser inline namespace __cpo {
165e78f53d1SNikolas Klauser inline constexpr auto minmax = __minmax::__fn{};
166e78f53d1SNikolas Klauser } // namespace __cpo
167e78f53d1SNikolas Klauser } // namespace ranges
168e78f53d1SNikolas Klauser 
169e78f53d1SNikolas Klauser _LIBCPP_END_NAMESPACE_STD
170e78f53d1SNikolas Klauser 
171e78f53d1SNikolas Klauser _LIBCPP_POP_MACROS
172e78f53d1SNikolas Klauser 
173e78f53d1SNikolas Klauser #endif // _LIBCPP_STD_VER >= 20
174e78f53d1SNikolas Klauser 
175*ce777190SNikolas Klauser #endif // _LIBCPP___CXX03___ALGORITHM_RANGES_MINMAX_H
176