Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / group___color_base_algorithm_transform.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_transform</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_transform<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::transform. 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:gab073e83d67d781c3b21b0417ebeff30d"><td class="memTemplParams" colspan="2"><a id="gab073e83d67d781c3b21b0417ebeff30d"></a>
55 template&lt;typename Src , typename Dst , typename Op &gt; </td></tr>
56 <tr class="memitem:gab073e83d67d781c3b21b0417ebeff30d"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (Src &amp;src, Dst &amp;dst, Op op)</td></tr>
57 <tr class="separator:gab073e83d67d781c3b21b0417ebeff30d"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:ga64e2b70f3e73fdd07625026bb8938dd0"><td class="memTemplParams" colspan="2"><a id="ga64e2b70f3e73fdd07625026bb8938dd0"></a>
59 template&lt;typename Src , typename Dst , typename Op &gt; </td></tr>
60 <tr class="memitem:ga64e2b70f3e73fdd07625026bb8938dd0"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (const Src &amp;src, Dst &amp;dst, Op op)</td></tr>
61 <tr class="separator:ga64e2b70f3e73fdd07625026bb8938dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:ga9ae19908ab70281508f3c775fb9babf4"><td class="memTemplParams" colspan="2"><a id="ga9ae19908ab70281508f3c775fb9babf4"></a>
63 template&lt;typename P2 , typename P3 , typename Dst , typename Op &gt; </td></tr>
64 <tr class="memitem:ga9ae19908ab70281508f3c775fb9babf4"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (P2 &amp;p2, P3 &amp;p3, Dst &amp;dst, Op op)</td></tr>
65 <tr class="separator:ga9ae19908ab70281508f3c775fb9babf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:gacb3d3165d43e05ced4b7281574e865cc"><td class="memTemplParams" colspan="2"><a id="gacb3d3165d43e05ced4b7281574e865cc"></a>
67 template&lt;typename P2 , typename P3 , typename Dst , typename Op &gt; </td></tr>
68 <tr class="memitem:gacb3d3165d43e05ced4b7281574e865cc"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (P2 &amp;p2, const P3 &amp;p3, Dst &amp;dst, Op op)</td></tr>
69 <tr class="separator:gacb3d3165d43e05ced4b7281574e865cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:gaa2af229d1dd335a45cdd3de0b773f28b"><td class="memTemplParams" colspan="2"><a id="gaa2af229d1dd335a45cdd3de0b773f28b"></a>
71 template&lt;typename P2 , typename P3 , typename Dst , typename Op &gt; </td></tr>
72 <tr class="memitem:gaa2af229d1dd335a45cdd3de0b773f28b"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (const P2 &amp;p2, P3 &amp;p3, Dst &amp;dst, Op op)</td></tr>
73 <tr class="separator:gaa2af229d1dd335a45cdd3de0b773f28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:gae03fb49f38f4622a927212cdda43970b"><td class="memTemplParams" colspan="2"><a id="gae03fb49f38f4622a927212cdda43970b"></a>
75 template&lt;typename P2 , typename P3 , typename Dst , typename Op &gt; </td></tr>
76 <tr class="memitem:gae03fb49f38f4622a927212cdda43970b"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE Op&#160;</td><td class="memTemplItemRight" valign="bottom"><b>static_transform</b> (const P2 &amp;p2, const P3 &amp;p3, Dst &amp;dst, Op op)</td></tr>
77 <tr class="separator:gae03fb49f38f4622a927212cdda43970b"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 </table>
79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
80 <p>Equivalent to std::transform. Pairs the elements semantically. </p>
81 <p>Example: Write a generic function that adds two pixels into a homogeneous result pixel. </p><div class="fragment"><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Result&gt;</div><div class="line"><span class="keyword">struct </span>my_plus {</div><div class="line">    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T1, <span class="keyword">typename</span> T2&gt;</div><div class="line">    Result operator()(T1 f1, T2 f2)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> f1+f2; }</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Pixel1, <span class="keyword">typename</span> Pixel2, <span class="keyword">typename</span> Pixel3&gt;</div><div class="line"><span class="keywordtype">void</span> sum_channels(<span class="keyword">const</span> Pixel1&amp; p1, <span class="keyword">const</span> Pixel2&amp; p2, Pixel3&amp; result) {</div><div class="line">    <span class="keyword">using</span> result_channel_t = <span class="keyword">typename</span> channel_type&lt;Pixel3&gt;::type;</div><div class="line">    static_transform(p1,p2,result,my_plus&lt;result_channel_t&gt;());</div><div class="line">}</div><div class="line"></div><div class="line">rgb8_pixel_t p1(1,2,3);</div><div class="line">bgr8_pixel_t p2(3,2,1);</div><div class="line">rgb8_pixel_t result;</div><div class="line">sum_channels(p1,p2,result);</div><div class="line">assert(result == rgb8_pixel_t(2,4,6));</div></div><!-- fragment --> </div><!-- contents -->
82      <!-- HTML footer for doxygen 1.8.13-->
83      <!-- start footer part -->
84      <hr class="footer"/>
85      <address class="footer">
86       <small>
87         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
88       </small>
89     </address>
90   </body>
91 </html>