215 lines
18 KiB
HTML
215 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="zh" dir="ltr" class="client-nojs" xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh">
|
|
<head><meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>std::clamp</title>
|
|
<link rel="stylesheet" href="ext.css" />
|
|
<link rel="stylesheet" href="site_modules.css" />
|
|
</head>
|
|
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-cpp_algorithm_clamp skin-cppreference2 action-view cpp-navbar">
|
|
<div id="cpp-content-base">
|
|
<div id="content"><a id="top"></a>
|
|
<h1 id="firstHeading" class="firstHeading"><span style="font-size:0.7em; line-height:130%">std::</span>clamp</h1>
|
|
<div id="bodyContent">
|
|
<div id="contentSub"><span class="subpages">< <a href="cpp.html">cpp</a>‎ | <a href="cpp-algorithm.html">algorithm</a></span></div>
|
|
<div id="mw-content-text" lang="zh" dir="ltr" class="mw-content-ltr" xml:lang="zh">
|
|
<table class="t-dcl-begin">
|
|
<tbody>
|
|
<tr class="t-dsc-header">
|
|
<td>
|
|
<div>定义于头文件 <code><a href="cpp-header-algorithm.html"><algorithm></a></code></div>
|
|
</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr class="t-dcl t-since-cxx17">
|
|
<td>
|
|
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T<span class="sy1">></span><br />
|
|
<span class="kw4">constexpr</span> <span class="kw4">const</span> T<span class="sy3">&</span> clamp<span class="br0">(</span> <span class="kw4">const</span> T<span class="sy3">&</span> v, <span class="kw4">const</span> T<span class="sy3">&</span> lo, <span class="kw4">const</span> T<span class="sy3">&</span> hi <span class="br0">)</span><span class="sy4">;</span></span></div>
|
|
</td>
|
|
<td>(1)</td>
|
|
<td><span class="t-mark-rev t-since-cxx17">(C++17 起)</span></td>
|
|
</tr>
|
|
<tr class="t-dcl t-since-cxx17">
|
|
<td>
|
|
<div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T, <span class="kw1">class</span> Compare<span class="sy1">></span><br />
|
|
<span class="kw4">constexpr</span> <span class="kw4">const</span> T<span class="sy3">&</span> clamp<span class="br0">(</span> <span class="kw4">const</span> T<span class="sy3">&</span> v, <span class="kw4">const</span> T<span class="sy3">&</span> lo, <span class="kw4">const</span> T<span class="sy3">&</span> hi, Compare comp <span class="br0">)</span><span class="sy4">;</span></span></div>
|
|
</td>
|
|
<td>(2)</td>
|
|
<td><span class="t-mark-rev t-since-cxx17">(C++17 起)</span></td>
|
|
</tr>
|
|
<tr class="t-dcl-sep">
|
|
<td></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="t-li1"><span class="t-li">1)</span> 若 <code>v</code> 小于 <code>lo</code> ,则返回 <code>lo</code> ;若 <code>v</code> 大于 <code>hi</code> ,则返回 <code>hi</code> ;否则返回 <code>v</code> 。使用 <span class="t-c"><span class="mw-geshi cpp source-cpp">operator<span class="sy1"><</span></span></span> 比较值。</div>
|
|
<div class="t-li1"><span class="t-li">2)</span> 同 <span class="t-v">(1)</span> ,不过使用 <code>comp</code> 比较值。</div>
|
|
<p>若 <code>lo</code> 的值大于 <code>hi</code> 则行为未定义。</p>
|
|
<h3><span class="mw-headline" id=".E5.8F.82.E6.95.B0">参数</span></h3>
|
|
<table class="t-par-begin">
|
|
<tr class="t-par">
|
|
<td>v</td>
|
|
<td>-</td>
|
|
<td>要夹住的值</td>
|
|
</tr>
|
|
<tr class="t-par">
|
|
<td>lo,hi</td>
|
|
<td>-</td>
|
|
<td>夹 <code>v</code> 的边界</td>
|
|
</tr>
|
|
<tr class="t-par">
|
|
<td>comp</td>
|
|
<td>-</td>
|
|
<td>比较函数对象(即满足<a href="cpp-named_req-Compare.html"><span style="font-style:italic">比较</span> <span style="font-family: Georgia, 'DejaVu Serif', serif; font-style:italic">(Compare)</span></a> 要求的对象),若 <code>lo</code> <i>小于</i> <code>v</code> 且 <code>v</code> <i>小于</i> <code>hi</code>,则返回 ​<span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">true</span></span></span> 。<br />
|
|
<p>比较函数的签名应等价于如下:</p>
|
|
<p><span class="t-cc"><span class="mw-geshi cpp source-cpp"> <span class="kw4">bool</span> cmp<span class="br0">(</span><span class="kw4">const</span> Type1 <span class="sy3">&</span>a, <span class="kw4">const</span> Type2 <span class="sy3">&</span>b<span class="br0">)</span><span class="sy4">;</span></span></span></p>
|
|
<p>虽然签名不必有 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw4">const</span> <span class="sy3">&</span></span></span> ,函数也不能修改传递给它的对象,而且必须接受(可为 const 的)类型 <code>Type1</code> 与 <code>Type2</code> 的值,无关乎<a href="cpp-language-value_category.html">值类别</a>(从而不允许 <span class="t-c"><span class="mw-geshi cpp source-cpp">Type1 <span class="sy3">&</span></span></span> <span class="t-rev-inl t-since-cxx11"><span>,亦不允许 <span class="t-c"><span class="mw-geshi cpp source-cpp">Type1</span></span> ,除非 <code>Type1</code> 的移动等价于复制</span> <span><span class="t-mark-rev t-since-cxx11">(C++11 起)</span></span></span>)。<br />
|
|
类型 <span class="t-c"><span class="mw-geshi cpp source-cpp">Type1</span></span> 与 <span class="t-c"><span class="mw-geshi cpp source-cpp">Type2</span></span> 必须使得 <span class="t-c"><span class="mw-geshi cpp source-cpp">T</span></span> 类型的对象能隐式转换到这两个类型。 ​</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="t-par-hitem">
|
|
<td colspan="3">类型要求</td>
|
|
</tr>
|
|
<tr class="t-par-req">
|
|
<td colspan="3">-
|
|
<div class="spacer"></div>
|
|
为使用重载 (1) , <code>T</code> 必须满足<a href="cpp-named_req-LessThanComparable.html"><span style="font-style:italic">可小于比较</span> <span style="font-family: Georgia, 'DejaVu Serif', serif; font-style:italic">(LessThanComparable)</span></a> 的要求。然而若避免了 <code>NaN</code> ,则 <code>T</code> 能为浮点类型。</td>
|
|
</tr>
|
|
</table>
|
|
<h3><span class="mw-headline" id=".E8.BF.94.E5.9B.9E.E5.80.BC">返回值</span></h3>
|
|
<p>若 <code>v</code> 小于 <code>lo</code> 到则为 <code>lo</code> 的引用,若 <code>hi</code> 小于 <code>v</code> 则为到 <code>hi</code> 的引用,否则为到 <code>v</code> 的引用。</p>
|
|
<h3><span class="mw-headline" id=".E5.A4.8D.E6.9D.82.E5.BA.A6">复杂度</span></h3>
|
|
<p>至多二次比较</p>
|
|
<h3><span class="mw-headline" id=".E5.8F.AF.E8.83.BD.E7.9A.84.E5.AE.9E.E7.8E.B0">可能的实现</span></h3>
|
|
<table class="eq-fun-cpp-table">
|
|
<tr>
|
|
<th>版本一</th>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T<span class="sy1">></span>
|
|
<span class="kw4">constexpr</span> <span class="kw4">const</span> T<span class="sy3">&</span> clamp<span class="br0">(</span> <span class="kw4">const</span> T<span class="sy3">&</span> v, <span class="kw4">const</span> T<span class="sy3">&</span> lo, <span class="kw4">const</span> T<span class="sy3">&</span> hi <span class="br0">)</span>
|
|
<span class="br0">{</span>
|
|
<a href="cpp-error-assert.html"><span class="kw774">assert</span></a><span class="br0">(</span> <span class="sy3">!</span><span class="br0">(</span>hi <span class="sy1"><</span> lo<span class="br0">)</span> <span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="kw1">return</span> v <span class="sy1"><</span> lo <span class="sy4">?</span> lo <span class="sy4">:</span> hi <span class="sy1"><</span> v <span class="sy4">?</span> hi <span class="sy4">:</span> v<span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>版本二</th>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T, <span class="kw1">class</span> Compare<span class="sy1">></span>
|
|
<span class="kw4">constexpr</span> <span class="kw4">const</span> T<span class="sy3">&</span> clamp<span class="br0">(</span> <span class="kw4">const</span> T<span class="sy3">&</span> v, <span class="kw4">const</span> T<span class="sy3">&</span> lo, <span class="kw4">const</span> T<span class="sy3">&</span> hi, Compare comp <span class="br0">)</span>
|
|
<span class="br0">{</span>
|
|
<a href="cpp-error-assert.html"><span class="kw774">assert</span></a><span class="br0">(</span> <span class="sy3">!</span>comp<span class="br0">(</span>hi, lo<span class="br0">)</span> <span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="kw1">return</span> comp<span class="br0">(</span>v, lo<span class="br0">)</span> <span class="sy4">?</span> lo <span class="sy4">:</span> comp<span class="br0">(</span>hi, v<span class="br0">)</span> <span class="sy4">?</span> hi <span class="sy4">:</span> v<span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h3><span class="mw-headline" id=".E6.B3.A8.E8.A7.A3">注解</span></h3>
|
|
<div class="t-template-editlink" style=""></div>
|
|
若参数之一是临时量,而该参数被返回,则以引用捕获 <code>std::clamp</code> 的结果会产生一个悬垂引用:
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw4">int</span> n <span class="sy1">=</span> <span class="sy2">-</span><span class="nu0">1</span><span class="sy4">;</span>
|
|
<span class="kw4">const</span> <span class="kw4">int</span><span class="sy3">&</span> r <span class="sy1">=</span> std<span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>n, <span class="nu0">0</span>, <span class="nu0">255</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<span class="co1">// r 悬垂</span></pre></div>
|
|
</div>
|
|
<p>若 <code>v</code> 与边界之一比较相等,则返回到 <code>v</code> 的引用,而非到边界者。</p>
|
|
<h3><span class="mw-headline" id=".E7.A4.BA.E4.BE.8B">示例</span></h3>
|
|
<div class="t-example">
|
|
<div class="t-example-live-link"></div>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="co2">#include <cstdint></span>
|
|
<span class="co2">#include <algorithm></span>
|
|
<span class="co2">#include <iostream></span>
|
|
<span class="co2">#include <iomanip></span>
|
|
<span class="co2">#include <random></span>
|
|
|
|
<span class="kw4">int</span> main<span class="br0">(</span><span class="br0">)</span>
|
|
<span class="br0">{</span>
|
|
<a href="cpp-numeric-random-mersenne_twister_engine.html"><span class="kw1489">std::<span class="me2">mt19937</span></span></a> g<span class="br0">(</span><a href="cpp-numeric-random-random_device.html"><span class="kw1486">std::<span class="me2">random_device</span></span></a><span class="br0">{</span><span class="br0">}</span><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<a href="cpp-numeric-random-uniform_int_distribution.html"><span class="kw1502">std::<span class="me2">uniform_int_distribution</span></span></a><span class="sy1"><></span> d<span class="br0">(</span><span class="sy2">-</span><span class="nu0">300</span>, <span class="nu0">300</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1757">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <span class="st0">" raw clamped to int8_t clamped to uint8_t<span class="es1">\n</span>"</span><span class="sy4">;</span>
|
|
<span class="kw1">for</span><span class="br0">(</span><span class="kw4">int</span> n <span class="sy1">=</span> <span class="nu0">0</span><span class="sy4">;</span> n <span class="sy1"><</span> <span class="nu0">5</span><span class="sy4">;</span> <span class="sy2">++</span>n<span class="br0">)</span> <span class="br0">{</span>
|
|
<span class="kw4">int</span> v <span class="sy1">=</span> d<span class="br0">(</span>g<span class="br0">)</span><span class="sy4">;</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1757">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1796">std::<span class="me2">setw</span></span></a><span class="br0">(</span><span class="nu0">4</span><span class="br0">)</span> <span class="sy1"><<</span> v
|
|
<span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1796">std::<span class="me2">setw</span></span></a><span class="br0">(</span><span class="nu0">20</span><span class="br0">)</span> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>v, <a href="cpp-types-integer.html"><span class="kw134">INT8_MIN</span></a>, <a href="cpp-types-integer.html"><span class="kw148">INT8_MAX</span></a><span class="br0">)</span>
|
|
<span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1796">std::<span class="me2">setw</span></span></a><span class="br0">(</span><span class="nu0">21</span><span class="br0">)</span> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>v, <span class="nu0">0</span>, <a href="cpp-types-integer.html"><span class="kw162">UINT8_MAX</span></a><span class="br0">)</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
|
|
<span class="br0">}</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
<p>可能的输出:</p>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="text source-text">
|
|
<pre class="de1">.raw clamped to int8_t clamped to uint8_t
|
|
168 127 168
|
|
128 127 128
|
|
-137 -128 0
|
|
40 40 40
|
|
-66 -66 0</pre></div>
|
|
</div>
|
|
</div>
|
|
<p><br /></p>
|
|
<h3><span class="mw-headline" id=".E5.8F.82.E9.98.85">参阅</span></h3>
|
|
<table class="t-dsc-begin">
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-algorithm-min.html"><span class="t-lines"><span>min</span></span></a></div>
|
|
</div>
|
|
</td>
|
|
<td>返回各给定值中的较小者<br />
|
|
<span class="t-mark">(函数模板)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-algorithm-max.html"><span class="t-lines"><span>max</span></span></a></div>
|
|
</div>
|
|
</td>
|
|
<td>返回各给定值中的较大者<br />
|
|
<span class="t-mark">(函数模板)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-utility-in_range.html"><span class="t-lines"><span>in_range</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>检查整数值是否在给定整数类型的范围内<br />
|
|
<span class="t-mark">(函数模板)</span></td>
|
|
</tr>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-algorithm-ranges-clamp.html"><span class="t-lines"><span>ranges::clamp</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>在一对边界值间夹一个值<br />
|
|
<span class="t-mark">(niebloid)</span></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|