doc/html/boost/algorithm/copy_while_idp550476608.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 copy_while</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.cxx11.copy_if_hpp" title="Header &lt;boost/algorithm/cxx11/copy_if.hpp&gt;">
  10 <link rel="prev" href="copy_if_idp550469952.html" title="Function template copy_if">
  11 <link rel="next" href="copy_while_idp550484288.html" title="Function template copy_while">
  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="copy_if_idp550469952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/reference.html#header.boost.algorithm.cxx11.copy_if_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="copy_while_idp550484288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.algorithm.copy_while_idp550476608"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template copy_while</span></h2>
  30 <p>boost::algorithm::copy_while &#8212; Copies all the elements at the start of the input range that satisfy the predicate to the output 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.cxx11.copy_if_hpp" title="Header &lt;boost/algorithm/cxx11/copy_if.hpp&gt;">boost/algorithm/cxx11/copy_if.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../InputIterator.html" title="Concept InputIterator">InputIterator</a><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> Predicate<span class="special">&gt;</span>
  37   <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="special">&gt;</span>
  38   <span class="identifier">copy_while</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> <span class="identifier">OutputIterator</span> result<span class="special">,</span>
  39              <span class="identifier">Predicate</span> p<span class="special">)</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp126402576"></a><h2>Description</h2>
  42 <p>
  43
  44 </p>
  45 <div class="variablelist"><table border="0" class="variablelist compact">
  46 <colgroup>
  47 <col align="left" valign="top">
  48 <col>
  49 </colgroup>
  50 <tbody>
  51 <tr>
  52 <td><p><span class="term">Parameters:</span></p></td>
  53 <td><div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody>
  59 <tr>
  60 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
  61 <td><p>The start of the input sequence </p></td>
  62 </tr>
  63 <tr>
  64 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
  65 <td><p>One past the end of the input sequence </p></td>
  66 </tr>
  67 <tr>
  68 <td><p><span class="term"><code class="computeroutput">p</code></span></p></td>
  69 <td><p>A predicate for testing the elements of the range </p></td>
  70 </tr>
  71 <tr>
  72 <td><p><span class="term"><code class="computeroutput">result</code></span></p></td>
  73 <td><p>An output iterator to write the results into </p></td>
  74 </tr>
  75 </tbody>
  76 </table></div></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term">Returns:</span></p></td>
  80 <td><p>The updated input and output iterators</p></td>
  81 </tr>
  82 </tbody>
  83 </table></div>
  84 </div>
  85 </div>
  86 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  87 <td align="left"></td>
  88 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
  89         Distributed under the Boost Software License, Version 1.0. (See accompanying
  90         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>)
  91       </p>
  92 </div></td>
  93 </tr></table>
  94 <hr>
  95 <div class="spirit-nav">
  96 <a accesskey="p" href="copy_if_idp550469952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/reference.html#header.boost.algorithm.cxx11.copy_if_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="copy_while_idp550484288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  97 </div>
  98 </body>
  99 </html>