doc/html/boost/algorithm/clamp_range_idp550398048.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function template clamp_range</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../algorithm/reference.html#header.boost.algorithm.clamp_hpp" title="Header &lt;boost/algorithm/clamp.hpp&gt;">
  10 <link rel="prev" href="clamp_range_idp550384640.html" title="Function template clamp_range">
  11 <link rel="next" href="all_of_idp550409584.html" title="Function template all_of">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="clamp_range_idp550384640.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/reference.html#header.boost.algorithm.clamp_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="all_of_idp550409584.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.algorithm.clamp_range_idp550398048"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template clamp_range</span></h2>
  30 <p>boost::algorithm::clamp_range</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../algorithm/reference.html#header.boost.algorithm.clamp_hpp" title="Header &lt;boost/algorithm/clamp.hpp&gt;">boost/algorithm/clamp.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range<span class="special">,</span> <span class="keyword">typename</span> <a class="link" href="../../OutputIterator.html" title="Concept OutputIterator">OutputIterator</a><span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">&gt;</span>
  37   <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if_c</span><span class="special">&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special">&lt;</span> <span class="identifier">Range</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  38   <span class="identifier">clamp_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&amp;</span> r<span class="special">,</span> <span class="identifier">OutputIterator</span> out<span class="special">,</span>
  39               <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> lo<span class="special">,</span>
  40               <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> hi<span class="special">,</span>
  41               <span class="identifier">Pred</span> p<span class="special">)</span><span class="special">;</span></pre></div>
  42 <div class="refsect1">
  43 <a name="idp125910416"></a><h2>Description</h2>
  44 <p>
  45
  46 </p>
  47 <div class="variablelist"><table border="0" class="variablelist compact">
  48 <colgroup>
  49 <col align="left" valign="top">
  50 <col>
  51 </colgroup>
  52 <tbody>
  53 <tr>
  54 <td><p><span class="term">Parameters:</span></p></td>
  55 <td><div class="variablelist"><table border="0" class="variablelist compact">
  56 <colgroup>
  57 <col align="left" valign="top">
  58 <col>
  59 </colgroup>
  60 <tbody>
  61 <tr>
  62 <td><p><span class="term"><code class="computeroutput">hi</code></span></p></td>
  63 <td><p>The upper bound of the range to be clamped to </p></td>
  64 </tr>
  65 <tr>
  66 <td><p><span class="term"><code class="computeroutput">lo</code></span></p></td>
  67 <td><p>The lower bound of the range to be clamped to </p></td>
  68 </tr>
  69 <tr>
  70 <td><p><span class="term"><code class="computeroutput">out</code></span></p></td>
  71 <td><p>An output iterator to write the clamped values into </p></td>
  72 </tr>
  73 <tr>
  74 <td><p><span class="term"><code class="computeroutput">p</code></span></p></td>
  75 <td><p>A predicate to use to compare the values. p ( a, b ) returns a boolean. </p></td>
  76 </tr>
  77 <tr>
  78 <td><p><span class="term"><code class="computeroutput">r</code></span></p></td>
  79 <td><p>The range of values to be clamped </p></td>
  80 </tr>
  81 </tbody>
  82 </table></div></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term">Returns:</span></p></td>
  86 <td><p>clamp the sequence of values [first, last) into [ lo, hi ] using the comparison predicate p.</p></td>
  87 </tr>
  88 </tbody>
  89 </table></div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="clamp_range_idp550384640.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/reference.html#header.boost.algorithm.clamp_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="all_of_idp550409584.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>