summaryrefslogtreecommitdiff
path: root/doc/html/algorithm/Misc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/algorithm/Misc.html')
-rw-r--r--doc/html/algorithm/Misc.html556
1 files changed, 556 insertions, 0 deletions
diff --git a/doc/html/algorithm/Misc.html b/doc/html/algorithm/Misc.html
new file mode 100644
index 0000000000..49075d7b05
--- /dev/null
+++ b/doc/html/algorithm/Misc.html
@@ -0,0 +1,556 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Other Algorithms</title>
+<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
+<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
+<link rel="up" href="../algorithm.html" title="Chapter&#160;3.&#160;The Boost Algorithm Library">
+<link rel="prev" href="CXX14.html" title="C++14 Algorithms">
+<link rel="next" href="reference.html" title="Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
+<td align="center"><a href="../../../index.html">Home</a></td>
+<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="CXX14.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithm.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="reference.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="algorithm.Misc"></a><a class="link" href="Misc.html" title="Other Algorithms">Other Algorithms</a>
+</h2></div></div></div>
+<div class="toc"><dl class="toc">
+<dt><span class="section"><a href="Misc.html#the_boost_algorithm_library.Misc.clamp">clamp</a></span></dt>
+<dt><span class="section"><a href="Misc.html#the_boost_algorithm_library.Misc.gather">gather</a></span></dt>
+<dt><span class="section"><a href="Misc.html#the_boost_algorithm_library.Misc.hex">hex</a></span></dt>
+<dt><span class="section"><a href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome">is_palindrome</a></span></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="the_boost_algorithm_library.Misc.clamp"></a><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.clamp" title="clamp">clamp</a>
+</h3></div></div></div>
+<p>
+ The header file clamp.hpp contains two functions for "clamping"
+ a value between a pair of boundary values.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.clamp.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.clamp.clamp"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.clamp.clamp">clamp</a>
+ </h5>
+<p>
+ The function <code class="computeroutput"><span class="identifier">clamp</span> <span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">lo</span><span class="special">,</span> <span class="identifier">hi</span><span class="special">)</span></code>
+ returns:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem">
+ lo if v &lt; lo
+ </li>
+<li class="listitem">
+ hi if hi &lt; v
+ </li>
+<li class="listitem">
+ otherwise, v
+ </li>
+</ul></div>
+<p>
+ Note: using <code class="computeroutput"><span class="identifier">clamp</span></code> with floating
+ point numbers may give unexpected results if one of the values is <code class="computeroutput"><span class="identifier">NaN</span></code>.
+ </p>
+<p>
+ There is also a version that allows the caller to specify a comparison predicate
+ to use instead of <code class="computeroutput"><span class="keyword">operator</span> <span class="special">&lt;</span></code>.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
+<span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">clamp</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">val</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">lo</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">hi</span> <span class="special">);</span>
+
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">&gt;</span>
+<span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">clamp</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">val</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">lo</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">hi</span><span class="special">,</span> <span class="identifier">Pred</span> <span class="identifier">p</span> <span class="special">);</span>
+</pre>
+<p>
+ </p>
+<p>
+ The following code:
+</p>
+<pre class="programlisting"><span class="keyword">int</span> <span class="identifier">foo</span> <span class="special">=</span> <span class="number">23</span><span class="special">;</span>
+<span class="identifier">foo</span> <span class="special">=</span> <span class="identifier">clamp</span> <span class="special">(</span> <span class="identifier">foo</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">10</span> <span class="special">);</span>
+</pre>
+<p>
+ will leave <code class="computeroutput"><span class="identifier">foo</span></code> with a value
+ of 10
+ </p>
+<p>
+ Complexity: <code class="computeroutput"><span class="identifier">clamp</span></code> will make
+ either one or two calls to the comparison predicate before returning one
+ of the three parameters.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.clamp.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.clamp.clamp_range"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.clamp.clamp_range">clamp_range</a>
+ </h5>
+<p>
+ There are also four range-based versions of clamp, that apply clamping to
+ a series of values. You could write them yourself with std::transform and
+ bind, like this: <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">transform</span> <span class="special">(</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">out</span><span class="special">,</span> <span class="identifier">bind</span>
+ <span class="special">(</span> <span class="identifier">clamp</span>
+ <span class="special">(</span> <span class="identifier">_1</span><span class="special">,</span> <span class="identifier">lo</span><span class="special">,</span>
+ <span class="identifier">hi</span> <span class="special">)))</span></code>,
+ but they are provided here for your convenience.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">clamp_range</span> <span class="special">(</span> <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span>
+ <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="identifier">InputIterator</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">lo</span><span class="special">,</span>
+ <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="identifier">InputIterator</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">hi</span> <span class="special">);</span>
+
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <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><span class="identifier">r</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span>
+ <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="identifier">type</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">lo</span><span class="special">,</span>
+ <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="identifier">type</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">hi</span> <span class="special">);</span>
+
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">clamp_range</span> <span class="special">(</span> <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span>
+ <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="identifier">InputIterator</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">lo</span><span class="special">,</span>
+ <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="identifier">InputIterator</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">hi</span><span class="special">,</span> <span class="identifier">Pred</span> <span class="identifier">p</span> <span class="special">);</span>
+
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <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><span class="identifier">r</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span>
+ <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="identifier">type</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">lo</span><span class="special">,</span>
+ <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="identifier">type</span><span class="special">&gt;::</span><span class="identifier">value_type</span> <span class="identifier">hi</span><span class="special">,</span>
+ <span class="identifier">Pred</span> <span class="identifier">p</span> <span class="special">);</span>
+</pre>
+<p>
+ </p>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="the_boost_algorithm_library.Misc.gather"></a><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather" title="gather">gather</a>
+</h3></div></div></div>
+<p>
+ The header file 'boost/algorithm/gather.hpp' contains two variants of a single
+ algorithm, <code class="computeroutput"><span class="identifier">gather</span></code>.
+ </p>
+<p>
+ <code class="computeroutput"><span class="identifier">gather</span><span class="special">()</span></code>
+ takes a collection of elements defined by a pair of iterators and moves the
+ ones satisfying a predicate to them to a position (called the pivot) within
+ the sequence. The algorithm is stable. The result is a pair of iterators
+ that contains the items that satisfy the predicate.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.interface"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.interface">Interface</a>
+ </h5>
+<p>
+ The function <code class="computeroutput"><span class="identifier">gather</span></code> returns
+ a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code> of iterators that denote the elements
+ that satisfy the predicate.
+ </p>
+<p>
+ There are two versions; one takes two iterators, and the other takes a range.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">algorithm</span> <span class="special">{</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">&gt;</span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">BidirectionalIterator</span><span class="special">,</span><span class="identifier">BidirectionalIterator</span><span class="special">&gt;</span>
+<span class="identifier">gather</span> <span class="special">(</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">pivot</span><span class="special">,</span> <span class="identifier">Pred</span> <span class="identifier">pred</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">&gt;</span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</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">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</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">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">&gt;</span>
+<span class="identifier">gather</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRange</span> <span class="special">&amp;</span><span class="identifier">range</span><span class="special">,</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">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">pivot</span><span class="special">,</span> <span class="identifier">Pred</span> <span class="identifier">pred</span> <span class="special">);</span>
+
+<span class="special">}}</span>
+</pre>
+<p>
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.examples"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.examples">Examples</a>
+ </h5>
+<p>
+ Given an sequence containing:
+</p>
+<pre class="programlisting"><span class="number">0</span> <span class="number">1</span> <span class="number">2</span> <span class="number">3</span> <span class="number">4</span> <span class="number">5</span> <span class="number">6</span> <span class="number">7</span> <span class="number">8</span> <span class="number">9</span>
+</pre>
+<p>
+ </p>
+<p>
+ a call to gather ( arr, arr + 10, arr + 4, IsEven ) will result in:
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="number">1</span> <span class="number">3</span> <span class="number">0</span> <span class="number">2</span> <span class="number">4</span> <span class="number">6</span> <span class="number">8</span> <span class="number">5</span> <span class="number">7</span> <span class="number">9</span>
+ <span class="special">|---|-----|</span>
+ <span class="identifier">first</span> <span class="special">|</span> <span class="identifier">second</span>
+ <span class="identifier">pivot</span>
+</pre>
+<p>
+ where <code class="computeroutput"><span class="identifier">first</span></code> and <code class="computeroutput"><span class="identifier">second</span></code> are the fields of the pair that
+ is returned by the call.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h2"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.iterator_requirements"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.iterator_requirements">Iterator
+ Requirements</a>
+ </h5>
+<p>
+ <code class="computeroutput"><span class="identifier">gather</span></code> work on bidirectional
+ iterators or better. This requirement comes from the usage of <code class="computeroutput"><span class="identifier">stable_partition</span></code>, which requires bidirectional
+ iterators. Some standard libraries (libstdc++ and libc++, for example) have
+ implementations of <code class="computeroutput"><span class="identifier">stable_partition</span></code>
+ that work with forward iterators. If that is the case, then <code class="computeroutput"><span class="identifier">gather</span></code> will work with forward iterators
+ as well.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h3"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.storage_requirements"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.storage_requirements">Storage
+ Requirements</a>
+ </h5>
+<p>
+ <code class="computeroutput"><span class="identifier">gather</span></code> uses <code class="computeroutput"><span class="identifier">stable_partition</span></code>, which will attempt to
+ allocate temporary memory, but will work in-situ if there is none available.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h4"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.complexity"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.complexity">Complexity</a>
+ </h5>
+<p>
+ If there is sufficient memory available, the run time is linear: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>
+ </p>
+<p>
+ If there is not any memory available, then the run time is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span>
+ <span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code>.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h5"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.exception_safety"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.exception_safety">Exception
+ Safety</a>
+ </h5>
+<h5>
+<a name="the_boost_algorithm_library.Misc.gather.h6"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.gather.notes"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.gather.notes">Notes</a>
+ </h5>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="the_boost_algorithm_library.Misc.hex"></a><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex" title="hex">hex</a>
+</h3></div></div></div>
+<p>
+ The header file <code class="computeroutput"><span class="char">'boost/algorithm/hex.hpp'</span></code>
+ contains three variants each of two algorithms, <code class="computeroutput"><span class="identifier">hex</span></code>
+ and <code class="computeroutput"><span class="identifier">unhex</span></code>. They are inverse
+ algorithms; that is, one undoes the effort of the other. <code class="computeroutput"><span class="identifier">hex</span></code>
+ takes a sequence of values, and turns them into hexadecimal characters.
+ <code class="computeroutput"><span class="identifier">unhex</span></code> takes a sequence of
+ hexadecimal characters, and outputs a sequence of values.
+ </p>
+<p>
+ <code class="computeroutput"><span class="identifier">hex</span></code> and <code class="computeroutput"><span class="identifier">unhex</span></code>
+ come from MySQL, where they are used in database queries and stored procedures.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.interface"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.interface">interface</a>
+ </h5>
+<p>
+ The function <code class="computeroutput"><span class="identifier">hex</span></code> takes a
+ sequence of values and writes hexadecimal characters. There are three different
+ interfaces, differing only in how the input sequence is specified.
+ </p>
+<p>
+ The first one takes an iterator pair. The second one takes a pointer to the
+ start of a zero-terminated sequence, such as a c string, and the third takes
+ a range as defined by the Boost.Range library.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">hex</span> <span class="special">(</span> <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">hex</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="identifier">ptr</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">hex</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&amp;</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+</pre>
+<p>
+ </p>
+<p>
+ <code class="computeroutput"><span class="identifier">hex</span></code> writes only values in
+ the range '0'..'9' and 'A'..'F', but is not limited to character output.
+ The output iterator could refer to a wstring, or a vector of integers, or
+ any other integral type.
+ </p>
+<p>
+ The function <code class="computeroutput"><span class="identifier">unhex</span></code> takes
+ the output of <code class="computeroutput"><span class="identifier">hex</span></code> and turns
+ it back into a sequence of values.
+ </p>
+<p>
+ The input parameters for the different variations of <code class="computeroutput"><span class="identifier">unhex</span></code>
+ are the same as <code class="computeroutput"><span class="identifier">hex</span></code>.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">unhex</span> <span class="special">(</span> <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">unhex</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="identifier">ptr</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+
+<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutputIterator</span><span class="special">&gt;</span>
+<span class="identifier">OutputIterator</span> <span class="identifier">unhex</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&amp;</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="identifier">out</span> <span class="special">);</span>
+</pre>
+<p>
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.error_handling"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.error_handling">Error
+ Handling</a>
+ </h5>
+<p>
+ The header 'hex.hpp' defines three exception classes:
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">hex_decode_error</span><span class="special">:</span> <span class="keyword">virtual</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">exception</span><span class="special">,</span> <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">exception</span> <span class="special">{};</span>
+<span class="keyword">struct</span> <span class="identifier">not_enough_input</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">hex_decode_error</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">non_hex_input</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">hex_decode_error</span><span class="special">;</span>
+</pre>
+<p>
+ </p>
+<p>
+ If the input to <code class="computeroutput"><span class="identifier">unhex</span></code> does
+ not contain an "even number" of hex digits, then an exception of
+ type <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">::</span><span class="identifier">not_enough_input</span></code> is thrown.
+ </p>
+<p>
+ If the input to <code class="computeroutput"><span class="identifier">unhex</span></code> contains
+ any non-hexadecimal characters, then an exception of type <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">::</span><span class="identifier">non_hex_input</span></code>
+ is thrown.
+ </p>
+<p>
+ If you want to catch all the decoding errors, you can catch exceptions of
+ type <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">::</span><span class="identifier">hex_decode_error</span></code>.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h2"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.examples"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.examples">Examples</a>
+ </h5>
+<p>
+ Assuming that <code class="computeroutput"><span class="identifier">out</span></code> is an iterator
+ that accepts <code class="computeroutput"><span class="keyword">char</span></code> values, and
+ <code class="computeroutput"><span class="identifier">wout</span></code> accepts <code class="computeroutput"><span class="keyword">wchar_t</span></code> values (and that sizeof ( wchar_t
+ ) == 2)
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="identifier">hex</span> <span class="special">(</span> <span class="string">"abcdef"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"616263646566"</span>
+<span class="identifier">hex</span> <span class="special">(</span> <span class="string">"32"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"3332"</span>
+<span class="identifier">hex</span> <span class="special">(</span> <span class="string">"abcdef"</span><span class="special">,</span> <span class="identifier">wout</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"006100620063006400650066"</span>
+<span class="identifier">hex</span> <span class="special">(</span> <span class="string">"32"</span><span class="special">,</span> <span class="identifier">wout</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"00330032"</span>
+
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"616263646566"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"abcdef"</span>
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"3332"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"32"</span>
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"616263646566"</span><span class="special">,</span> <span class="identifier">wout</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"\6162\6364\6566"</span> <span class="special">(</span> <span class="identifier">i</span><span class="special">.</span><span class="identifier">e</span><span class="special">,</span> <span class="identifier">a</span> <span class="number">3</span> <span class="identifier">character</span> <span class="identifier">string</span> <span class="special">)</span>
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"3332"</span><span class="special">,</span> <span class="identifier">wout</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="string">"\3233"</span> <span class="special">(</span> <span class="identifier">U</span><span class="special">+</span><span class="number">3332</span><span class="special">,</span> <span class="identifier">SQUARE</span> <span class="identifier">HUARADDO</span> <span class="special">)</span>
+
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"3"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="identifier">Error</span> <span class="special">-</span> <span class="keyword">not</span> <span class="identifier">enough</span> <span class="identifier">input</span>
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"32"</span><span class="special">,</span> <span class="identifier">wout</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="identifier">Error</span> <span class="special">-</span> <span class="keyword">not</span> <span class="identifier">enough</span> <span class="identifier">input</span>
+
+<span class="identifier">unhex</span> <span class="special">(</span> <span class="string">"ACEG"</span><span class="special">,</span> <span class="identifier">out</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="identifier">Error</span> <span class="special">-</span> <span class="identifier">non</span><span class="special">-</span><span class="identifier">hex</span> <span class="identifier">input</span>
+</pre>
+<p>
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h3"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.iterator_requirements"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.iterator_requirements">Iterator
+ Requirements</a>
+ </h5>
+<p>
+ <code class="computeroutput"><span class="identifier">hex</span></code> and <code class="computeroutput"><span class="identifier">unhex</span></code>
+ work on all iterator types.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h4"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.complexity"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.complexity">Complexity</a>
+ </h5>
+<p>
+ All of the variants of <code class="computeroutput"><span class="identifier">hex</span></code>
+ and <code class="computeroutput"><span class="identifier">unhex</span></code> run in <span class="emphasis"><em>O(N)</em></span>
+ (linear) time; that is, that is, they process each element in the input sequence
+ once.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h5"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.exception_safety"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.exception_safety">Exception
+ Safety</a>
+ </h5>
+<p>
+ All of the variants of <code class="computeroutput"><span class="identifier">hex</span></code>
+ and <code class="computeroutput"><span class="identifier">unhex</span></code> take their parameters
+ by value or const reference, and do not depend upon any global state. Therefore,
+ all the routines in this file provide the strong exception guarantee. However,
+ when working on input iterators, if an exception is thrown, the input iterators
+ will not be reset to their original values (i.e, the characters read from
+ the iterator cannot be un-read)
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.hex.h6"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.hex.notes"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.hex.notes">Notes</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+ <code class="computeroutput"><span class="identifier">hex</span></code> and <code class="computeroutput"><span class="identifier">unhex</span></code> both do nothing when passed empty
+ ranges.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="the_boost_algorithm_library.Misc.is_palindrome"></a><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome" title="is_palindrome">is_palindrome</a>
+</h3></div></div></div>
+<p>
+ The header file 'is_palindrome.hpp' contains six variants of a single algorithm,
+ is_palindrome. The algorithm tests the sequence and returns true if the sequence
+ is a palindrome; i.e, it is identical when traversed either backwards or
+ frontwards.
+ </p>
+<p>
+ The routine <code class="computeroutput"><span class="identifier">is_palindrome</span></code>
+ takes a sequence and, optionally, a predicate. It will return true if the
+ predicate returns true for tested elements by algorithm in the sequence.
+ </p>
+<p>
+ The routine come in 6 forms; the first one takes two iterators to define
+ the range. The second form takes two iterators to define the range and a
+ predicate. The third form takes a single range parameter, and uses Boost.Range
+ to traverse it. The fourth form takes a single range parameter ( uses Boost.Range
+ to traverse it) and a predicate. The fifth form takes a single C-string and
+ a predicate. The sixth form takes a single C-string.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h0"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.interface"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.interface">interface</a>
+ </h5>
+<p>
+ The function <code class="computeroutput"><span class="identifier">is_palindrome</span></code>
+ returns true if the predicate returns true any tested by algorithm items
+ in the sequence. There are six versions: 1) takes two iterators. 2) takes
+ two iterators and a predicate. 3) takes a range. 4) takes a range and a predicate.
+ 5) takes a C-string and a predicate. 6) takes a C-string.
+ </p>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">BidirectionalIterator</span><span class="special">&gt;</span>
+ <span class="keyword">bool</span> <span class="identifier">is_palindrome</span> <span class="special">(</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">begin</span><span class="special">,</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">end</span> <span class="special">);</span>
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">&gt;</span>
+ <span class="keyword">bool</span> <span class="identifier">is_palindrome</span> <span class="special">(</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">begin</span><span class="special">,</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">end</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span>
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><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="identifier">Range</span> <span class="special">&amp;</span><span class="identifier">r</span> <span class="special">);</span>
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><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="identifier">Range</span> <span class="special">&amp;</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span>
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Predicate</span><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> <span class="identifier">str</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</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> <span class="identifier">str</span><span class="special">);</span>
+</pre>
+<p>
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h1"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.examples"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.examples">Examples</a>
+ </h5>
+<p>
+ Given the containers: const std::list&lt;int&gt; empty, const std::vector&lt;char&gt;
+ singleElement{'z'}, int oddNonPalindrome[] = {3,2,2}, const int oddPalindrome[]
+ = {1,2,3,2,1}, const int evenPalindrome[] = {1,2,2,1}, int evenNonPalindrome[]
+ = {1,4,8,8}, then
+</p>
+<pre class="programlisting"><span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">empty</span><span class="special">))</span> <span class="special">--&gt;</span> <span class="keyword">true</span> <span class="comment">//empty range </span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">singleElement</span><span class="special">))</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">oddNonPalindrome</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">oddNonPalindrome</span><span class="special">)))</span> <span class="special">--&gt;</span> <span class="keyword">false</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">evenPalindrome</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">evenPalindrome</span><span class="special">)))</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">empty</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">empty</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">functorComparator</span><span class="special">()))</span> <span class="special">--&gt;</span> <span class="keyword">true</span> <span class="comment">//empty range </span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">oddNonPalindrome</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">oddNonPalindrome</span><span class="special">),</span> <span class="identifier">funcComparator</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;))</span> <span class="special">--&gt;</span> <span class="keyword">false</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">oddPalindrome</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">oddPalindrome</span><span class="special">))</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">evenPalindrome</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;()))</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">evenNonPalindrome</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">evenNonPalindrome</span><span class="special">))</span> <span class="special">--&gt;</span> <span class="keyword">false</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="string">"a"</span><span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+<span class="identifier">is_palindrome</span><span class="special">(</span><span class="string">"aba"</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">&gt;())</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
+</pre>
+<p>
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h2"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.iterator_requirements"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.iterator_requirements">Iterator
+ Requirements</a>
+ </h5>
+<p>
+ <code class="computeroutput"><span class="identifier">is_palindrome</span></code> work on Bidirectional
+ and RandomAccess iterators.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h3"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.complexity"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.complexity">Complexity</a>
+ </h5>
+<p>
+ All of the variants of <code class="computeroutput"><span class="identifier">is_palindrome</span></code>
+ run in <span class="emphasis"><em>O(N)</em></span> (linear) time; that is, they compare against
+ each element in the list once. If any of the comparisons not succeed, the
+ algorithm will terminate immediately, without examining the remaining members
+ of the sequence.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h4"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.exception_safety"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.exception_safety">Exception
+ Safety</a>
+ </h5>
+<p>
+ All of the variants of <code class="computeroutput"><span class="identifier">is_palindrome</span></code>
+ take their parameters by value, const pointer or const reference, and do
+ not depend upon any global state. Therefore, all the routines in this file
+ provide the strong exception guarantee.
+ </p>
+<h5>
+<a name="the_boost_algorithm_library.Misc.is_palindrome.h5"></a>
+ <span class="phrase"><a name="the_boost_algorithm_library.Misc.is_palindrome.notes"></a></span><a class="link" href="Misc.html#the_boost_algorithm_library.Misc.is_palindrome.notes">Notes</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem">
+ <code class="computeroutput"><span class="identifier">is_palindrome</span></code> returns
+ true for empty ranges, const char* null pointers and for single element
+ ranges.
+ </li>
+<li class="listitem">
+ If you use version of 'is_palindrome' without custom predicate, 'is_palindrome'
+ uses default 'operator==()' for elements.
+ </li>
+<li class="listitem">
+ Be careful with using not null pointer 'const char*' without '\0' - if
+ you use it with 'is_palindrome', it's a undefined behaviour.
+ </li>
+</ul></div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ 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>)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="CXX14.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithm.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="reference.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>