xref: /llvm-project/libcxx/include/__algorithm/ranges_minmax.h (revision 0a0d58f5465a2524ec9ed10ed0bb277cab5a180c)
158d9ab70SNikolas Klauser //===----------------------------------------------------------------------===//
258d9ab70SNikolas Klauser //
358d9ab70SNikolas Klauser // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
458d9ab70SNikolas Klauser // See https://llvm.org/LICENSE.txt for license information.
558d9ab70SNikolas Klauser // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
658d9ab70SNikolas Klauser //
758d9ab70SNikolas Klauser //===----------------------------------------------------------------------===//
858d9ab70SNikolas Klauser 
958d9ab70SNikolas Klauser #ifndef _LIBCPP___ALGORITHM_RANGES_MINMAX_H
1058d9ab70SNikolas Klauser #define _LIBCPP___ALGORITHM_RANGES_MINMAX_H
1158d9ab70SNikolas Klauser 
1258d9ab70SNikolas Klauser #include <__algorithm/min_max_result.h>
1358d9ab70SNikolas Klauser #include <__algorithm/minmax_element.h>
1458d9ab70SNikolas Klauser #include <__assert>
1558d9ab70SNikolas Klauser #include <__concepts/copyable.h>
16*0a0d58f5SIgor Zhukov #include <__concepts/same_as.h>
1758d9ab70SNikolas Klauser #include <__config>
1858d9ab70SNikolas Klauser #include <__functional/identity.h>
1958d9ab70SNikolas Klauser #include <__functional/invoke.h>
2058d9ab70SNikolas Klauser #include <__functional/ranges_operations.h>
2158d9ab70SNikolas Klauser #include <__iterator/concepts.h>
22*0a0d58f5SIgor Zhukov #include <__iterator/next.h>
2358d9ab70SNikolas Klauser #include <__iterator/projected.h>
2458d9ab70SNikolas Klauser #include <__ranges/access.h>
2558d9ab70SNikolas Klauser #include <__ranges/concepts.h>
2658d9ab70SNikolas Klauser #include <__utility/forward.h>
2758d9ab70SNikolas Klauser #include <__utility/move.h>
28d5e26775SNikolas Klauser #include <__utility/pair.h>
2958d9ab70SNikolas Klauser #include <initializer_list>
3058d9ab70SNikolas Klauser 
3158d9ab70SNikolas Klauser #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
3258d9ab70SNikolas Klauser #  pragma GCC system_header
3358d9ab70SNikolas Klauser #endif
3458d9ab70SNikolas Klauser 
35b8cb1dc9SLouis Dionne #if _LIBCPP_STD_VER > 17
3658d9ab70SNikolas Klauser 
37a2c16032SLouis Dionne _LIBCPP_PUSH_MACROS
38a2c16032SLouis Dionne #include <__undef_macros>
39a2c16032SLouis Dionne 
4058d9ab70SNikolas Klauser _LIBCPP_BEGIN_NAMESPACE_STD
4158d9ab70SNikolas Klauser 
4258d9ab70SNikolas Klauser namespace ranges {
4358d9ab70SNikolas Klauser template <class _T1>
4458d9ab70SNikolas Klauser using minmax_result = min_max_result<_T1>;
4558d9ab70SNikolas Klauser 
4658d9ab70SNikolas Klauser namespace __minmax {
4758d9ab70SNikolas Klauser struct __fn {
4858d9ab70SNikolas Klauser   template <class _Type, class _Proj = identity,
4958d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
50660b2431SNikolas Klauser   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<const _Type&>
51934650b2SNikolas Klauser   operator()(_LIBCPP_LIFETIMEBOUND const _Type& __a,
52934650b2SNikolas Klauser              _LIBCPP_LIFETIMEBOUND const _Type& __b,
53934650b2SNikolas Klauser              _Comp __comp = {},
54934650b2SNikolas Klauser              _Proj __proj = {}) const {
5558d9ab70SNikolas Klauser     if (std::invoke(__comp, std::invoke(__proj, __b), std::invoke(__proj, __a)))
5658d9ab70SNikolas Klauser       return {__b, __a};
5758d9ab70SNikolas Klauser     return {__a, __b};
5858d9ab70SNikolas Klauser   }
5958d9ab70SNikolas Klauser 
6058d9ab70SNikolas Klauser   template <copyable _Type, class _Proj = identity,
6158d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
62660b2431SNikolas Klauser   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr
6358d9ab70SNikolas Klauser   ranges::minmax_result<_Type> operator()(initializer_list<_Type> __il, _Comp __comp = {}, _Proj __proj = {}) const {
6458d9ab70SNikolas Klauser     _LIBCPP_ASSERT(__il.begin() != __il.end(), "initializer_list has to contain at least one element");
6558d9ab70SNikolas Klauser     auto __iters = std::__minmax_element_impl(__il.begin(), __il.end(), __comp, __proj);
6658d9ab70SNikolas Klauser     return ranges::minmax_result<_Type> { *__iters.first, *__iters.second };
6758d9ab70SNikolas Klauser   }
6858d9ab70SNikolas Klauser 
6958d9ab70SNikolas Klauser   template <input_range _Range, class _Proj = identity,
7058d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<iterator_t<_Range>, _Proj>> _Comp = ranges::less>
7158d9ab70SNikolas Klauser     requires indirectly_copyable_storable<iterator_t<_Range>, range_value_t<_Range>*>
72660b2431SNikolas Klauser   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr
7358d9ab70SNikolas Klauser   ranges::minmax_result<range_value_t<_Range>> operator()(_Range&& __r, _Comp __comp = {}, _Proj __proj = {}) const {
7458d9ab70SNikolas Klauser     auto __first = ranges::begin(__r);
7558d9ab70SNikolas Klauser     auto __last = ranges::end(__r);
7658d9ab70SNikolas Klauser     using _ValueT = range_value_t<_Range>;
7758d9ab70SNikolas Klauser 
7858d9ab70SNikolas Klauser     _LIBCPP_ASSERT(__first != __last, "range has to contain at least one element");
7958d9ab70SNikolas Klauser 
8058d9ab70SNikolas Klauser     if constexpr (forward_range<_Range>) {
81*0a0d58f5SIgor Zhukov       // Special-case the one element case. Avoid repeatedly initializing objects from the result of an iterator
82*0a0d58f5SIgor Zhukov       // dereference when doing so might not be idempotent. The `if constexpr` avoids the extra branch in cases where
83*0a0d58f5SIgor Zhukov       // it's not needed.
84*0a0d58f5SIgor Zhukov       if constexpr (!same_as<remove_cvref_t<range_reference_t<_Range>>, _ValueT> ||
85*0a0d58f5SIgor Zhukov                     is_rvalue_reference_v<range_reference_t<_Range>>) {
86*0a0d58f5SIgor Zhukov         if (ranges::next(__first) == __last) {
87*0a0d58f5SIgor Zhukov           // During initialization, members are allowed to refer to already initialized members
88*0a0d58f5SIgor Zhukov           // (see http://eel.is/c++draft/dcl.init.aggr#6)
89*0a0d58f5SIgor Zhukov           minmax_result<_ValueT> __result = {*__first, __result.min};
90*0a0d58f5SIgor Zhukov           return __result;
91*0a0d58f5SIgor Zhukov         }
92*0a0d58f5SIgor Zhukov       }
9358d9ab70SNikolas Klauser       auto __result = std::__minmax_element_impl(__first, __last, __comp, __proj);
9458d9ab70SNikolas Klauser       return {*__result.first, *__result.second};
9558d9ab70SNikolas Klauser     } else {
9658d9ab70SNikolas Klauser       // input_iterators can't be copied, so the implementation for input_iterators has to store
9758d9ab70SNikolas Klauser       // the values instead of a pointer to the correct values
9858d9ab70SNikolas Klauser       auto __less = [&](auto&& __a, auto&& __b) -> bool {
9958d9ab70SNikolas Klauser         return std::invoke(__comp, std::invoke(__proj, std::forward<decltype(__a)>(__a)),
10058d9ab70SNikolas Klauser                                    std::invoke(__proj, std::forward<decltype(__b)>(__b)));
10158d9ab70SNikolas Klauser       };
10258d9ab70SNikolas Klauser 
103*0a0d58f5SIgor Zhukov       // During initialization, members are allowed to refer to already initialized members
104*0a0d58f5SIgor Zhukov       // (see http://eel.is/c++draft/dcl.init.aggr#6)
10558d9ab70SNikolas Klauser       ranges::minmax_result<_ValueT> __result = {*__first, __result.min};
10658d9ab70SNikolas Klauser       if (__first == __last || ++__first == __last)
10758d9ab70SNikolas Klauser         return __result;
10858d9ab70SNikolas Klauser 
10958d9ab70SNikolas Klauser       if (__less(*__first, __result.min))
11058d9ab70SNikolas Klauser         __result.min = *__first;
11158d9ab70SNikolas Klauser       else
11258d9ab70SNikolas Klauser         __result.max = *__first;
11358d9ab70SNikolas Klauser 
11458d9ab70SNikolas Klauser       while (++__first != __last) {
11558d9ab70SNikolas Klauser         _ValueT __i = *__first;
11658d9ab70SNikolas Klauser         if (++__first == __last) {
11758d9ab70SNikolas Klauser           if (__less(__i, __result.min))
11858d9ab70SNikolas Klauser             __result.min = __i;
11958d9ab70SNikolas Klauser           else if (!__less(__i, __result.max))
12058d9ab70SNikolas Klauser             __result.max = __i;
12158d9ab70SNikolas Klauser           return __result;
12258d9ab70SNikolas Klauser         }
12358d9ab70SNikolas Klauser 
12458d9ab70SNikolas Klauser         if (__less(*__first, __i)) {
12558d9ab70SNikolas Klauser           if (__less(*__first, __result.min))
12658d9ab70SNikolas Klauser             __result.min = *__first;
12758d9ab70SNikolas Klauser           if (!__less(__i, __result.max))
12858d9ab70SNikolas Klauser             __result.max = std::move(__i);
12958d9ab70SNikolas Klauser         } else {
13058d9ab70SNikolas Klauser           if (__less(__i, __result.min))
13158d9ab70SNikolas Klauser             __result.min = std::move(__i);
13258d9ab70SNikolas Klauser           if (!__less(*__first, __result.max))
13358d9ab70SNikolas Klauser             __result.max = *__first;
13458d9ab70SNikolas Klauser         }
13558d9ab70SNikolas Klauser       }
13658d9ab70SNikolas Klauser       return __result;
13758d9ab70SNikolas Klauser     }
13858d9ab70SNikolas Klauser   }
13958d9ab70SNikolas Klauser };
14058d9ab70SNikolas Klauser } // namespace __minmax
14158d9ab70SNikolas Klauser 
14258d9ab70SNikolas Klauser inline namespace __cpo {
14358d9ab70SNikolas Klauser   inline constexpr auto minmax = __minmax::__fn{};
14458d9ab70SNikolas Klauser } // namespace __cpo
14558d9ab70SNikolas Klauser } // namespace ranges
14658d9ab70SNikolas Klauser 
14758d9ab70SNikolas Klauser _LIBCPP_END_NAMESPACE_STD
14858d9ab70SNikolas Klauser 
149a2c16032SLouis Dionne _LIBCPP_POP_MACROS
150a2c16032SLouis Dionne 
151b8cb1dc9SLouis Dionne #endif // _LIBCPP_STD_VER > 17
15258d9ab70SNikolas Klauser 
15358d9ab70SNikolas Klauser #endif // _LIBCPP___ALGORITHM_RANGES_MINMAX_H
154