xref: /llvm-project/libcxx/include/__cxx03/__algorithm/clamp.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_CLAMP_H
10*ce777190SNikolas Klauser #define _LIBCPP___CXX03___ALGORITHM_CLAMP_H
11e78f53d1SNikolas Klauser 
1273fbae83SNikolas Klauser #include <__cxx03/__algorithm/comp.h>
1373fbae83SNikolas Klauser #include <__cxx03/__assert>
1473fbae83SNikolas Klauser #include <__cxx03/__config>
15e78f53d1SNikolas Klauser 
16e78f53d1SNikolas Klauser #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17e78f53d1SNikolas Klauser #  pragma GCC system_header
18e78f53d1SNikolas Klauser #endif
19e78f53d1SNikolas Klauser 
20e78f53d1SNikolas Klauser _LIBCPP_BEGIN_NAMESPACE_STD
21e78f53d1SNikolas Klauser 
22e78f53d1SNikolas Klauser #if _LIBCPP_STD_VER >= 17
23e78f53d1SNikolas Klauser template <class _Tp, class _Compare>
24e78f53d1SNikolas Klauser [[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI constexpr const _Tp&
25e78f53d1SNikolas Klauser clamp(_LIBCPP_LIFETIMEBOUND const _Tp& __v,
26e78f53d1SNikolas Klauser       _LIBCPP_LIFETIMEBOUND const _Tp& __lo,
27e78f53d1SNikolas Klauser       _LIBCPP_LIFETIMEBOUND const _Tp& __hi,
28e78f53d1SNikolas Klauser       _Compare __comp) {
29e78f53d1SNikolas Klauser   _LIBCPP_ASSERT_ARGUMENT_WITHIN_DOMAIN(!__comp(__hi, __lo), "Bad bounds passed to std::clamp");
30e78f53d1SNikolas Klauser   return __comp(__v, __lo) ? __lo : __comp(__hi, __v) ? __hi : __v;
31e78f53d1SNikolas Klauser }
32e78f53d1SNikolas Klauser 
33e78f53d1SNikolas Klauser template <class _Tp>
34e78f53d1SNikolas Klauser [[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI constexpr const _Tp&
35e78f53d1SNikolas Klauser clamp(_LIBCPP_LIFETIMEBOUND const _Tp& __v,
36e78f53d1SNikolas Klauser       _LIBCPP_LIFETIMEBOUND const _Tp& __lo,
37e78f53d1SNikolas Klauser       _LIBCPP_LIFETIMEBOUND const _Tp& __hi) {
38e78f53d1SNikolas Klauser   return std::clamp(__v, __lo, __hi, __less<>());
39e78f53d1SNikolas Klauser }
40e78f53d1SNikolas Klauser #endif
41e78f53d1SNikolas Klauser 
42e78f53d1SNikolas Klauser _LIBCPP_END_NAMESPACE_STD
43e78f53d1SNikolas Klauser 
44*ce777190SNikolas Klauser #endif // _LIBCPP___CXX03___ALGORITHM_CLAMP_H
45