doc/html/boost/algorithm/find_token.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template find_token</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.find_hpp" title="Header &lt;boost/algorithm/string/find.hpp&gt;">
   9 <link rel="prev" href="find_tail.html" title="Function template find_tail">
  10 <link rel="next" href="find_format_copy.html" title="Function find_format_copy">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="find_tail.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_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="find_format_copy.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.find_token"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template find_token</span></h2>
  29 <p>boost::algorithm::find_token &#8212; Find token algorithm. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../../string_algo/reference.html#header.boost.algorithm.string.find_hpp" title="Header &lt;boost/algorithm/string/find.hpp&gt;">boost/algorithm/string/find.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">,</span> <span class="keyword">typename</span> PredicateT<span class="special">&gt;</span>
  36   <span class="identifier">iterator_range</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  37   <span class="identifier">find_token</span><span class="special">(</span><span class="identifier">RangeT</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="identifier">PredicateT</span> Pred<span class="special">,</span>
  38              <span class="identifier">token_compress_mode_type</span> eCompress <span class="special">=</span> <span class="identifier">token_compress_off</span><span class="special">)</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idp434317168"></a><h2>Description</h2>
  41 <p>Look for a given token in the string. Token is a character that matches the given predicate. If the "token compress mode" is enabled, adjacent tokens are considered to be one match.</p>
  42 <p>
  43
  44 </p>
  45 <div class="note"><table border="0" summary="Note">
  46 <tr>
  47 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  48 <th align="left">Note</th>
  49 </tr>
  50 <tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr>
  51 </table></div>
  52 <p>
  53 </p>
  54 <div class="variablelist"><table border="0" class="variablelist compact">
  55 <colgroup>
  56 <col align="left" valign="top">
  57 <col>
  58 </colgroup>
  59 <tbody>
  60 <tr>
  61 <td><p><span class="term">Parameters:</span></p></td>
  62 <td><div class="variablelist"><table border="0" class="variablelist compact">
  63 <colgroup>
  64 <col align="left" valign="top">
  65 <col>
  66 </colgroup>
  67 <tbody>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  70 <td><p>A input string. </p></td>
  71 </tr>
  72 <tr>
  73 <td><p><span class="term"><code class="computeroutput">Pred</code></span></p></td>
  74 <td><p>A unary predicate to identify a token </p></td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><code class="computeroutput">eCompress</code></span></p></td>
  78 <td><p>Enable/Disable compressing of adjacent tokens </p></td>
  79 </tr>
  80 </tbody>
  81 </table></div></td>
  82 </tr>
  83 <tr>
  84 <td><p><span class="term">Returns:</span></p></td>
  85 <td><p>An <code class="computeroutput">iterator_range</code> delimiting the match. Returned iterator is either <code class="computeroutput">RangeT::iterator</code> or <code class="computeroutput">RangeT::const_iterator</code>, depending on the constness of the input parameter.</p></td>
  86 </tr>
  87 </tbody>
  88 </table></div>
  89 </div>
  90 </div>
  91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92 <td align="left"></td>
  93 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
  94                 Software License, Version 1.0. (See accompanying file
  95                 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  96             </p>
  97 </div></td>
  98 </tr></table>
  99 <hr>
 100 <div class="spirit-nav">
 101 <a accesskey="p" href="find_tail.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.find_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="find_format_copy.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 102 </div>
 103 </body>
 104 </html>