libs/algorithm/doc/html/boost/algorithm/is_palin_idm44730856628096.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template is_palindrome</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="The Boost Algorithm Library">
   8 <link rel="up" href="../../header/boost/algorithm/is_palindrome_hpp.html" title="Header &lt;boost/algorithm/is_palindrome.hpp&gt;">
   9 <link rel="prev" href="is_palin_idm44730856631936.html" title="Function is_palindrome">
  10 <link rel="next" href="../../header/boost/algorithm/is_partitioned_until_hpp.html" title="Header &lt;boost/algorithm/is_partitioned_until.hpp&gt;">
  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="is_palin_idm44730856631936.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/algorithm/is_palindrome_hpp.html"><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="../../header/boost/algorithm/is_partitioned_until_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.is_palin_idm44730856628096"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template is_palindrome</span></h2>
  29 <p>boost::algorithm::is_palindrome</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="../../header/boost/algorithm/is_palindrome_hpp.html" title="Header &lt;boost/algorithm/is_palindrome.hpp&gt;">boost/algorithm/is_palindrome.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Predicate<span class="special">&gt;</span> <span class="keyword">bool</span> <span class="identifier">is_palindrome</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str<span class="special">,</span> <span class="identifier">Predicate</span> p<span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45158677847968"></a><h2>Description</h2>
  38 <p>
  39
  40 </p>
  41 <div class="note"><table border="0" summary="Note">
  42 <tr>
  43 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  44 <th align="left">Note</th>
  45 </tr>
  46 <tr><td align="left" valign="top"><p>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </p></td></tr>
  47 </table></div>
  48 <p>
  49 </p>
  50 <div class="variablelist"><table border="0" class="variablelist compact">
  51 <colgroup>
  52 <col align="left" valign="top">
  53 <col>
  54 </colgroup>
  55 <tbody>
  56 <tr>
  57 <td><p><span class="term">Parameters:</span></p></td>
  58 <td><div class="variablelist"><table border="0" class="variablelist compact">
  59 <colgroup>
  60 <col align="left" valign="top">
  61 <col>
  62 </colgroup>
  63 <tbody>
  64 <tr>
  65 <td><p><span class="term"><code class="computeroutput">p</code></span></p></td>
  66 <td><p>A predicate used to compare the values.</p></td>
  67 </tr>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
  70 <td><p>C-string to be tested. </p></td>
  71 </tr>
  72 </tbody>
  73 </table></div></td>
  74 </tr>
  75 <tr>
  76 <td><p><span class="term">Returns:</span></p></td>
  77 <td><p>true if the entire sequence is palindrome</p></td>
  78 </tr>
  79 </tbody>
  80 </table></div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         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>)
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="is_palin_idm44730856631936.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/algorithm/is_palindrome_hpp.html"><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="../../header/boost/algorithm/is_partitioned_until_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>