xref: /freebsd-src/contrib/llvm-project/libcxx/include/__algorithm/clamp.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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 
22*06c3fb27SDimitry Andric #if _LIBCPP_STD_VER >= 17
23fe6060f1SDimitry Andric template<class _Tp, class _Compare>
24fe6060f1SDimitry Andric _LIBCPP_NODISCARD_EXT inline
2561cfbce3SDimitry Andric _LIBCPP_INLINE_VISIBILITY constexpr
26fe6060f1SDimitry Andric const _Tp&
27fe6060f1SDimitry Andric clamp(const _Tp& __v, const _Tp& __lo, const _Tp& __hi, _Compare __comp)
28fe6060f1SDimitry Andric {
29*06c3fb27SDimitry Andric     _LIBCPP_ASSERT_UNCATEGORIZED(!__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 
34fe6060f1SDimitry Andric template<class _Tp>
35fe6060f1SDimitry Andric _LIBCPP_NODISCARD_EXT inline
3661cfbce3SDimitry Andric _LIBCPP_INLINE_VISIBILITY constexpr
37fe6060f1SDimitry Andric const _Tp&
38fe6060f1SDimitry Andric clamp(const _Tp& __v, const _Tp& __lo, const _Tp& __hi)
39fe6060f1SDimitry Andric {
40*06c3fb27SDimitry Andric     return _VSTD::clamp(__v, __lo, __hi, __less<>());
41fe6060f1SDimitry Andric }
42fe6060f1SDimitry Andric #endif
43fe6060f1SDimitry Andric 
44fe6060f1SDimitry Andric _LIBCPP_END_NAMESPACE_STD
45fe6060f1SDimitry Andric 
46fe6060f1SDimitry Andric #endif // _LIBCPP___ALGORITHM_CLAMP_H
47