diff options
Diffstat (limited to 'libs/algorithm/doc/html/the_boost_algorithm_library')
9 files changed, 1540 insertions, 0 deletions
diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/any_of.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/any_of.html new file mode 100644 index 0000000000..03d6b640d2 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/any_of.html @@ -0,0 +1,183 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>any_of</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="next" href="none_of.html" title="none_of"> +</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="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="none_of.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.any_of"></a><a class="link" href="any_of.html" title="any_of">any_of</a> +</h3></div></div></div> +<p> + The header file 'boost/algorithm/cxx11/any_of.hpp' contains four variants + of a single algorithm, <code class="computeroutput"><span class="identifier">any_of</span></code>. + The algorithm tests the elements of a sequence and returns true if any of + the elements has a particular property. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">any_of</span></code> takes + a sequence and a predicate. It will return true if the predicate returns + true for any element in the sequence. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">any_of_equal</span></code> + takes a sequence and a value. It will return true if any element in the sequence + compares equal to the passed in value. + </p> +<p> + Both routines come in two forms; the first one takes two iterators to define + the range. The second form takes a single range parameter, and uses Boost.Range + to traverse it. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.interface"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.interface">interface</a> + </h5> +<p> + The function <code class="computeroutput"><span class="identifier">any_of</span></code> returns + true if the predicate returns true any item in the sequence. 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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">any_of</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">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</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">></span> + <span class="keyword">bool</span> <span class="identifier">any_of</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</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="special">}}</span> +</pre> +<p> + </p> +<p> + The function <code class="computeroutput"><span class="identifier">any_of_equal</span></code> + is similar to <code class="computeroutput"><span class="identifier">any_of</span></code>, but + instead of taking a predicate to test the elements of the sequence, it takes + a value to compare against. + </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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">any_of_equal</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">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">any_of_equal</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.examples"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.examples">Examples</a> + </h5> +<p> + Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing + <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> + <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>, + then +</p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span> +<span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span> + +<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">;</span> +<span class="identifier">any_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">any_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">any_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">any_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> <span class="comment">// empty range</span> +<span class="identifier">any_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">any_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">any_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="number">99</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> <span class="comment">// empty range</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.iterator_requirements"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.iterator_requirements">Iterator + Requirements</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">any_of</span></code> and <code class="computeroutput"><span class="identifier">any_of_equal</span></code> work on all iterators except + output iterators. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h3"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.complexity"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.complexity">Complexity</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">any_of</span></code> + and <code class="computeroutput"><span class="identifier">any_of_equal</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 succeed, the algorithm + will terminate immediately, without examining the remaining members of the + sequence. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h4"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.exception_safety"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.exception_safety">Exception + Safety</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">any_of</span></code> + and <code class="computeroutput"><span class="identifier">any_of_equal</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. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.any_of.h5"></a> + <span><a name="the_boost_algorithm_library.CXX11.any_of.notes"></a></span><a class="link" href="any_of.html#the_boost_algorithm_library.CXX11.any_of.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The routine <code class="computeroutput"><span class="identifier">any_of</span></code> is + part of the C++11 standard. When compiled using a C++11 implementation, + the implementation from the standard library will be used. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">any_of</span></code> and <code class="computeroutput"><span class="identifier">any_of_equal</span></code> both return false for + empty ranges, no matter what is passed to test against. + </li> +<li class="listitem"> + The second parameter to <code class="computeroutput"><span class="identifier">any_of_value</span></code> + is a template parameter, rather than deduced from the first parameter + (<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">InputIterator</span><span class="special">>::</span><span class="identifier">value_type</span></code>) because that allows more + flexibility for callers, and takes advantage of built-in comparisons + for the type that is pointed to by the iterator. The function is defined + to return true if, for any element in the sequence, the expression <code class="computeroutput"><span class="special">*</span><span class="identifier">iter</span> <span class="special">==</span> <span class="identifier">val</span></code> + evaluates to true (where <code class="computeroutput"><span class="identifier">iter</span></code> + is an iterator to each element in the sequence) + </li> +</ul></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 © 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="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="none_of.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_partitioned.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_partitioned.html new file mode 100644 index 0000000000..4b236a294c --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_partitioned.html @@ -0,0 +1,147 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>is_partitioned</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="is_sorted.html" title="is_sorted"> +<link rel="next" href="partition_point.html" title="partition_point"> +</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="is_sorted.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="partition_point.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.is_partitioned"></a><a class="link" href="is_partitioned.html" title="is_partitioned">is_partitioned + </a> +</h3></div></div></div> +<p> + The header file 'is_partitioned.hpp' contains two variants of a single algorithm, + <code class="computeroutput"><span class="identifier">is_partitioned</span></code>. The algorithm + tests to see if a sequence is partitioned according to a predicate; in other + words, all the items in the sequence that satisfy the predicate are at the + beginning of the sequence. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">is_partitioned</span></code> + takes a sequence and a predicate. It returns true if the sequence is partitioned + according to the predicate. + </p> +<p> + <code class="computeroutput"><span class="identifier">is_partitioned</span></code> come in two + forms; the first one takes two iterators to define the range. The second + form takes a single range parameter, and uses Boost.Range to traverse it. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.interface"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.interface">interface</a> + </h5> +<p> + The function <code class="computeroutput"><span class="identifier">is_partitioned</span></code> + returns true the items in the sequence are separated according to their ability + to satisfy the predicate. There are two versions; one takes two iterators, + and the other takes a range. + </p> +<p> +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_partitioned</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">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</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">></span> + <span class="keyword">bool</span> <span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.examples"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.examples">Examples</a> + </h5> +<p> + Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing + <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> + <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>, + then +</p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span> +<span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span> + +<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> <span class="comment">// empty range</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.iterator_requirements"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.iterator_requirements">Iterator + Requirements</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">is_partitioned</span></code> works on all + iterators except output iterators. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h3"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.complexity"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.complexity">Complexity</a> + </h5> +<p> + Both of the variants of <code class="computeroutput"><span class="identifier">is_partitioned</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 the sequence is found to be not partitioned + at any point, the routine will terminate immediately, without examining the + rest of the elements. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h4"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.exception_safety"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.exception_safety">Exception + Safety</a> + </h5> +<p> + Both of the variants of <code class="computeroutput"><span class="identifier">is_partitioned</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. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_partitioned.h5"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_partitioned.notes"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The iterator-based version of the routine <code class="computeroutput"><span class="identifier">is_partitioned</span></code> + is part of the C++11 standard. When compiled using a C++11 implementation, + the implementation from the standard library will be used. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">is_partitioned</span></code> returns + true for empty ranges, no matter what predicate is passed to test against. + </li> +</ul></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 © 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="is_sorted.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="partition_point.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_sorted.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_sorted.html new file mode 100644 index 0000000000..7a0327c3ef --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/is_sorted.html @@ -0,0 +1,233 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>is_sorted</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="one_of.html" title="one_of"> +<link rel="next" href="is_partitioned.html" title="is_partitioned"> +</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="one_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="is_partitioned.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.is_sorted"></a><a class="link" href="is_sorted.html" title="is_sorted">is_sorted + </a> +</h3></div></div></div> +<p> + The header file <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">cxx11</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + contains functions for determining if a sequence is ordered. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_sorted.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_sorted.is_sorted"></a></span><a class="link" href="is_sorted.html#the_boost_algorithm_library.CXX11.is_sorted.is_sorted">is_sorted</a> + </h5> +<p> + The function <code class="computeroutput"><span class="identifier">is_sorted</span><span class="special">(</span><span class="identifier">sequence</span><span class="special">)</span></code> + determines whether or not a sequence is completely sorted according so some + criteria. If no comparison predicate is specified, then std::less_equal is + used (i.e, the test is to see if the sequence is non-decreasing) + </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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_sorted</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_sorted</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span> <span class="special">);</span> + + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_sorted</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</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"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_sorted</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + Iterator requirements: The <code class="computeroutput"><span class="identifier">is_sorted</span></code> + functions will work on all kinds of iterators (except output iterators). + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_sorted.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_sorted.is_sorted_until"></a></span><a class="link" href="is_sorted.html#the_boost_algorithm_library.CXX11.is_sorted.is_sorted_until">is_sorted_until</a> + </h5> +<p> + If <code class="computeroutput"><span class="identifier">distance</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="special"><</span> <span class="number">2</span></code>, then + <code class="computeroutput"><span class="identifier">is_sorted</span> <span class="special">(</span> + <span class="identifier">first</span><span class="special">,</span> + <span class="identifier">last</span> <span class="special">)</span></code> + returns <code class="computeroutput"><span class="identifier">last</span></code>. Otherwise, + it returns the last iterator i in [first,last] for which the range [first,i) + is sorted. + </p> +<p> + In short, it returns the element in the sequence that is "out of order". + If the entire sequence is sorted (according to the predicate), then it will + return <code class="computeroutput"><span class="identifier">last</span></code>. + </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"><</span><span class="keyword">typename</span> <span class="identifier">ForwardIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</span><span class="special">></span> + <span class="identifier">FI</span> <span class="identifier">is_sorted_until</span> <span class="special">(</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</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"><</span><span class="keyword">typename</span> <span class="identifier">ForwardIterator</span><span class="special">></span> + <span class="identifier">ForwardIterator</span> <span class="identifier">is_sorted_until</span> <span class="special">(</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span> <span class="special">);</span> + + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Pred</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"><</span><span class="keyword">const</span> <span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">is_sorted_until</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</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"><</span><span class="keyword">typename</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"><</span><span class="keyword">const</span> <span class="identifier">R</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">is_sorted_until</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + Iterator requirements: The <code class="computeroutput"><span class="identifier">is_sorted_until</span></code> + functions will work on forward iterators or better. Since they have to return + a place in the input sequence, input iterators will not suffice. + </p> +<p> + Complexity: <code class="computeroutput"><span class="identifier">is_sorted_until</span></code> + will make at most <span class="emphasis"><em>N-1</em></span> calls to the predicate (given + a sequence of length <span class="emphasis"><em>N</em></span>). + </p> +<p> + Examples: + </p> +<p> + Given the sequence <code class="computeroutput"><span class="special">{</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> + <span class="number">3</span><span class="special">,</span> <span class="number">4</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">3</span> <span class="special">}</span></code>, + <code class="computeroutput"><span class="identifier">is_sorted_until</span> <span class="special">(</span> + <span class="identifier">beg</span><span class="special">,</span> + <span class="identifier">end</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="keyword">int</span><span class="special">>())</span></code> + would return an iterator pointing at the second <code class="computeroutput"><span class="number">3</span></code>. + </p> +<p> + Given the sequence <code class="computeroutput"><span class="special">{</span> <span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> + <span class="number">3</span><span class="special">,</span> <span class="number">4</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">9</span> <span class="special">}</span></code>, + <code class="computeroutput"><span class="identifier">is_sorted_until</span> <span class="special">(</span> + <span class="identifier">beg</span><span class="special">,</span> + <span class="identifier">end</span><span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="keyword">int</span><span class="special">>())</span></code> + would return <code class="computeroutput"><span class="identifier">end</span></code>. + </p> +<p> + There are also a set of "wrapper functions" for is_ordered which + make it easy to see if an entire sequence is ordered. These functions return + a boolean indicating success or failure rather than an iterator to where + the out of order items were found. + </p> +<p> + To test if a sequence is increasing (each element at least as large as the + preceeding one): +</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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_increasing</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span> <span class="special">);</span> + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">R</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_increasing</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&</span><span class="identifier">range</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + To test if a sequence is decreasing (each element no larger than the preceeding + one): + </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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_decreasing</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span> <span class="special">);</span> + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">R</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_decreasing</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&</span><span class="identifier">range</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + To test if a sequence is strictly increasing (each element larger than the + preceeding one): +</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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_strictly_increasing</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span> <span class="special">);</span> + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">R</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_strictly_increasing</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&</span><span class="identifier">range</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + To test if a sequence is strictly decreasing (each element smaller than the + preceeding one): +</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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_strictly_decreasing</span> <span class="special">(</span> <span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span> <span class="special">);</span> + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">R</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">is_strictly_decreasing</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&</span><span class="identifier">range</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<p> + Complexity: Each of these calls is just a thin wrapper over <code class="computeroutput"><span class="identifier">is_sorted</span></code>, so they have the same complexity + as <code class="computeroutput"><span class="identifier">is_sorted</span></code>. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.is_sorted.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.is_sorted.notes"></a></span><a class="link" href="is_sorted.html#the_boost_algorithm_library.CXX11.is_sorted.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The routines <code class="computeroutput"><span class="identifier">is_sorted</span></code> + and <code class="computeroutput"><span class="identifier">is_sorted_until</span></code> are + part of the C++11 standard. When compiled using a C++11 implementation, + the implementation from the standard library will be used. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">is_sorted</span></code> and <code class="computeroutput"><span class="identifier">is_sorted_until</span></code> both return true for + empty ranges and ranges of length one. + </li> +</ul></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 © 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="one_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="is_partitioned.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/none_of.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/none_of.html new file mode 100644 index 0000000000..6cd0057629 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/none_of.html @@ -0,0 +1,186 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>none_of</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="any_of.html" title="any_of"> +<link rel="next" href="one_of.html" title="one_of"> +</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="any_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="one_of.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.none_of"></a><a class="link" href="none_of.html" title="none_of">none_of</a> +</h3></div></div></div> +<p> + The header file 'boost/algorithm/cxx11/none_of.hpp' contains four variants + of a single algorithm, <code class="computeroutput"><span class="identifier">none_of</span></code>. + The algorithm tests all the elements of a sequence and returns true if they + none of them share a property. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">none_of</span></code> takes + a sequence and a predicate. It will return true if the predicate returns + false when applied to every element in the sequence. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">none_of_equal</span></code> + takes a sequence and a value. It will return true if none of the elements + in the sequence compare equal to the passed in value. + </p> +<p> + Both routines come in two forms; the first one takes two iterators to define + the range. The second form takes a single range parameter, and uses Boost.Range + to traverse it. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.interface"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.interface">interface</a> + </h5> +<p> + The function <code class="computeroutput"><span class="identifier">none_of</span></code> returns + true if the predicate returns false for every item in the sequence. 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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">none_of</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">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</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">></span> + <span class="keyword">bool</span> <span class="identifier">none_of</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</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="special">}}</span> +</pre> +<p> + </p> +<p> + The function <code class="computeroutput"><span class="identifier">none_of_equal</span></code> + is similar to <code class="computeroutput"><span class="identifier">none_of</span></code>, but + instead of taking a predicate to test the elements of the sequence, it takes + a value to compare against. + </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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">none_of_equal</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">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">none_of_equal</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.examples"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.examples">Examples</a> + </h5> +<p> + Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing + <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> + <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>, + then +</p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span> +<span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span> + +<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">;</span> + +<span class="identifier">none_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">none_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">none_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">none_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> <span class="comment">// empty range</span> +<span class="identifier">none_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">none_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">none_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="number">99</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> <span class="comment">// empty range</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.iterator_requirements"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.iterator_requirements">Iterator + Requirements</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">none_of</span></code> and <code class="computeroutput"><span class="identifier">none_of_equal</span></code> work on all iterators except + output iterators. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h3"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.complexity"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.complexity">Complexity</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">none_of</span></code> + and <code class="computeroutput"><span class="identifier">none_of_equal</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 succeed, the algorithm + will terminate immediately, without examining the remaining members of the + sequence. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h4"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.exception_safety"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.exception_safety">Exception + Safety</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">none_of</span></code> + and <code class="computeroutput"><span class="identifier">none_of_equal</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. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.none_of.h5"></a> + <span><a name="the_boost_algorithm_library.CXX11.none_of.notes"></a></span><a class="link" href="none_of.html#the_boost_algorithm_library.CXX11.none_of.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The routine <code class="computeroutput"><span class="identifier">none_of</span></code> is + part of the C++11 standard. When compiled using a C++11 implementation, + the implementation from the standard library will be used. + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">none_of</span></code> and <code class="computeroutput"><span class="identifier">none_of_equal</span></code> both return true for + empty ranges, no matter what is passed to test against. + </li> +<li class="listitem"> + The second parameter to <code class="computeroutput"><span class="identifier">none_of_value</span></code> + is a template parameter, rather than deduced from the first parameter + (<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">InputIterator</span><span class="special">>::</span><span class="identifier">value_type</span></code>) because that allows more + flexibility for callers, and takes advantage of built-in comparisons + for the type that is pointed to by the iterator. The function is defined + to return true if, for all elements in the sequence, the expression + <code class="computeroutput"><span class="special">*</span><span class="identifier">iter</span> + <span class="special">==</span> <span class="identifier">val</span></code> + evaluates to false (where <code class="computeroutput"><span class="identifier">iter</span></code> + is an iterator to each element in the sequence) + </li> +</ul></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 © 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="any_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="one_of.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/one_of.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/one_of.html new file mode 100644 index 0000000000..a36220996c --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/one_of.html @@ -0,0 +1,178 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>one_of</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="none_of.html" title="none_of"> +<link rel="next" href="is_sorted.html" title="is_sorted"> +</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="none_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="is_sorted.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.one_of"></a><a class="link" href="one_of.html" title="one_of">one_of</a> +</h3></div></div></div> +<p> + The header file 'boost/algorithm/cxx11/one_of.hpp' contains four variants + of a single algorithm, <code class="computeroutput"><span class="identifier">one_of</span></code>. + The algorithm tests the elements of a sequence and returns true if exactly + one of the elements in the sequence has a particular property. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">one_of</span></code> takes + a sequence and a predicate. It will return true if the predicate returns + true for one element in the sequence. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">one_of_equal</span></code> + takes a sequence and a value. It will return true if one element in the sequence + compares equal to the passed in value. + </p> +<p> + Both routines come in two forms; the first one takes two iterators to define + the range. The second form takes a single range parameter, and uses Boost.Range + to traverse it. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.interface"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.interface">interface</a> + </h5> +<p> + The function <code class="computeroutput"><span class="identifier">one_of</span></code> returns + true if the predicate returns true for one item in the sequence. 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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">one_of</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">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</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">></span> + <span class="keyword">bool</span> <span class="identifier">one_of</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</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="special">}}</span> +</pre> +<p> + </p> +<p> + The function <code class="computeroutput"><span class="identifier">one_of_equal</span></code> + is similar to <code class="computeroutput"><span class="identifier">one_of</span></code>, but + instead of taking a predicate to test the elements of the sequence, it takes + a value to compare against. + </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"><</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">one_of_equal</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">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">V</span><span class="special">></span> + <span class="keyword">bool</span> <span class="identifier">one_of_equal</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">val</span> <span class="special">);</span> +<span class="special">}}</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.examples"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.examples">Examples</a> + </h5> +<p> + Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing + <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> + <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>, + then +</p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span> +<span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span> + +<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">algorithm</span><span class="special">;</span> +<span class="identifier">one_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">one_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">one_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">one_of</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> <span class="comment">// empty range</span> +<span class="identifier">one_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">true</span> +<span class="identifier">one_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="number">3</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> +<span class="identifier">one_of_equal</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="number">99</span> <span class="special">)</span> <span class="special">--></span> <span class="keyword">false</span> <span class="comment">// empty range</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.iterator_requirements"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.iterator_requirements">Iterator + Requirements</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">one_of</span></code> and <code class="computeroutput"><span class="identifier">one_of_equal</span></code> work on all iterators except + output iterators. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h3"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.complexity"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.complexity">Complexity</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">one_of</span></code> + and <code class="computeroutput"><span class="identifier">one_of_equal</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 more than one of the elements in the sequence + satisfy the condition, then algorithm will return false immediately, without + examining the remaining members of the sequence. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h4"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.exception_safety"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.exception_safety">Exception + Safety</a> + </h5> +<p> + All of the variants of <code class="computeroutput"><span class="identifier">one_of</span></code> + and <code class="computeroutput"><span class="identifier">one_of_equal</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. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.one_of.h5"></a> + <span><a name="the_boost_algorithm_library.CXX11.one_of.notes"></a></span><a class="link" href="one_of.html#the_boost_algorithm_library.CXX11.one_of.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">one_of</span></code> and <code class="computeroutput"><span class="identifier">one_of_equal</span></code> both return false for + empty ranges, no matter what is passed to test against. + </li> +<li class="listitem"> + The second parameter to <code class="computeroutput"><span class="identifier">one_of_value</span></code> + is a template parameter, rather than deduced from the first parameter + (<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">InputIterator</span><span class="special">>::</span><span class="identifier">value_type</span></code>) because that allows more + flexibility for callers, and takes advantage of built-in comparisons + for the type that is pointed to by the iterator. The function is defined + to return true if, for one element in the sequence, the expression <code class="computeroutput"><span class="special">*</span><span class="identifier">iter</span> <span class="special">==</span> <span class="identifier">val</span></code> + evaluates to true (where <code class="computeroutput"><span class="identifier">iter</span></code> + is an iterator to each element in the sequence) + </li> +</ul></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 © 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="none_of.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="is_sorted.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/partition_point.html b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/partition_point.html new file mode 100644 index 0000000000..68242bb249 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/CXX11/partition_point.html @@ -0,0 +1,145 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>partition_point</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +<link rel="prev" href="is_partitioned.html" title="is_partitioned"> +<link rel="next" href="../../algorithm/Misc.html" title="Other Algorithms"> +</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="is_partitioned.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="../../algorithm/Misc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.CXX11.partition_point"></a><a class="link" href="partition_point.html" title="partition_point">partition_point + </a> +</h3></div></div></div> +<p> + The header file 'partition_point.hpp' contains two variants of a single algorithm, + <code class="computeroutput"><span class="identifier">partition_point</span></code>. Given a + partitioned sequence and a predicate, the algorithm finds the partition point; + i.e, the first element in the sequence that does not satisfy the predicate. + </p> +<p> + The routine <code class="computeroutput"><span class="identifier">partition_point</span></code> + takes a partitioned sequence and a predicate. It returns an iterator which + 'points to' the first element in the sequence that does not satisfy the predicate. + If all the items in the sequence satisfy the predicate, then it returns one + past the final element in the sequence. + </p> +<p> + <code class="computeroutput"><span class="identifier">partition_point</span></code> come in two + forms; the first one takes two iterators to define the range. The second + form takes a single range parameter, and uses Boost.Range to traverse it. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h0"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.interface"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.interface">interface</a> + </h5> +<p> + There are two versions; one takes two iterators, and the other takes a range. + </p> +<p> +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">ForwardIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">></span> + <span class="identifier">ForwardIterator</span> <span class="identifier">partition_point</span> <span class="special">(</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</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"><</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">></span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">Range</span><span class="special">></span> <span class="identifier">partition_point</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h1"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.examples"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.examples">Examples</a> + </h5> +<p> + Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing + <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> + <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>, + then +</p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special"><</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span> +<span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span> + +<span class="identifier">partition_point</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">4</span> <span class="special">(</span><span class="identifier">pointing</span> <span class="identifier">at</span> <span class="number">14</span><span class="special">)</span> +<span class="identifier">partition_point</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--></span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">4</span> <span class="special">(</span><span class="identifier">pointing</span> <span class="identifier">at</span> <span class="number">14</span><span class="special">)</span> +<span class="identifier">partition_point</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">-></span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span> <span class="special">(</span><span class="identifier">end</span><span class="special">)</span> +<span class="identifier">partition_point</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--></span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">()</span> <span class="comment">// empty range</span> +</pre> +<p> + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h2"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.iterator_requirements"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.iterator_requirements">Iterator + Requirements</a> + </h5> +<p> + <code class="computeroutput"><span class="identifier">partition_point</span></code> requires + forward iterators or better; it will not work on input iterators or output + iterators. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h3"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.complexity"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.complexity">Complexity</a> + </h5> +<p> + Both of the variants of <code class="computeroutput"><span class="identifier">partition_point</span></code> + run in <span class="emphasis"><em>O( log (N))</em></span> (logarithmic) time; that is, the + predicate will be will be applied approximately <span class="emphasis"><em>log(N)</em></span> + times. To do this, however, the algorithm needs to know the size of the sequence. + For forward and bidirectional iterators, calculating the size of the sequence + is an <span class="emphasis"><em>O(N)</em></span> operation. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h4"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.exception_safety"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.exception_safety">Exception + Safety</a> + </h5> +<p> + Both of the variants of <code class="computeroutput"><span class="identifier">partition_point</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. + </p> +<h5> +<a name="the_boost_algorithm_library.CXX11.partition_point.h5"></a> + <span><a name="the_boost_algorithm_library.CXX11.partition_point.notes"></a></span><a class="link" href="partition_point.html#the_boost_algorithm_library.CXX11.partition_point.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + The iterator-based version of the routine <code class="computeroutput"><span class="identifier">partition_point</span></code> + is part of the C++11 standard. When compiled using a C++11 implementation, + the implementation from the standard library will be used. + </li> +<li class="listitem"> + For empty ranges, the partition point is the end of the range. + </li> +</ul></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 © 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="is_partitioned.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.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="../../algorithm/Misc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/Misc/hex.html b/libs/algorithm/doc/html/the_boost_algorithm_library/Misc/hex.html new file mode 100644 index 0000000000..61e4e43027 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/Misc/hex.html @@ -0,0 +1,209 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>hex</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/Misc.html" title="Other Algorithms"> +<link rel="prev" href="../../algorithm/Misc.html" title="Other Algorithms"> +<link rel="next" href="../../algorithm/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="../../algorithm/Misc.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Misc.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="../../algorithm/reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</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="hex.html" 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><a name="the_boost_algorithm_library.Misc.hex.interface"></a></span><a class="link" href="hex.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"><</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="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"><</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">></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"><</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="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">&</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"><</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="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"><</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">></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"><</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="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">&</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><a name="the_boost_algorithm_library.Misc.hex.error_handling"></a></span><a class="link" href="hex.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><a name="the_boost_algorithm_library.Misc.hex.examples"></a></span><a class="link" href="hex.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">--></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">--></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">--></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">--></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">--></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">--></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">--></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">--></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">--></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">--></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">--></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><a name="the_boost_algorithm_library.Misc.hex.iterator_requirements"></a></span><a class="link" href="hex.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><a name="the_boost_algorithm_library.Misc.hex.complexity"></a></span><a class="link" href="hex.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><a name="the_boost_algorithm_library.Misc.hex.exception_safety"></a></span><a class="link" href="hex.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><a name="the_boost_algorithm_library.Misc.hex.notes"></a></span><a class="link" href="hex.html#the_boost_algorithm_library.Misc.hex.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" 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> +<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 © 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="../../algorithm/Misc.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Misc.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="../../algorithm/reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/BoyerMooreHorspool.html b/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/BoyerMooreHorspool.html new file mode 100644 index 0000000000..3bbabd6d40 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/BoyerMooreHorspool.html @@ -0,0 +1,207 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Boyer-Moore-Horspool Search</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/Searching.html" title="Searching Algorithms"> +<link rel="prev" href="../../algorithm/Searching.html" title="Searching Algorithms"> +<link rel="next" href="KnuthMorrisPratt.html" title="Knuth-Morris-Pratt Search"> +</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="../../algorithm/Searching.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Searching.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="KnuthMorrisPratt.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool"></a><a class="link" href="BoyerMooreHorspool.html" title="Boyer-Moore-Horspool Search">Boyer-Moore-Horspool + Search</a> +</h3></div></div></div> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h0"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.overview"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.overview">Overview</a> + </h5> +<p> + The header file 'boyer_moore_horspool.hpp' contains an an implementation + of the Boyer-Moore-Horspool algorithm for searching sequences of values. + </p> +<p> + The Boyer-Moore-Horspool search algorithm was published by Nigel Horspool + in 1980. It is a refinement of the Boyer-Moore algorithm that trades space + for time. It uses less space for internal tables than Boyer-Moore, and has + poorer worst-case performance. + </p> +<p> + The Boyer-Moore-Horspool algorithm cannot be used with comparison predicates + like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">search</span></code>. + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h1"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.interface"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.interface">Interface</a> + </h5> +<p> + Nomenclature: I refer to the sequence being searched for as the "pattern", + and the sequence being searched in as the "corpus". + </p> +<p> + For flexibility, the Boyer-Moore-Horspool algorithm has has two interfaces; + an object-based interface and a procedural one. The object-based interface + builds the tables in the constructor, and uses operator () to perform the + search. The procedural interface builds the table and does the search all + in one step. If you are going to be searching for the same pattern in multiple + corpora, then you should use the object interface, and only build the tables + once. + </p> +<p> + Here is the object interface: +</p> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">patIter</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">boyer_moore_horspool</span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="identifier">boyer_moore_horspool</span> <span class="special">(</span> <span class="identifier">patIter</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">patIter</span> <span class="identifier">last</span> <span class="special">);</span> + <span class="special">~</span><span class="identifier">boyer_moore_horspool</span> <span class="special">();</span> + + <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">corpusIter</span><span class="special">></span> + <span class="identifier">corpusIter</span> <span class="keyword">operator</span> <span class="special">()</span> <span class="special">(</span> <span class="identifier">corpusIter</span> <span class="identifier">corpus_first</span><span class="special">,</span> <span class="identifier">corpusIter</span> <span class="identifier">corpus_last</span> <span class="special">);</span> + <span class="special">};</span> +</pre> +<p> + </p> +<p> + and here is the corresponding procedural interface: + </p> +<p> +</p> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">patIter</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">corpusIter</span><span class="special">></span> +<span class="identifier">corpusIter</span> <span class="identifier">boyer_moore_horspool_search</span> <span class="special">(</span> + <span class="identifier">corpusIter</span> <span class="identifier">corpus_first</span><span class="special">,</span> <span class="identifier">corpusIter</span> <span class="identifier">corpus_last</span><span class="special">,</span> + <span class="identifier">patIter</span> <span class="identifier">pat_first</span><span class="special">,</span> <span class="identifier">patIter</span> <span class="identifier">pat_last</span> <span class="special">);</span> +</pre> +<p> + </p> +<p> + Each of the functions is passed two pairs of iterators. The first two define + the corpus and the second two define the pattern. Note that the two pairs + need not be of the same type, but they do need to "point" at the + same type. In other words, <code class="computeroutput"><span class="identifier">patIter</span><span class="special">::</span><span class="identifier">value_type</span></code> + and <code class="computeroutput"><span class="identifier">curpusIter</span><span class="special">::</span><span class="identifier">value_type</span></code> need to be the same type. + </p> +<p> + The return value of the function is an iterator pointing to the start of + the pattern in the corpus. If the pattern is not found, it returns the end + of the corpus (<code class="computeroutput"><span class="identifier">corpus_last</span></code>). + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h2"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.performance"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.performance">Performance</a> + </h5> +<p> + The execution time of the Boyer-Moore-Horspool algorithm is linear in the + size of the string being searched; it can have a significantly lower constant + factor than many other search algorithms: it doesn't need to check every + character of the string to be searched, but rather skips over some of them. + Generally the algorithm gets faster as the pattern being searched for becomes + longer. Its efficiency derives from the fact that with each unsuccessful + attempt to find a match between the search string and the text it is searching, + it uses the information gained from that attempt to rule out as many positions + of the text as possible where the string cannot match. + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h3"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.memory_use"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.memory_use">Memory + Use</a> + </h5> +<p> + The algorithm an internal table that has one entry for each member of the + "alphabet" in the pattern. For (8-bit) character types, this table + contains 256 entries. + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h4"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.complexity"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.complexity">Complexity</a> + </h5> +<p> + The worst-case performance is <span class="emphasis"><em>O(m x n)</em></span>, where <span class="emphasis"><em>m</em></span> + is the length of the pattern and <span class="emphasis"><em>n</em></span> is the length of + the corpus. The average time is <span class="emphasis"><em>O(n)</em></span>. The best case + performance is sub-linear, and is, in fact, identical to Boyer-Moore, but + the initialization is quicker and the internal loop is simpler than Boyer-Moore. + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h5"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.exception_safety"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.exception_safety">Exception + Safety</a> + </h5> +<p> + Both the object-oriented and procedural versions of the Boyer-Moore-Horspool + algorithm take their parameters by value and do not use any information other + than what is passed in. Therefore, both interfaces provide the strong exception + guarantee. + </p> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h6"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.notes"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.notes">Notes</a> + </h5> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + When using the object-based interface, the pattern must remain unchanged + for during the searches; i.e, from the time the object is constructed + until the final call to operator () returns. + </li> +<li class="listitem"> + The Boyer-Moore-Horspool algorithm requires random-access iterators for + both the pattern and the corpus. + </li> +</ul></div> +<h5> +<a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.h7"></a> + <span><a name="the_boost_algorithm_library.Searching.BoyerMooreHorspool.customization_points"></a></span><a class="link" href="BoyerMooreHorspool.html#the_boost_algorithm_library.Searching.BoyerMooreHorspool.customization_points">Customization + points</a> + </h5> +<p> + The Boyer-Moore-Horspool object takes a traits template parameter which enables + the caller to customize how the precomputed table is stored. This table, + called the skip table, contains (logically) one entry for every possible + value that the pattern can contain. When searching 8-bit character data, + this table contains 256 elements. The traits class defines the table to be + used. + </p> +<p> + The default traits class uses a <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code> + for small 'alphabets' and a <code class="computeroutput"><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">unordered_map</span></code> + for larger ones. The array-based skip table gives excellent performance, + but could be prohibitively large when the 'alphabet' of elements to be searched + grows. The unordered_map based version only grows as the number of unique + elements in the pattern, but makes many more heap allocations, and gives + slower lookup performance. + </p> +<p> + To use a different skip table, you should define your own skip table object + and your own traits class, and use them to instantiate the Boyer-Moore-Horspool + object. The interface to these objects is described TBD. + </p> +</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 © 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="../../algorithm/Searching.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Searching.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="KnuthMorrisPratt.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/KnuthMorrisPratt.html b/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/KnuthMorrisPratt.html new file mode 100644 index 0000000000..8ce2c8fbc9 --- /dev/null +++ b/libs/algorithm/doc/html/the_boost_algorithm_library/Searching/KnuthMorrisPratt.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Knuth-Morris-Pratt Search</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost Algorithm Library"> +<link rel="up" href="../../algorithm/Searching.html" title="Searching Algorithms"> +<link rel="prev" href="BoyerMooreHorspool.html" title="Boyer-Moore-Horspool Search"> +<link rel="next" href="../../algorithm/CXX11.html" title="C++11 Algorithms"> +</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="BoyerMooreHorspool.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Searching.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="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="the_boost_algorithm_library.Searching.KnuthMorrisPratt"></a><a class="link" href="KnuthMorrisPratt.html" title="Knuth-Morris-Pratt Search">Knuth-Morris-Pratt + Search</a> +</h3></div></div></div> +<h5> +<a name="the_boost_algorithm_library.Searching.KnuthMorrisPratt.h0"></a> + <span><a name="the_boost_algorithm_library.Searching.KnuthMorrisPratt.overview"></a></span><a class="link" href="KnuthMorrisPratt.html#the_boost_algorithm_library.Searching.KnuthMorrisPratt.overview">Overview</a> + </h5> +<p> + The header file 'knuth_morris_pratt.hpp' contains an an implementation of + the Knuth-Morris-Pratt algorithm for searching sequences of values. + </p> +</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 © 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="BoyerMooreHorspool.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/Searching.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="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |