Program Listing for File clamp.hpp

↰ Return to documentation for file (include/rcppmath/clamp.hpp)

// Copyright 2020 PAL Robotics S.L.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RCPPMATH__CLAMP_HPP_
#define RCPPMATH__CLAMP_HPP_

#include <cassert>

namespace rcppmath
{
template<class T>
[[deprecated("use std::clamp instead, introduced in C++17")]]
constexpr const T & clamp(const T & v, const T & lo, const T & hi)
{
  assert(!(hi < lo) );
  return (v < lo) ? lo : (hi < v) ? hi : v;
}

template<class T, class Compare>
[[deprecated("use std::clamp instead, introduced in C++17")]]
constexpr const T & clamp(const T & v, const T & lo, const T & hi, Compare comp)
{
  assert(!comp(hi, lo) );
  return comp(v, lo) ? lo : comp(hi, v) ? hi : v;
}

}  // namespace rcppmath

#endif  // RCPPMATH__CLAMP_HPP_