Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / algorithm / doc / html / algorithm / reference.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Reference</title>
5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../index.html" title="The Boost Algorithm Library">
8 <link rel="up" href="../index.html" title="The Boost Algorithm Library">
9 <link rel="prev" href="not_yet_documented_other_algos.html" title="Not-yet-documented Other Algorithms">
10 <link rel="next" href="../boost/algorithm/power_idm44730867881760.html" title="Function template power">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="not_yet_documented_other_algos.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/algorithm/power_idm44730867881760.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="section">
26 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
27 <a name="algorithm.reference"></a>Reference</h2></div></div></div>
28 <div class="toc"><dl class="toc">
29 <dt><span class="section"><a href="reference.html#header.boost.algorithm.algorithm_hpp">Header &lt;boost/algorithm/algorithm.hpp&gt;</a></span></dt>
30 <dd><dl></dl></dd>
31 <dt><span class="section"><a href="../header/boost/algorithm/apply_permutation_hpp.html">Header &lt;boost/algorithm/apply_permutation.hpp&gt;</a></span></dt>
32 <dt><span class="section"><a href="../header/boost/algorithm/clamp_hpp.html">Header &lt;boost/algorithm/clamp.hpp&gt;</a></span></dt>
33 <dd><dl></dl></dd>
34 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/all_of_hpp.html">Header &lt;boost/algorithm/cxx11/all_of.hpp&gt;</a></span></dt>
35 <dd><dl></dl></dd>
36 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/any_of_hpp.html">Header &lt;boost/algorithm/cxx11/any_of.hpp&gt;</a></span></dt>
37 <dd><dl></dl></dd>
38 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/copy_if_hpp.html">Header &lt;boost/algorithm/cxx11/copy_if.hpp&gt;</a></span></dt>
39 <dd><dl></dl></dd>
40 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/copy_n_hpp.html">Header &lt;boost/algorithm/cxx11/copy_n.hpp&gt;</a></span></dt>
41 <dd><dl></dl></dd>
42 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/find_if_not_hpp.html">Header &lt;boost/algorithm/cxx11/find_if_not.hpp&gt;</a></span></dt>
43 <dd><dl></dl></dd>
44 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/iota_hpp.html">Header &lt;boost/algorithm/cxx11/iota.hpp&gt;</a></span></dt>
45 <dd><dl></dl></dd>
46 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/is_partitioned_hpp.html">Header &lt;boost/algorithm/cxx11/is_partitioned.hpp&gt;</a></span></dt>
47 <dd><dl></dl></dd>
48 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/is_permutation_hpp.html">Header &lt;boost/algorithm/cxx11/is_permutation.hpp&gt;</a></span></dt>
49 <dd><dl></dl></dd>
50 <dt><span class="section"><a href="../header/boost/algorithm/cxx14/is_permutation_hpp.html">Header &lt;boost/algorithm/cxx14/is_permutation.hpp&gt;</a></span></dt>
51 <dd><dl></dl></dd>
52 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/is_sorted_hpp.html">Header &lt;boost/algorithm/cxx11/is_sorted.hpp&gt;</a></span></dt>
53 <dd><dl></dl></dd>
54 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/none_of_hpp.html">Header &lt;boost/algorithm/cxx11/none_of.hpp&gt;</a></span></dt>
55 <dd><dl></dl></dd>
56 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/one_of_hpp.html">Header &lt;boost/algorithm/cxx11/one_of.hpp&gt;</a></span></dt>
57 <dd><dl></dl></dd>
58 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/partition_copy_hpp.html">Header &lt;boost/algorithm/cxx11/partition_copy.hpp&gt;</a></span></dt>
59 <dd><dl></dl></dd>
60 <dt><span class="section"><a href="../header/boost/algorithm/cxx11/partition_point_hpp.html">Header &lt;boost/algorithm/cxx11/partition_point.hpp&gt;</a></span></dt>
61 <dd><dl></dl></dd>
62 <dt><span class="section"><a href="../header/boost/algorithm/cxx14/equal_hpp.html">Header &lt;boost/algorithm/cxx14/equal.hpp&gt;</a></span></dt>
63 <dd><dl></dl></dd>
64 <dt><span class="section"><a href="../header/boost/algorithm/cxx14/mismatch_hpp.html">Header &lt;boost/algorithm/cxx14/mismatch.hpp&gt;</a></span></dt>
65 <dd><dl></dl></dd>
66 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/exclusive_scan_hpp.html">Header &lt;boost/algorithm/cxx17/exclusive_scan.hpp&gt;</a></span></dt>
67 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/for_each_n_hpp.html">Header &lt;boost/algorithm/cxx17/for_each_n.hpp&gt;</a></span></dt>
68 <dd><dl></dl></dd>
69 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/inclusive_scan_hpp.html">Header &lt;boost/algorithm/cxx17/inclusive_scan.hpp&gt;</a></span></dt>
70 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/reduce_hpp.html">Header &lt;boost/algorithm/cxx17/reduce.hpp&gt;</a></span></dt>
71 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/transform_exclusive_scan_hpp.html">Header &lt;boost/algorithm/cxx17/transform_exclusive_scan.hpp&gt;</a></span></dt>
72 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/transform_inclusive_scan_hpp.html">Header &lt;boost/algorithm/cxx17/transform_inclusive_scan.hpp&gt;</a></span></dt>
73 <dt><span class="section"><a href="../header/boost/algorithm/cxx17/transform_reduce_hpp.html">Header &lt;boost/algorithm/cxx17/transform_reduce.hpp&gt;</a></span></dt>
74 <dt><span class="section"><a href="../header/boost/algorithm/find_backward_hpp.html">Header &lt;boost/algorithm/find_backward.hpp&gt;</a></span></dt>
75 <dt><span class="section"><a href="../header/boost/algorithm/find_not_hpp.html">Header &lt;boost/algorithm/find_not.hpp&gt;</a></span></dt>
76 <dt><span class="section"><a href="../header/boost/algorithm/gather_hpp.html">Header &lt;boost/algorithm/gather.hpp&gt;</a></span></dt>
77 <dt><span class="section"><a href="../header/boost/algorithm/hex_hpp.html">Header &lt;boost/algorithm/hex.hpp&gt;</a></span></dt>
78 <dd><dl></dl></dd>
79 <dt><span class="section"><a href="../header/boost/algorithm/is_palindrome_hpp.html">Header &lt;boost/algorithm/is_palindrome.hpp&gt;</a></span></dt>
80 <dd><dl></dl></dd>
81 <dt><span class="section"><a href="../header/boost/algorithm/is_partitioned_until_hpp.html">Header &lt;boost/algorithm/is_partitioned_until.hpp&gt;</a></span></dt>
82 <dd><dl></dl></dd>
83 <dt><span class="section"><a href="../header/boost/algorithm/minmax_hpp.html">Header &lt;boost/algorithm/minmax.hpp&gt;</a></span></dt>
84 <dt><span class="section"><a href="../header/boost/algorithm/minmax_element_hpp.html">Header &lt;boost/algorithm/minmax_element.hpp&gt;</a></span></dt>
85 <dt><span class="section"><a href="../header/boost/algorithm/searching/boyer_moore_hpp.html">Header &lt;boost/algorithm/searching/boyer_moore.hpp&gt;</a></span></dt>
86 <dd><dl></dl></dd>
87 <dt><span class="section"><a href="../header/boost/algorithm/searching/boyer_moore_horspool_hpp.html">Header &lt;boost/algorithm/searching/boyer_moore_horspool.hpp&gt;</a></span></dt>
88 <dd><dl></dl></dd>
89 <dt><span class="section"><a href="../header/boost/algorithm/searching/knuth_morris_pratt_hpp.html">Header &lt;boost/algorithm/searching/knuth_morris_pratt.hpp&gt;</a></span></dt>
90 <dd><dl></dl></dd>
91 <dt><span class="section"><a href="../header/boost/algorithm/sort_subrange_hpp.html">Header &lt;boost/algorithm/sort_subrange.hpp&gt;</a></span></dt>
92 <dt><span class="section"><a href="../header/boost/algorithm/string_hpp.html">Header &lt;boost/algorithm/string.hpp&gt;</a></span></dt>
93 <dt><span class="section"><a href="../header/boost/algorithm/string_regex_hpp.html">Header &lt;boost/algorithm/string_regex.hpp&gt;</a></span></dt>
94 </dl></div>
95 <div class="section">
96 <div class="titlepage"><div><div><h3 class="title">
97 <a name="header.boost.algorithm.algorithm_hpp"></a>Header &lt;<a href="../../../../../boost/algorithm/algorithm.hpp" target="_top">boost/algorithm/algorithm.hpp</a>&gt;</h3></div></div></div>
98 <p>Misc Algorithms. </p>
99 <p>Marshall Clow </p>
100 <p>
101
102 </p>
103 <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
104   <span class="keyword">namespace</span> <span class="identifier">algorithm</span> <span class="special">{</span>
105     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> 
106       <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">T</span> <a name="boost.algorithm.identity_idm44730867886528"></a><span class="identifier">identity_operation</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">multiplies</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
107     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> 
108       <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">T</span> <a name="boost.algorithm.identity_idm44730867884144"></a><span class="identifier">identity_operation</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">plus</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
109     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Integer<span class="special">&gt;</span> 
110       <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_integral</span><span class="special">&lt;</span> <span class="identifier">Integer</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
111       <a class="link" href="../boost/algorithm/power_idm44730867881760.html" title="Function template power"><span class="identifier">power</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">Integer</span><span class="special">)</span><span class="special">;</span>
112     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Integer<span class="special">,</span> <span class="keyword">typename</span> Operation<span class="special">&gt;</span> 
113       <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_integral</span><span class="special">&lt;</span> <span class="identifier">Integer</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
114       <a class="link" href="../boost/algorithm/power_idm44730867928160.html" title="Function template power"><span class="identifier">power</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">Integer</span><span class="special">,</span> <span class="identifier">Operation</span><span class="special">)</span><span class="special">;</span>
115   <span class="special">}</span>
116 <span class="special">}</span></pre>
117 </div>
118 </div>
119 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
120 <td align="left"></td>
121 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
122         Distributed under the Boost Software License, Version 1.0. (See accompanying
123         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>)
124       </p>
125 </div></td>
126 </tr></table>
127 <hr>
128 <div class="spirit-nav">
129 <a accesskey="p" href="not_yet_documented_other_algos.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/algorithm/power_idm44730867881760.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
130 </div>
131 </body>
132 </html>