xref: /freebsd/contrib/llvm-project/libcxx/include/__algorithm/clamp.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1fe6060f1SDimitry Andric //===----------------------------------------------------------------------===//
2fe6060f1SDimitry Andric //
3fe6060f1SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4fe6060f1SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5fe6060f1SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6fe6060f1SDimitry Andric //
7fe6060f1SDimitry Andric //===----------------------------------------------------------------------===//
8fe6060f1SDimitry Andric 
9fe6060f1SDimitry Andric #ifndef _LIBCPP___ALGORITHM_CLAMP_H
10fe6060f1SDimitry Andric #define _LIBCPP___ALGORITHM_CLAMP_H
11fe6060f1SDimitry Andric 
1204eeddc0SDimitry Andric #include <__algorithm/comp.h>
1381ad6265SDimitry Andric #include <__assert>
14fe6060f1SDimitry Andric #include <__config>
15fe6060f1SDimitry Andric 
16fe6060f1SDimitry Andric #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17fe6060f1SDimitry Andric #  pragma GCC system_header
18fe6060f1SDimitry Andric #endif
19fe6060f1SDimitry Andric 
20fe6060f1SDimitry Andric _LIBCPP_BEGIN_NAMESPACE_STD
21fe6060f1SDimitry Andric 
2206c3fb27SDimitry Andric #if _LIBCPP_STD_VER >= 17
23fe6060f1SDimitry Andric template <class _Tp, class _Compare>
24*0fca6ea1SDimitry Andric [[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI constexpr const _Tp&
clamp(_LIBCPP_LIFETIMEBOUND const _Tp & __v,_LIBCPP_LIFETIMEBOUND const _Tp & __lo,_LIBCPP_LIFETIMEBOUND const _Tp & __hi,_Compare __comp)255f757f3fSDimitry Andric clamp(_LIBCPP_LIFETIMEBOUND const _Tp& __v,
265f757f3fSDimitry Andric       _LIBCPP_LIFETIMEBOUND const _Tp& __lo,
275f757f3fSDimitry Andric       _LIBCPP_LIFETIMEBOUND const _Tp& __hi,
285f757f3fSDimitry Andric       _Compare __comp) {
297a6dacacSDimitry Andric   _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(!__comp(__hi, __lo), "Bad bounds passed to std::clamp");
30fe6060f1SDimitry Andric   return __comp(__v, __lo) ? __lo : __comp(__hi, __v) ? __hi : __v;
31fe6060f1SDimitry Andric }
32fe6060f1SDimitry Andric 
33fe6060f1SDimitry Andric template <class _Tp>
34*0fca6ea1SDimitry Andric [[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI constexpr const _Tp&
clamp(_LIBCPP_LIFETIMEBOUND const _Tp & __v,_LIBCPP_LIFETIMEBOUND const _Tp & __lo,_LIBCPP_LIFETIMEBOUND const _Tp & __hi)355f757f3fSDimitry Andric clamp(_LIBCPP_LIFETIMEBOUND const _Tp& __v,
365f757f3fSDimitry Andric       _LIBCPP_LIFETIMEBOUND const _Tp& __lo,
375f757f3fSDimitry Andric       _LIBCPP_LIFETIMEBOUND const _Tp& __hi) {
385f757f3fSDimitry Andric   return std::clamp(__v, __lo, __hi, __less<>());
39fe6060f1SDimitry Andric }
40fe6060f1SDimitry Andric #endif
41fe6060f1SDimitry Andric 
42fe6060f1SDimitry Andric _LIBCPP_END_NAMESPACE_STD
43fe6060f1SDimitry Andric 
44fe6060f1SDimitry Andric #endif // _LIBCPP___ALGORITHM_CLAMP_H
45