234 lines
20 KiB
HTML
234 lines
20 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::ranges::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_ranges_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::ranges::</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>‎ | <a href="cpp-algorithm-ranges.html">ranges</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-sep">
|
|
<td></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr class="t-dcl-h">
|
|
<td>
|
|
<div>调用签名</div>
|
|
</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr class="t-dcl t-since-cxx20">
|
|
<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> Proj <span class="sy1">=</span> std<span class="sy4">::</span><span class="me2">identity</span>,<br /></span>
|
|
<p> std<span class="sy4">::</span><span class="me2">indirect_strict_weak_order</span><span class="sy1"><</span>std<span class="sy4">::</span><span class="me2">projected</span><span class="sy1"><</span><span class="kw4">const</span> T<span class="sy2">*</span>, Proj<span class="sy1">>></span> Comp <span class="sy1">=</span> ranges<span class="sy4">::</span><span class="me2">less</span> <span class="sy1">></span><br /></p>
|
|
<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, Comp comp <span class="sy1">=</span> <span class="br0">{</span><span class="br0">}</span>, Proj proj <span class="sy1">=</span> <span class="br0">{</span><span class="br0">}</span> <span class="br0">)</span><span class="sy4">;</span></div>
|
|
</td>
|
|
<td class="t-dcl-nopad"></td>
|
|
<td><span class="t-mark-rev t-since-cxx20">(C++20 起)</span></td>
|
|
</tr>
|
|
<tr class="t-dcl-sep">
|
|
<td></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>若 <code>v</code> 比较小于 <code>lo</code> 则返回 <code>lo</code> ;否则若 <code>hi</code> 比较小于 <code>v</code> 则返回 <code>hi</code> ;否则返回 <code>v</code> 。</p>
|
|
<p><br />
|
|
若 <code>lo</code> 的被投影值大于 <code>hi</code> 则行为未定义。</p>
|
|
<p>此页面上描述的仿函数实体是 <i>niebloid</i> ,即:</p>
|
|
<ul>
|
|
<li>调用它们中的任何一者时不可指定显式模板实参。</li>
|
|
<li>它们无一对<a href="cpp-language-adl.html">实参依赖查找</a>可见。</li>
|
|
<li>在<a href="cpp-language-unqualified_lookup.html">通常无限定查找</a>寻找函数调用运算符左侧的名称找到它们之一时,它禁止<a href="cpp-language-adl.html">实参依赖查找</a>。</li>
|
|
</ul>
|
|
<p>实际上,它们能以函数对象,或以某些特殊编译器扩展实现。</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>应用到投影后元素的比较</td>
|
|
</tr>
|
|
<tr class="t-par">
|
|
<td>proj</td>
|
|
<td>-</td>
|
|
<td>应用到 <code>v</code> 、 <code>lo</code> 及 <code>hi</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>
|
|
<td>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="kw1">struct</span> clamp_fn <span class="br0">{</span>
|
|
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">class</span> T, <span class="kw1">class</span> Proj <span class="sy1">=</span> std<span class="sy4">::</span><span class="me2">identity</span>,
|
|
std<span class="sy4">::</span><span class="me2">indirect_strict_weak_order</span><span class="sy1"><</span>std<span class="sy4">::</span><span class="me2">projected</span><span class="sy1"><</span><span class="kw4">const</span> T<span class="sy2">*</span>, Proj<span class="sy1">>></span> Comp <span class="sy1">=</span> ranges<span class="sy4">::</span><span class="me2">less</span><span class="sy1">></span>
|
|
<span class="kw4">constexpr</span> <span class="kw4">const</span> T<span class="sy3">&</span> operator<span class="br0">(</span><span class="br0">)</span><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,
|
|
Comp comp <span class="sy1">=</span> <span class="br0">{</span><span class="br0">}</span>, Proj proj <span class="sy1">=</span> <span class="br0">{</span><span class="br0">}</span><span class="br0">)</span> <span class="kw4">const</span>
|
|
<span class="br0">{</span>
|
|
<span class="kw4">auto</span><span class="sy3">&&</span> pv <span class="sy1">=</span> <a href="cpp-utility-functional-invoke.html"><span class="kw1058">std::<span class="me2">invoke</span></span></a><span class="br0">(</span>proj, v<span class="br0">)</span><span class="sy4">;</span>
|
|
|
|
<span class="kw1">return</span> <a href="cpp-utility-functional-invoke.html"><span class="kw1058">std::<span class="me2">invoke</span></span></a><span class="br0">(</span>comp, <a href="cpp-utility-forward.html"><span class="kw1117">std::<span class="me2">forward</span></span></a><span class="sy1"><</span>decltype<span class="br0">(</span>pv<span class="br0">)</span><span class="sy1">></span><span class="br0">(</span>pv<span class="br0">)</span>, <a href="cpp-utility-functional-invoke.html"><span class="kw1058">std::<span class="me2">invoke</span></span></a><span class="br0">(</span>proj, lo<span class="br0">)</span><span class="br0">)</span> <span class="sy4">?</span> lo
|
|
<span class="sy4">:</span> <a href="cpp-utility-functional-invoke.html"><span class="kw1058">std::<span class="me2">invoke</span></span></a><span class="br0">(</span>comp, <a href="cpp-utility-functional-invoke.html"><span class="kw1058">std::<span class="me2">invoke</span></span></a><span class="br0">(</span>proj, hi<span class="br0">)</span>, <a href="cpp-utility-forward.html"><span class="kw1117">std::<span class="me2">forward</span></span></a><span class="sy1"><</span>decltype<span class="br0">(</span>pv<span class="br0">)</span><span class="sy1">></span><span class="br0">(</span>pv<span class="br0">)</span><span class="br0">)</span> <span class="sy4">?</span> hi <span class="sy4">:</span> v<span class="sy4">;</span>
|
|
<span class="br0">}</span>
|
|
<span class="br0">}</span><span class="sy4">;</span>
|
|
|
|
<span class="kw1">inline</span> <span class="kw4">constexpr</span> clamp_fn clamp<span class="sy4">;</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::ranges::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="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">ranges</span><span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>n<span class="sy2">-</span><span class="nu0">1</span>, n<span class="sy2">+</span><span class="nu0">1</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 <algorithm></span>
|
|
<span class="co2">#include <cstdint></span>
|
|
<span class="co2">#include <iostream></span>
|
|
<span class="co2">#include <iomanip></span>
|
|
<span class="co2">#include <string></span>
|
|
|
|
<span class="kw1">using</span> <span class="kw1">namespace</span> std<span class="sy4">::</span><span class="me2">literals</span><span class="sy4">;</span>
|
|
|
|
<span class="kw4">int</span> main<span class="br0">(</span><span class="br0">)</span>
|
|
<span class="br0">{</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1758">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> <span class="kw4">const</span> v<span class="sy4">:</span> <span class="br0">{</span><span class="sy2">-</span><span class="nu0">129</span>, <span class="sy2">-</span><span class="nu0">128</span>, <span class="sy2">-</span><span class="nu0">1</span>, <span class="nu0">0</span>, <span class="nu0">42</span>, <span class="nu0">127</span>, <span class="nu0">128</span>, <span class="nu0">255</span>, <span class="nu0">256</span><span class="br0">}</span><span class="br0">)</span> <span class="br0">{</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1797">std::<span class="me2">setw</span></span></a><span class="br0">(</span><span class="nu8">04</span><span class="br0">)</span> <span class="sy1"><<</span> v
|
|
<span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1797">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">ranges</span><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="kw1797">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">ranges</span><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>
|
|
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 投影函数</span>
|
|
<span class="kw4">const</span> <span class="kw4">auto</span> stoi <span class="sy1">=</span> <span class="br0">[</span><span class="br0">]</span><span class="br0">(</span><a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> s<span class="br0">)</span> <span class="br0">{</span> <span class="kw1">return</span> <a href="cpp-string-basic_string-stol.html"><span class="kw1257">std::<span class="me2">stoi</span></span></a><span class="br0">(</span>s<span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span><span class="sy4">;</span>
|
|
|
|
<span class="co1">// 同上,但用字符串</span>
|
|
<span class="kw1">for</span><span class="br0">(</span><a href="cpp-string-basic_string.html"><span class="kw1230">std::<span class="me2">string</span></span></a> <span class="kw4">const</span> v<span class="sy4">:</span> <span class="br0">{</span><span class="st0">"-129"</span>, <span class="st0">"-128"</span>, <span class="st0">"-1"</span>, <span class="st0">"0"</span>, <span class="st0">"42"</span>, <span class="st0">"127"</span>, <span class="st0">"128"</span>, <span class="st0">"255"</span>, <span class="st0">"256"</span><span class="br0">}</span><span class="br0">)</span> <span class="br0">{</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1797">std::<span class="me2">setw</span></span></a><span class="br0">(</span><span class="nu8">04</span><span class="br0">)</span> <span class="sy1"><<</span> v
|
|
<span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1797">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">ranges</span><span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>v, <span class="st0">"-128"</span>s, <span class="st0">"127"</span>s, <span class="br0">{</span><span class="br0">}</span>, stoi<span class="br0">)</span>
|
|
<span class="sy1"><<</span> <a href="cpp-io-manip-setw.html"><span class="kw1797">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">ranges</span><span class="sy4">::</span><span class="me2">clamp</span><span class="br0">(</span>v, <span class="st0">"0"</span>s, <span class="st0">"255"</span>s, <span class="br0">{</span><span class="br0">}</span>, stoi<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
|
|
-129 -128 0
|
|
-128 -128 0
|
|
-1 -1 0
|
|
0 0 0
|
|
42 42 42
|
|
127 127 127
|
|
128 127 128
|
|
255 127 255
|
|
256 127 255
|
|
|
|
-129 -128 0
|
|
-128 -128 0
|
|
-1 -1 0
|
|
0 0 0
|
|
42 42 42
|
|
127 127 127
|
|
128 127 128
|
|
255 127 255
|
|
256 127 255</pre></div>
|
|
</div>
|
|
</div>
|
|
<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-ranges-min.html"><span class="t-lines"><span>ranges::min</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>
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-algorithm-ranges-max.html"><span class="t-lines"><span>ranges::max</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>
|
|
<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-clamp.html"><span class="t-lines"><span>clamp</span></span></a></div>
|
|
<div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div>
|
|
</div>
|
|
</td>
|
|
<td>在一对边界值间夹逼一个值<br />
|
|
<span class="t-mark">(函数模板)</span></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|