docs/reference/html/group__compose.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libsigc++: compose()</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.99.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">compose()<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p><a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a" title="Creates an adaptor of type sigc::compose1_functor which combines two functors. ">sigc::compose()</a> combines two or three arbitrary functors.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Classes</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor&lt; T_setter, T_getter &gt;</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adaptor that combines two functors.  <a href="structsigc_1_1compose1__functor.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor&lt; T_setter, T_getter1, T_getter2 &gt;</a></td></tr>
  59 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adaptor that combines three functors.  <a href="structsigc_1_1compose2__functor.html#details">More...</a><br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 </table><table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  63 Functions</h2></td></tr>
  64 <tr class="memitem:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memTemplParams" colspan="2">template&lt;class T_setter , class T_getter &gt; </td></tr>
  65 <tr class="memitem:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memTemplItemLeft" align="right" valign="top">compose1_functor&lt; T_setter, T_getter &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a> (const T_setter&amp; _A_setter, const T_getter&amp; _A_getter)</td></tr>
  66 <tr class="memdesc:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1compose1__functor.html" title="Adaptor that combines two functors. ">sigc::compose1_functor</a> which combines two functors.  <a href="#ga34cf5da8f6323bfdc41bc7113d6ad20a">More...</a><br /></td></tr>
  67 <tr class="separator:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memTemplParams" colspan="2">template&lt;class T_setter , class T_getter1 , class T_getter2 &gt; </td></tr>
  69 <tr class="memitem:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memTemplItemLeft" align="right" valign="top">compose2_functor&lt; T_setter, T_getter1, T_getter2 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga4abf2a45eb2307a3dc5d870c86b0450d">sigc::compose</a> (const T_setter&amp; _A_setter, const T_getter1&amp; _A_getter1, const T_getter2&amp; _A_getter2)</td></tr>
  70 <tr class="memdesc:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1compose2__functor.html" title="Adaptor that combines three functors. ">sigc::compose2_functor</a> which combines three functors.  <a href="#ga4abf2a45eb2307a3dc5d870c86b0450d">More...</a><br /></td></tr>
  71 <tr class="separator:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 </table>
  73 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  74 <p><a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a" title="Creates an adaptor of type sigc::compose1_functor which combines two functors. ">sigc::compose()</a> combines two or three arbitrary functors. </p>
  75 <p>On invokation, parameters are passed on to one or two getter functor(s). The return value(s) are then passed on to the setter function.</p>
  76 <dl class="section user"><dt>Examples:</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">float</span> square_root(<span class="keywordtype">float</span> a)  { <span class="keywordflow">return</span> sqrtf(a); }</div>
  77 <div class="line"><span class="keywordtype">float</span> <a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga00295ac42c201866e7178edb6878b316">sum</a>(<span class="keywordtype">float</span> a, <span class="keywordtype">float</span> b) { <span class="keywordflow">return</span> a+b; }</div>
  78 <div class="line">std::cout &lt;&lt; <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;square_root, &amp;<a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga00295ac42c201866e7178edb6878b316">sum</a>)(9, 16); <span class="comment">// calls square_root(sum(3,6))</span></div>
  79 <div class="line">std::cout &lt;&lt; <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;<a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga00295ac42c201866e7178edb6878b316">sum</a>, &amp;square_root, &amp;square_root)(9); <span class="comment">// calls sum(square_root(9), square_root(9))</span></div>
  80 </div><!-- fragment --></dd></dl>
  81 <p>The functor <a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a" title="Creates an adaptor of type sigc::compose1_functor which combines two functors. ">sigc::compose()</a> returns can be passed directly into sigc::signal::connect().</p>
  82 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><a class="code" href="classsigc_1_1signal.html">sigc::signal</a>(<span class="keywordtype">float</span>(<span class="keywordtype">float</span>, <span class="keywordtype">float</span>)&gt; some_signal;</div>
  83 <div class="line">some_signal.connect(<a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;square_root, &amp;<a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga00295ac42c201866e7178edb6878b316">sum</a>));</div>
  84 </div><!-- fragment --> </dd></dl>
  85 <h2 class="groupheader">Function Documentation</h2>
  86 <a class="anchor" id="ga34cf5da8f6323bfdc41bc7113d6ad20a"></a>
  87 <div class="memitem">
  88 <div class="memproto">
  89 <div class="memtemplate">
  90 template &lt;class T_setter , class T_getter &gt; </div>
  91 <table class="mlabels">
  92   <tr>
  93   <td class="mlabels-left">
  94       <table class="memname">
  95         <tr>
  96           <td class="memname">compose1_functor&lt;T_setter, T_getter&gt; sigc::compose </td>
  97           <td>(</td>
  98           <td class="paramtype">const T_setter &amp;&#160;</td>
  99           <td class="paramname"><em>_A_setter</em>, </td>
 100         </tr>
 101         <tr>
 102           <td class="paramkey"></td>
 103           <td></td>
 104           <td class="paramtype">const T_getter &amp;&#160;</td>
 105           <td class="paramname"><em>_A_getter</em>&#160;</td>
 106         </tr>
 107         <tr>
 108           <td></td>
 109           <td>)</td>
 110           <td></td><td></td>
 111         </tr>
 112       </table>
 113   </td>
 114   <td class="mlabels-right">
 115 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 116   </tr>
 117 </table>
 118 </div><div class="memdoc">
 119
 120 <p>Creates an adaptor of type <a class="el" href="structsigc_1_1compose1__functor.html" title="Adaptor that combines two functors. ">sigc::compose1_functor</a> which combines two functors. </p>
 121 <dl class="params"><dt>Parameters</dt><dd>
 122   <table class="params">
 123     <tr><td class="paramname">_A_setter</td><td>Functor that receives the return value of the invokation of <em>_A_getter</em>. </td></tr>
 124     <tr><td class="paramname">_A_getter</td><td>Functor to invoke from operator()(). </td></tr>
 125   </table>
 126   </dd>
 127 </dl>
 128 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_setter</em> with the value returned from invokation of <em>_A_getter</em>. </dd></dl>
 129
 130 </div>
 131 </div>
 132 <a class="anchor" id="ga4abf2a45eb2307a3dc5d870c86b0450d"></a>
 133 <div class="memitem">
 134 <div class="memproto">
 135 <div class="memtemplate">
 136 template &lt;class T_setter , class T_getter1 , class T_getter2 &gt; </div>
 137 <table class="mlabels">
 138   <tr>
 139   <td class="mlabels-left">
 140       <table class="memname">
 141         <tr>
 142           <td class="memname">compose2_functor&lt;T_setter, T_getter1, T_getter2&gt; sigc::compose </td>
 143           <td>(</td>
 144           <td class="paramtype">const T_setter &amp;&#160;</td>
 145           <td class="paramname"><em>_A_setter</em>, </td>
 146         </tr>
 147         <tr>
 148           <td class="paramkey"></td>
 149           <td></td>
 150           <td class="paramtype">const T_getter1 &amp;&#160;</td>
 151           <td class="paramname"><em>_A_getter1</em>, </td>
 152         </tr>
 153         <tr>
 154           <td class="paramkey"></td>
 155           <td></td>
 156           <td class="paramtype">const T_getter2 &amp;&#160;</td>
 157           <td class="paramname"><em>_A_getter2</em>&#160;</td>
 158         </tr>
 159         <tr>
 160           <td></td>
 161           <td>)</td>
 162           <td></td><td></td>
 163         </tr>
 164       </table>
 165   </td>
 166   <td class="mlabels-right">
 167 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 168   </tr>
 169 </table>
 170 </div><div class="memdoc">
 171
 172 <p>Creates an adaptor of type <a class="el" href="structsigc_1_1compose2__functor.html" title="Adaptor that combines three functors. ">sigc::compose2_functor</a> which combines three functors. </p>
 173 <dl class="params"><dt>Parameters</dt><dd>
 174   <table class="params">
 175     <tr><td class="paramname">_A_setter</td><td>Functor that receives the return values of the invokation of <em>_A_getter1</em> and <em>_A_getter2</em>. </td></tr>
 176     <tr><td class="paramname">_A_getter1</td><td>Functor to invoke from operator()(). </td></tr>
 177     <tr><td class="paramname">_A_getter2</td><td>Functor to invoke from operator()(). </td></tr>
 178   </table>
 179   </dd>
 180 </dl>
 181 <dl class="section return"><dt>Returns</dt><dd>Adaptor that executes <em>_A_setter</em> with the values return from invokation of <em>_A_getter1</em> and <em>_A_getter2</em>. </dd></dl>
 182
 183 </div>
 184 </div>
 185 </div><!-- contents -->
 186 <!-- start footer part -->
 187 <hr class="footer"/><address class="footer"><small>
 188 Generated on Wed Mar 16 2016 20:53:27 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 189 <img class="footer" src="doxygen.png" alt="doxygen"/>
 190 </a> 1.8.9.1
 191 </small></address>
 192 </body>
 193 </html>