xref: /llvm-project/libcxx/include/__algorithm/ranges_minmax.h (revision 1638657dce0ca03c7d5cd9dfc23bf31485b4ac43)
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>
160a0d58f5SIgor 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>
220a0d58f5SIgor Zhukov #include <__iterator/next.h>
2358d9ab70SNikolas Klauser #include <__iterator/projected.h>
2458d9ab70SNikolas Klauser #include <__ranges/access.h>
2558d9ab70SNikolas Klauser #include <__ranges/concepts.h>
2679702f7fSIan Anderson #include <__type_traits/is_reference.h>
2779702f7fSIan Anderson #include <__type_traits/remove_cvref.h>
2858d9ab70SNikolas Klauser #include <__utility/forward.h>
2958d9ab70SNikolas Klauser #include <__utility/move.h>
30d5e26775SNikolas Klauser #include <__utility/pair.h>
3158d9ab70SNikolas Klauser #include <initializer_list>
3258d9ab70SNikolas Klauser 
3358d9ab70SNikolas Klauser #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
3458d9ab70SNikolas Klauser #  pragma GCC system_header
3558d9ab70SNikolas Klauser #endif
3658d9ab70SNikolas Klauser 
374f15267dSNikolas Klauser #if _LIBCPP_STD_VER >= 20
3858d9ab70SNikolas Klauser 
39a2c16032SLouis Dionne _LIBCPP_PUSH_MACROS
40a2c16032SLouis Dionne #  include <__undef_macros>
41a2c16032SLouis Dionne 
4258d9ab70SNikolas Klauser _LIBCPP_BEGIN_NAMESPACE_STD
4358d9ab70SNikolas Klauser 
4458d9ab70SNikolas Klauser namespace ranges {
4558d9ab70SNikolas Klauser template <class _T1>
4658d9ab70SNikolas Klauser using minmax_result = min_max_result<_T1>;
4758d9ab70SNikolas Klauser 
4858d9ab70SNikolas Klauser namespace __minmax {
4958d9ab70SNikolas Klauser struct __fn {
505aa03b64SLouis Dionne   template <class _Type,
515aa03b64SLouis Dionne             class _Proj                                                      = identity,
5258d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
53660b2431SNikolas Klauser   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<const _Type&>
54934650b2SNikolas Klauser   operator()(_LIBCPP_LIFETIMEBOUND const _Type& __a,
55934650b2SNikolas Klauser              _LIBCPP_LIFETIMEBOUND const _Type& __b,
56934650b2SNikolas Klauser              _Comp __comp = {},
57934650b2SNikolas Klauser              _Proj __proj = {}) const {
5858d9ab70SNikolas Klauser     if (std::invoke(__comp, std::invoke(__proj, __b), std::invoke(__proj, __a)))
5958d9ab70SNikolas Klauser       return {__b, __a};
6058d9ab70SNikolas Klauser     return {__a, __b};
6158d9ab70SNikolas Klauser   }
6258d9ab70SNikolas Klauser 
635aa03b64SLouis Dionne   template <copyable _Type,
645aa03b64SLouis Dionne             class _Proj                                                      = identity,
6558d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<const _Type*, _Proj>> _Comp = ranges::less>
665aa03b64SLouis Dionne   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<_Type>
675aa03b64SLouis Dionne   operator()(initializer_list<_Type> __il, _Comp __comp = {}, _Proj __proj = {}) const {
68*1638657dSKonstantin Varlamov     _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(
69*1638657dSKonstantin Varlamov         __il.begin() != __il.end(), "initializer_list has to contain at least one element");
7058d9ab70SNikolas Klauser     auto __iters = std::__minmax_element_impl(__il.begin(), __il.end(), __comp, __proj);
7158d9ab70SNikolas Klauser     return ranges::minmax_result<_Type>{*__iters.first, *__iters.second};
7258d9ab70SNikolas Klauser   }
7358d9ab70SNikolas Klauser 
745aa03b64SLouis Dionne   template <input_range _Range,
755aa03b64SLouis Dionne             class _Proj                                                            = identity,
7658d9ab70SNikolas Klauser             indirect_strict_weak_order<projected<iterator_t<_Range>, _Proj>> _Comp = ranges::less>
7758d9ab70SNikolas Klauser     requires indirectly_copyable_storable<iterator_t<_Range>, range_value_t<_Range>*>
785aa03b64SLouis Dionne   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr ranges::minmax_result<range_value_t<_Range>>
795aa03b64SLouis Dionne   operator()(_Range&& __r, _Comp __comp = {}, _Proj __proj = {}) const {
8058d9ab70SNikolas Klauser     auto __first  = ranges::begin(__r);
8158d9ab70SNikolas Klauser     auto __last   = ranges::end(__r);
8258d9ab70SNikolas Klauser     using _ValueT = range_value_t<_Range>;
8358d9ab70SNikolas Klauser 
84*1638657dSKonstantin Varlamov     _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(__first != __last, "range has to contain at least one element");
8558d9ab70SNikolas Klauser 
8658d9ab70SNikolas Klauser     if constexpr (forward_range<_Range>) {
870a0d58f5SIgor Zhukov       // Special-case the one element case. Avoid repeatedly initializing objects from the result of an iterator
880a0d58f5SIgor Zhukov       // dereference when doing so might not be idempotent. The `if constexpr` avoids the extra branch in cases where
890a0d58f5SIgor Zhukov       // it's not needed.
900a0d58f5SIgor Zhukov       if constexpr (!same_as<remove_cvref_t<range_reference_t<_Range>>, _ValueT> ||
910a0d58f5SIgor Zhukov                     is_rvalue_reference_v<range_reference_t<_Range>>) {
920a0d58f5SIgor Zhukov         if (ranges::next(__first) == __last) {
930a0d58f5SIgor Zhukov           // During initialization, members are allowed to refer to already initialized members
940a0d58f5SIgor Zhukov           // (see http://eel.is/c++draft/dcl.init.aggr#6)
950a0d58f5SIgor Zhukov           minmax_result<_ValueT> __result = {*__first, __result.min};
960a0d58f5SIgor Zhukov           return __result;
970a0d58f5SIgor Zhukov         }
980a0d58f5SIgor Zhukov       }
9958d9ab70SNikolas Klauser       auto __result = std::__minmax_element_impl(__first, __last, __comp, __proj);
10058d9ab70SNikolas Klauser       return {*__result.first, *__result.second};
10158d9ab70SNikolas Klauser     } else {
10258d9ab70SNikolas Klauser       // input_iterators can't be copied, so the implementation for input_iterators has to store
10358d9ab70SNikolas Klauser       // the values instead of a pointer to the correct values
10458d9ab70SNikolas Klauser       auto __less = [&](auto&& __a, auto&& __b) -> bool {
1055aa03b64SLouis Dionne         return std::invoke(__comp,
1065aa03b64SLouis Dionne                            std::invoke(__proj, std::forward<decltype(__a)>(__a)),
10758d9ab70SNikolas Klauser                            std::invoke(__proj, std::forward<decltype(__b)>(__b)));
10858d9ab70SNikolas Klauser       };
10958d9ab70SNikolas Klauser 
1100a0d58f5SIgor Zhukov       // During initialization, members are allowed to refer to already initialized members
1110a0d58f5SIgor Zhukov       // (see http://eel.is/c++draft/dcl.init.aggr#6)
11258d9ab70SNikolas Klauser       ranges::minmax_result<_ValueT> __result = {*__first, __result.min};
11358d9ab70SNikolas Klauser       if (__first == __last || ++__first == __last)
11458d9ab70SNikolas Klauser         return __result;
11558d9ab70SNikolas Klauser 
11658d9ab70SNikolas Klauser       if (__less(*__first, __result.min))
11758d9ab70SNikolas Klauser         __result.min = *__first;
11858d9ab70SNikolas Klauser       else
11958d9ab70SNikolas Klauser         __result.max = *__first;
12058d9ab70SNikolas Klauser 
12158d9ab70SNikolas Klauser       while (++__first != __last) {
12258d9ab70SNikolas Klauser         _ValueT __i = *__first;
12358d9ab70SNikolas Klauser         if (++__first == __last) {
12458d9ab70SNikolas Klauser           if (__less(__i, __result.min))
12558d9ab70SNikolas Klauser             __result.min = __i;
12658d9ab70SNikolas Klauser           else if (!__less(__i, __result.max))
12758d9ab70SNikolas Klauser             __result.max = __i;
12858d9ab70SNikolas Klauser           return __result;
12958d9ab70SNikolas Klauser         }
13058d9ab70SNikolas Klauser 
13158d9ab70SNikolas Klauser         if (__less(*__first, __i)) {
13258d9ab70SNikolas Klauser           if (__less(*__first, __result.min))
13358d9ab70SNikolas Klauser             __result.min = *__first;
13458d9ab70SNikolas Klauser           if (!__less(__i, __result.max))
13558d9ab70SNikolas Klauser             __result.max = std::move(__i);
13658d9ab70SNikolas Klauser         } else {
13758d9ab70SNikolas Klauser           if (__less(__i, __result.min))
13858d9ab70SNikolas Klauser             __result.min = std::move(__i);
13958d9ab70SNikolas Klauser           if (!__less(*__first, __result.max))
14058d9ab70SNikolas Klauser             __result.max = *__first;
14158d9ab70SNikolas Klauser         }
14258d9ab70SNikolas Klauser       }
14358d9ab70SNikolas Klauser       return __result;
14458d9ab70SNikolas Klauser     }
14558d9ab70SNikolas Klauser   }
14658d9ab70SNikolas Klauser };
14758d9ab70SNikolas Klauser } // namespace __minmax
14858d9ab70SNikolas Klauser 
14958d9ab70SNikolas Klauser inline namespace __cpo {
15058d9ab70SNikolas Klauser inline constexpr auto minmax = __minmax::__fn{};
15158d9ab70SNikolas Klauser } // namespace __cpo
15258d9ab70SNikolas Klauser } // namespace ranges
15358d9ab70SNikolas Klauser 
15458d9ab70SNikolas Klauser _LIBCPP_END_NAMESPACE_STD
15558d9ab70SNikolas Klauser 
156a2c16032SLouis Dionne _LIBCPP_POP_MACROS
157a2c16032SLouis Dionne 
1584f15267dSNikolas Klauser #endif // _LIBCPP_STD_VER >= 20
15958d9ab70SNikolas Klauser 
16058d9ab70SNikolas Klauser #endif // _LIBCPP___ALGORITHM_RANGES_MINMAX_H
161