Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / group___color_base_algorithm_for_each.html
1 <!-- HTML header for doxygen 1.8.13-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7     <meta name="generator" content="Doxygen 1.8.15"/>
8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
9     <title>Generic Image Library: static_for_each</title>
10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
11     <script type="text/javascript" src="jquery.js"></script>
12     <script type="text/javascript" src="dynsections.js"></script>
13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
15   </head>
16   <body>
17     <div class="boost-header">
18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
19         <tr>
20           <td valign="top" width="300">
21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
22           </td>
23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
24           <td></td>
25         </tr>
26       </table>
27     </div>
28     <hr/>
29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30 <!-- Generated by Doxygen 1.8.15 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 </div><!-- top -->
41 <div class="header">
42   <div class="summary">
43 <a href="#func-members">Functions</a>  </div>
44   <div class="headertitle">
45 <div class="title">static_for_each<div class="ingroups"><a class="el" href="group___color_base.html">ColorBase</a> &raquo; <a class="el" href="group___color_base_algorithm.html">Algorithms and Utility Functions</a></div></div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>Equivalent to std::for_each. Pairs the elements semantically.  
50 <a href="#details">More...</a></p>
51 <table class="memberdecls">
52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
53 Functions</h2></td></tr>
54 <tr class="memitem:ga6439d45959012e0d90d59120056f5fc2"><td class="memTemplParams" colspan="2"><a id="ga6439d45959012e0d90d59120056f5fc2"></a>
55 template&lt;typename P1 , typename Op &gt; </td></tr>
56 <tr class="memitem:ga6439d45959012e0d90d59120056f5fc2"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, Op op)</td></tr>
57 <tr class="separator:ga6439d45959012e0d90d59120056f5fc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:ga9500f85472d587396e7ae4d3b68e79e5"><td class="memTemplParams" colspan="2"><a id="ga9500f85472d587396e7ae4d3b68e79e5"></a>
59 template&lt;typename P1 , typename Op &gt; </td></tr>
60 <tr class="memitem:ga9500f85472d587396e7ae4d3b68e79e5"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, Op op)</td></tr>
61 <tr class="separator:ga9500f85472d587396e7ae4d3b68e79e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:ga2629b12a613ebf032aa6a062a33e8332"><td class="memTemplParams" colspan="2"><a id="ga2629b12a613ebf032aa6a062a33e8332"></a>
63 template&lt;typename P1 , typename P2 , typename Op &gt; </td></tr>
64 <tr class="memitem:ga2629b12a613ebf032aa6a062a33e8332"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, P2 &amp;p2, Op op)</td></tr>
65 <tr class="separator:ga2629b12a613ebf032aa6a062a33e8332"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:gaefa4d8a8c5bd7964b91fc9d6218bb083"><td class="memTemplParams" colspan="2"><a id="gaefa4d8a8c5bd7964b91fc9d6218bb083"></a>
67 template&lt;typename P1 , typename P2 , typename Op &gt; </td></tr>
68 <tr class="memitem:gaefa4d8a8c5bd7964b91fc9d6218bb083"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, const P2 &amp;p2, Op op)</td></tr>
69 <tr class="separator:gaefa4d8a8c5bd7964b91fc9d6218bb083"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:ga809b3d09ade861e387737f0d1a87555a"><td class="memTemplParams" colspan="2"><a id="ga809b3d09ade861e387737f0d1a87555a"></a>
71 template&lt;typename P1 , typename P2 , typename Op &gt; </td></tr>
72 <tr class="memitem:ga809b3d09ade861e387737f0d1a87555a"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, P2 &amp;p2, Op op)</td></tr>
73 <tr class="separator:ga809b3d09ade861e387737f0d1a87555a"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:ga54999159627f3c14461144fbb0e8ff1c"><td class="memTemplParams" colspan="2"><a id="ga54999159627f3c14461144fbb0e8ff1c"></a>
75 template&lt;typename P1 , typename P2 , typename Op &gt; </td></tr>
76 <tr class="memitem:ga54999159627f3c14461144fbb0e8ff1c"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, const P2 &amp;p2, Op op)</td></tr>
77 <tr class="separator:ga54999159627f3c14461144fbb0e8ff1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:ga47cab7cc4a0a4e07dbd16940f0e15872"><td class="memTemplParams" colspan="2"><a id="ga47cab7cc4a0a4e07dbd16940f0e15872"></a>
79 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
80 <tr class="memitem:ga47cab7cc4a0a4e07dbd16940f0e15872"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, P2 &amp;p2, P3 &amp;p3, Op op)</td></tr>
81 <tr class="separator:ga47cab7cc4a0a4e07dbd16940f0e15872"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:gaa872f002cb457a480830b661e4cb1501"><td class="memTemplParams" colspan="2"><a id="gaa872f002cb457a480830b661e4cb1501"></a>
83 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
84 <tr class="memitem:gaa872f002cb457a480830b661e4cb1501"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, P2 &amp;p2, const P3 &amp;p3, Op op)</td></tr>
85 <tr class="separator:gaa872f002cb457a480830b661e4cb1501"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:gae067099f543ea60b0bfea499ec757b8e"><td class="memTemplParams" colspan="2"><a id="gae067099f543ea60b0bfea499ec757b8e"></a>
87 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
88 <tr class="memitem:gae067099f543ea60b0bfea499ec757b8e"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, const P2 &amp;p2, P3 &amp;p3, Op op)</td></tr>
89 <tr class="separator:gae067099f543ea60b0bfea499ec757b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:ga4118ab4f77a2d1965a131867ccf24073"><td class="memTemplParams" colspan="2"><a id="ga4118ab4f77a2d1965a131867ccf24073"></a>
91 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
92 <tr class="memitem:ga4118ab4f77a2d1965a131867ccf24073"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (P1 &amp;p1, const P2 &amp;p2, const P3 &amp;p3, Op op)</td></tr>
93 <tr class="separator:ga4118ab4f77a2d1965a131867ccf24073"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:ga6500a150214edd60e21741a1fd2d87fe"><td class="memTemplParams" colspan="2"><a id="ga6500a150214edd60e21741a1fd2d87fe"></a>
95 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
96 <tr class="memitem:ga6500a150214edd60e21741a1fd2d87fe"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, P2 &amp;p2, P3 &amp;p3, Op op)</td></tr>
97 <tr class="separator:ga6500a150214edd60e21741a1fd2d87fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:gaabe10e33248e294516227d7e82a5ca02"><td class="memTemplParams" colspan="2"><a id="gaabe10e33248e294516227d7e82a5ca02"></a>
99 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
100 <tr class="memitem:gaabe10e33248e294516227d7e82a5ca02"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, P2 &amp;p2, const P3 &amp;p3, Op op)</td></tr>
101 <tr class="separator:gaabe10e33248e294516227d7e82a5ca02"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:gab0ace3e561ffa36108f508a640616398"><td class="memTemplParams" colspan="2"><a id="gab0ace3e561ffa36108f508a640616398"></a>
103 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
104 <tr class="memitem:gab0ace3e561ffa36108f508a640616398"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, const P2 &amp;p2, P3 &amp;p3, Op op)</td></tr>
105 <tr class="separator:gab0ace3e561ffa36108f508a640616398"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:ga3dc095876df2e23652b9f5f007d0b5ec"><td class="memTemplParams" colspan="2"><a id="ga3dc095876df2e23652b9f5f007d0b5ec"></a>
107 template&lt;typename P1 , typename P2 , typename P3 , typename Op &gt; </td></tr>
108 <tr class="memitem:ga3dc095876df2e23652b9f5f007d0b5ec"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_for_each</b> (const P1 &amp;p1, const P2 &amp;p2, const P3 &amp;p3, Op op)</td></tr>
109 <tr class="separator:ga3dc095876df2e23652b9f5f007d0b5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 </table>
111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
112 <p>Equivalent to std::for_each. Pairs the elements semantically. </p>
113 <p>Example: Use static_for_each to increment a planar pixel iterator </p><div class="fragment"><div class="line"><span class="keyword">struct </span>increment {</div><div class="line">    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Incrementable&gt;</div><div class="line">    <span class="keywordtype">void</span> operator()(Incrementable&amp; x)<span class="keyword"> const </span>{ ++x; }</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> ColorBase&gt;</div><div class="line"><span class="keywordtype">void</span> increment_elements(ColorBase&amp; cb) {</div><div class="line">    static_for_each(cb, increment());</div><div class="line">}</div><div class="line"></div><div class="line">uint8_t red[2], green[2], blue[2];</div><div class="line">rgb8c_planar_ptr_t p1(red,green,blue);</div><div class="line">rgb8c_planar_ptr_t p2=p1;</div><div class="line">increment_elements(p1);</div><div class="line">++p2;</div><div class="line">assert(p1 == p2);</div></div><!-- fragment --> </div><!-- contents -->
114      <!-- HTML footer for doxygen 1.8.13-->
115      <!-- start footer part -->
116      <hr class="footer"/>
117      <address class="footer">
118       <small>
119         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
120       </small>
121     </address>
122   </body>
123 </html>