clamp.md

clamp

• algorithm[meta header]
• std[meta namespace]
• function template[meta id-type]
• cpp17[meta cpp]

namespace std {
  template <class T>
  constexpr const T& clamp(const T& v, const T& low, const T& high);

  template <class T, class Compare>
  constexpr const T& clamp(const T& v, const T& low, const T& high, Compare comp);
}

概要

値を範囲内に収める。

この関数は、vの値を範囲[low, high]に収める。

テンプレートパラメータ制約

• (1) : 型TはLessThanComparableの要件を満たしていること

事前条件

• lowの値はhighの値より大きくなってはならない

戻り値

• vの値がlowより小さければlowを返す
• vの値がhighより大きければhighを返す
• そうでなければvを返す

備考

• clamp(v, low, high)はmin(max(v, low), high)と等価

例

#include <iostream>
#include <algorithm>

int main()
{
  for (int i = 0; i < 10; ++i) {
    // iの値を範囲[2, 7]に収める
    int result = std::clamp(i, 2, 7);
    std::cout << i << " : " << result << std::endl;
  }
}

• std::clamp[color ff0000]

出力

0 : 2
1 : 2
2 : 2
3 : 3
4 : 4
5 : 5
6 : 6
7 : 7
8 : 7
9 : 7

バージョン

言語

• C++17

処理系

• Clang: 3.9 [mark verified]
• GCC: 7.1 [mark verified]
• Visual C++: ??

参照

• N4536 An algorithm to "clamp" a value between a pair of boundary values
• P0025R0 An algorithm to "clamp" a value between a pair of boundary values (revision 1)