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">
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"/>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18 <table cellspacing="0" cellpadding="0">
20 <tr style="height: 56px;">
21 <td id="projectalign" style="padding-left: 0.5em;">
22 <div id="projectname">libsigc++
23  <span id="projectnumber">2.10.8</span>
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&dn=gpl-2.0.txt GPL-v2 */
37 initMenu('',false,false,'search.php','Search');
39 /* @license-end */</script>
40 <div id="main-nav"></div>
44 <a href="#nested-classes">Classes</a> |
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>
49 <div class="contents">
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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor< T_setter, T_getter ></a></td></tr>
57 <tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr>
59 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor< T_setter, T_getter1, T_getter2 ></a></td></tr>
60 <tr class="memdesc:"><td class="mdescLeft"> </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"> </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<class T_setter , class T_getter > </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>< T_setter, T_getter > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a> (const T_setter & _A_setter, const T_getter & _A_getter)</td></tr>
67 <tr class="memdesc:ga34cf5da8f6323bfdc41bc7113d6ad20a"><td class="mdescLeft"> </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"> </td></tr>
69 <tr class="memitem:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="memTemplParams" colspan="2">template<class T_setter , class T_getter1 , class T_getter2 > </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>< T_setter, T_getter1, T_getter2 > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga4abf2a45eb2307a3dc5d870c86b0450d">sigc::compose</a> (const T_setter & _A_setter, const T_getter1 & _A_getter1, const T_getter2 & _A_getter2)</td></tr>
71 <tr class="memdesc:ga4abf2a45eb2307a3dc5d870c86b0450d"><td class="mdescLeft"> </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"> </td></tr>
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> << <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&square_root, &<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> << <a class="code" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a">sigc::compose</a>(&<a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#gabf296b8981ebb3c123b3ba99e753598f">sum</a>, &square_root, &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< T_setter, T_getter > compose(const T_setter &_A_setter, const T_getter &_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<float,float,float></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>(&square_root, &<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 &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">◆ </a></span>compose() <span class="overload">[1/2]</span></h2>
96 <div class="memproto">
97 <div class="memtemplate">
98 template <class T_setter , class T_getter > </div>
99 <table class="mlabels">
101 <td class="mlabels-left">
102 <table class="memname">
104 <td class="memname"><a class="el" href="structsigc_1_1compose1__functor.html">compose1_functor</a><T_setter, T_getter> sigc::compose </td>
106 <td class="paramtype">const T_setter & </td>
107 <td class="paramname"><em>_A_setter</em>, </td>
110 <td class="paramkey"></td>
112 <td class="paramtype">const T_getter & </td>
113 <td class="paramname"><em>_A_getter</em> </td>
122 <td class="mlabels-right">
123 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
126 </div><div class="memdoc">
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>
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>
140 <a id="ga4abf2a45eb2307a3dc5d870c86b0450d"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#ga4abf2a45eb2307a3dc5d870c86b0450d">◆ </a></span>compose() <span class="overload">[2/2]</span></h2>
143 <div class="memitem">
144 <div class="memproto">
145 <div class="memtemplate">
146 template <class T_setter , class T_getter1 , class T_getter2 > </div>
147 <table class="mlabels">
149 <td class="mlabels-left">
150 <table class="memname">
152 <td class="memname"><a class="el" href="structsigc_1_1compose2__functor.html">compose2_functor</a><T_setter, T_getter1, T_getter2> sigc::compose </td>
154 <td class="paramtype">const T_setter & </td>
155 <td class="paramname"><em>_A_setter</em>, </td>
158 <td class="paramkey"></td>
160 <td class="paramtype">const T_getter1 & </td>
161 <td class="paramname"><em>_A_getter1</em>, </td>
164 <td class="paramkey"></td>
166 <td class="paramtype">const T_getter2 & </td>
167 <td class="paramname"><em>_A_getter2</em> </td>
176 <td class="mlabels-right">
177 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
180 </div><div class="memdoc">
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>
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>
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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1