untracked/docs/reference/html/group__compose.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libsigc++: compose()</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  14 </head>
  15 <body>
  16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17 <div id="titlearea">
  18 <table cellspacing="0" cellpadding="0">
  19  <tbody>
  20  <tr style="height: 56px;">
  21   <td id="projectalign" style="padding-left: 0.5em;">
  22    <div id="projectname">libsigc++
  23    &#160;<span id="projectnumber">2.10.8</span>
  24    </div>
  25   </td>
  26  </tr>
  27  </tbody>
  28 </table>
  29 </div>
  30 <!-- end header part -->
  31 <!-- Generated by Doxygen 1.9.1 -->
  32 <script type="text/javascript" src="menudata.js"></script>
  33 <script type="text/javascript" src="menu.js"></script>
  34 <script type="text/javascript">
  35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36 $(function() {
  37   initMenu('',false,false,'search.php','Search');
  38 });
  39 /* @license-end */</script>
  40 <div id="main-nav"></div>
  41 </div><!-- top -->
  42 <div class="header">
  43   <div class="summary">
  44 <a href="#nested-classes">Classes</a> &#124;
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <div class="title">compose()<div class="ingroups"><a class="el" href="group__adaptors.html">Adaptors</a></div></div>  </div>
  48 </div><!--header-->
  49 <div class="contents">
  50
  51 <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.
  52 <a href="#details">More...</a></p>
  53 <table class="memberdecls">
  54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  55 Classes</h2></td></tr>
  56 <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>
  57 <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>
  58 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 <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>
  60 <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>
  61 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 </table><table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  64 Functions</h2></td></tr>
  65 <tr class="memitem:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memTemplParams" colspan="2">template&lt;class T_setter , class T_getter &gt; </td></tr>
  66 <tr class="memitem:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1compose1__functor.html">compose1_functor</a>&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>
  67 <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="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">More...</a><br /></td></tr>
  68 <tr class="separator:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memTemplParams" colspan="2">template&lt;class T_setter , class T_getter1 , class T_getter2 &gt; </td></tr>
  70 <tr class="memitem:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1compose2__functor.html">compose2_functor</a>&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>
  71 <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="group__compose.html#ga4abf2a45eb2307a3dc5d870c86b0450d">More...</a><br /></td></tr>
  72 <tr class="separator:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table>
  74 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75 <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>
  76 <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>
  77 <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>
  78 <div class="line"><span class="keywordtype">float</span> <a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a>(<span class="keywordtype">float</span> a, <span class="keywordtype">float</span> b) { <span class="keywordflow">return</span> a+b; }</div>
  79 <div class="line"><a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01635.html#aaf93fdf0812752e0e02c501dea1b38f0">std::cout</a> &lt;&lt; <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;square_root, &amp;<a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a>)(9, 16); <span class="comment">// calls square_root(sum(3,6))</span></div>
  80 <div class="line"><a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01635.html#aaf93fdf0812752e0e02c501dea1b38f0">std::cout</a> &lt;&lt; <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;<a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a>, &amp;square_root, &amp;square_root)(9); <span class="comment">// calls sum(square_root(9), square_root(9))</span></div>
  81 <div class="ttc" id="aa01568_html_gabf296b8981ebb3c123b3ba99e753598f"><div class="ttname"><a href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a></div><div class="ttdeci">_Tp sum() const</div></div>
  82 <div class="ttc" id="aa01635_html_aaf93fdf0812752e0e02c501dea1b38f0"><div class="ttname"><a href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01635.html#aaf93fdf0812752e0e02c501dea1b38f0">std::cout</a></div><div class="ttdeci">ostream cout</div></div>
  83 <div class="ttc" id="agroup__compose_html_ga34cf5da8f6323bfdc41bc7113d6ad20a"><div class="ttname"><a href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a></div><div class="ttdeci">compose1_functor&lt; T_setter, T_getter &gt; compose(const T_setter &amp;_A_setter, const T_getter &amp;_A_getter)</div><div class="ttdoc">Creates an adaptor of type sigc::compose1_functor which combines two functors.</div><div class="ttdef"><b>Definition:</b> compose.h:288</div></div>
  84 </div><!-- fragment --></dd></dl>
  85 <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 <a class="el" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2" title="Add a slot to the list of slots.">sigc::signal::connect()</a>.</p>
  86 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><a class="code" href="classsigc_1_1signal.html">sigc::signal&lt;float,float,float&gt;</a> some_signal;</div>
  87 <div class="line">some_signal.<a class="code" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2">connect</a>(<a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&amp;square_root, &amp;<a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a>));</div>
  88 <div class="ttc" id="aclasssigc_1_1signal7_html_adc55ac9b0f935fd87a67904022e03cb2"><div class="ttname"><a href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2">sigc::signal7::connect</a></div><div class="ttdeci">iterator connect(const slot_type &amp;slot_)</div><div class="ttdoc">Add a slot to the list of slots.</div><div class="ttdef"><b>Definition:</b> signal.h:3871</div></div>
  89 <div class="ttc" id="aclasssigc_1_1signal_html"><div class="ttname"><a href="classsigc_1_1signal.html">sigc::signal</a></div><div class="ttdoc">Convenience wrapper for the numbered sigc::signal# templates.</div><div class="ttdef"><b>Definition:</b> signal.h:4015</div></div>
  90 </div><!-- fragment --> </dd></dl>
  91 <h2 class="groupheader">Function Documentation</h2>
  92 <a id="ga34cf5da8f6323bfdc41bc7113d6ad20a"></a>
  93 <h2 class="memtitle"><span class="permalink"><a href="#ga34cf5da8f6323bfdc41bc7113d6ad20a">&#9670;&#160;</a></span>compose() <span class="overload">[1/2]</span></h2>
  94
  95 <div class="memitem">
  96 <div class="memproto">
  97 <div class="memtemplate">
  98 template &lt;class T_setter , class T_getter &gt; </div>
  99 <table class="mlabels">
 100   <tr>
 101   <td class="mlabels-left">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname"><a class="el" href="structsigc_1_1compose1__functor.html">compose1_functor</a>&lt;T_setter, T_getter&gt; sigc::compose </td>
 105           <td>(</td>
 106           <td class="paramtype">const T_setter &amp;&#160;</td>
 107           <td class="paramname"><em>_A_setter</em>, </td>
 108         </tr>
 109         <tr>
 110           <td class="paramkey"></td>
 111           <td></td>
 112           <td class="paramtype">const T_getter &amp;&#160;</td>
 113           <td class="paramname"><em>_A_getter</em>&#160;</td>
 114         </tr>
 115         <tr>
 116           <td></td>
 117           <td>)</td>
 118           <td></td><td></td>
 119         </tr>
 120       </table>
 121   </td>
 122   <td class="mlabels-right">
 123 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 124   </tr>
 125 </table>
 126 </div><div class="memdoc">
 127
 128 <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>
 129 <dl class="params"><dt>Parameters</dt><dd>
 130   <table class="params">
 131     <tr><td class="paramname">_A_setter</td><td>Functor that receives the return value of the invokation of <em>_A_getter</em>. </td></tr>
 132     <tr><td class="paramname">_A_getter</td><td>Functor to invoke from operator()(). </td></tr>
 133   </table>
 134   </dd>
 135 </dl>
 136 <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>
 137
 138 </div>
 139 </div>
 140 <a id="ga4abf2a45eb2307a3dc5d870c86b0450d"></a>
 141 <h2 class="memtitle"><span class="permalink"><a href="#ga4abf2a45eb2307a3dc5d870c86b0450d">&#9670;&#160;</a></span>compose() <span class="overload">[2/2]</span></h2>
 142
 143 <div class="memitem">
 144 <div class="memproto">
 145 <div class="memtemplate">
 146 template &lt;class T_setter , class T_getter1 , class T_getter2 &gt; </div>
 147 <table class="mlabels">
 148   <tr>
 149   <td class="mlabels-left">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname"><a class="el" href="structsigc_1_1compose2__functor.html">compose2_functor</a>&lt;T_setter, T_getter1, T_getter2&gt; sigc::compose </td>
 153           <td>(</td>
 154           <td class="paramtype">const T_setter &amp;&#160;</td>
 155           <td class="paramname"><em>_A_setter</em>, </td>
 156         </tr>
 157         <tr>
 158           <td class="paramkey"></td>
 159           <td></td>
 160           <td class="paramtype">const T_getter1 &amp;&#160;</td>
 161           <td class="paramname"><em>_A_getter1</em>, </td>
 162         </tr>
 163         <tr>
 164           <td class="paramkey"></td>
 165           <td></td>
 166           <td class="paramtype">const T_getter2 &amp;&#160;</td>
 167           <td class="paramname"><em>_A_getter2</em>&#160;</td>
 168         </tr>
 169         <tr>
 170           <td></td>
 171           <td>)</td>
 172           <td></td><td></td>
 173         </tr>
 174       </table>
 175   </td>
 176   <td class="mlabels-right">
 177 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 178   </tr>
 179 </table>
 180 </div><div class="memdoc">
 181
 182 <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>
 183 <dl class="params"><dt>Parameters</dt><dd>
 184   <table class="params">
 185     <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>
 186     <tr><td class="paramname">_A_getter1</td><td>Functor to invoke from operator()(). </td></tr>
 187     <tr><td class="paramname">_A_getter2</td><td>Functor to invoke from operator()(). </td></tr>
 188   </table>
 189   </dd>
 190 </dl>
 191 <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>
 192
 193 </div>
 194 </div>
 195 </div><!-- contents -->
 196 <!-- start footer part -->
 197 <hr class="footer"/><address class="footer"><small>
 198 Generated on Fri Feb 11 2022 15:40:57 for libsigc++ by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 199 </small></address>
 200 </body>
 201 </html>