File: group__compose.html

package info (click to toggle)
libsigc%2B%2B-2.0 2.0.10-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 20,220 kB
  • ctags: 6,376
  • sloc: sh: 8,402; cpp: 1,717; xml: 368; makefile: 364; perl: 51; ansic: 45
file content (265 lines) | stat: -rw-r--r-- 14,428 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libsigc++ 2.0: compose()</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
    <td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
    <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
  <a class="qindex" href="../../index.html">Main Page</a> &nbsp;
  <a class="qindex" href="modules.html">Groups</a> &nbsp;
  <a class="qindex" href="namespaces.html"> Namespaces</a> &nbsp;
</center>
<hr width="100%"/>

<!-- Generated by Doxygen 1.3.9.1 -->
<h1>compose()<br>
<small>
[<a class="el" href="group__adaptors.html">Adaptors</a>]</small>
</h1><a class="el" href="group__compose.html#ga2">sigc::compose()</a> combines two or three arbitrary functors.  
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adaptor that combines two functors.  <a href="structsigc_1_1compose1__functor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adaptor that combines three functors.  <a href="structsigc_1_1compose2__functor.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T_action, class T_setter, class T_getter&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga0">sigc::visit_each</a> (const T_action&amp; _A_action, const compose1_functor&lt;T_setter, T_getter&gt;&amp; _A_target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Performs a functor on each of the targets of a functor.  <a href="#ga0"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T_action, class T_setter, class T_getter1, class T_getter2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga1">sigc::visit_each</a> (const T_action&amp; _A_action, const compose2_functor&lt;T_setter, T_getter1, T_getter2&gt;&amp; _A_target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Performs a functor on each of the targets of a functor.  <a href="#ga1"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T_setter, class T_getter&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">compose1_functor&lt; T_setter,<br>
 T_getter &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga2">sigc::compose</a> (const T_setter&amp; _A_setter, const T_getter&amp; _A_getter)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor</a> which combines two functors.  <a href="#ga2"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T_setter, class T_getter1, class T_getter2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">compose2_functor&lt; T_setter,<br>
 T_getter1, T_getter2 &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__compose.html#ga3">sigc::compose</a> (const T_setter&amp; _A_setter, const T_getter1&amp; _A_getter1, const T_getter2&amp; _A_getter2)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an adaptor of type <a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor</a> which combines three functors.  <a href="#ga3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="group__compose.html#ga2">sigc::compose()</a> combines two or three arbitrary functors. 
<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>
<dl compact><dt><b>Examples:</b></dt><dd><div class="fragment"><pre class="fragment">   <span class="keywordtype">float</span> square_root(<span class="keywordtype">float</span> a)  { <span class="keywordflow">return</span> sqrtf(a); }
   <span class="keywordtype">float</span> sum(<span class="keywordtype">float</span> a, <span class="keywordtype">float</span> b) { <span class="keywordflow">return</span> a+b; }
   std::cout &lt;&lt; <a class="code" href="group__compose.html#ga2">sigc::compose</a>(&amp;square_root, &amp;sum)(9, 16); <span class="comment">// calls square_root(sum(3,6))</span>
   std::cout &lt;&lt; <a class="code" href="group__compose.html#ga2">sigc::compose</a>(&amp;sum, &amp;square_root, &amp;square_root)(9); <span class="comment">// calls sum(square_root(9), square_root(9))</span>
</pre></div></dd></dl>
The functor <a class="el" href="group__compose.html#ga2">sigc::compose()</a> returns can be passed into <a class="el" href="classsigc_1_1signal7.html#a0">sigc::signal::connect()</a> directly.<p>
<dl compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment">   <a class="code" href="classsigc_1_1signal.html">sigc::signal&lt;float,float,float&gt;</a> some_signal;
   some_signal.<a class="code" href="classsigc_1_1signal7.html#a0">connect</a>(sigc::compose(&amp;square_root, &amp;sum));
</pre></div></dd></dl>
For a more powerful version of this functionality see the lambda library adaptor <a class="el" href="namespacesigc.html#a44">sigc::group()</a> which can bind, hide and reorder arguments arbitrarily. Although <a class="el" href="namespacesigc.html#a44">sigc::group()</a> is more flexible, <a class="el" href="group__bind.html#ga8">sigc::bind()</a> provides a means of binding parameters when then total number of parameters called is variable. <hr><h2>Function Documentation</h2>
<a class="anchor" name="ga3" doxytag="sigc::compose"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_setter, class T_getter1, class T_getter2&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">compose2_functor&lt;T_setter, T_getter1, T_getter2&gt; compose           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">const T_setter&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_setter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const T_getter1&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_getter1</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const T_getter2&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_getter2</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates an adaptor of type <a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor</a> which combines three functors. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>_A_setter</em>&nbsp;</td><td>Functor that receives the return values of the invokation of <em>_A_getter1</em> and <em>_A_getter2</em>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>_A_getter1</em>&nbsp;</td><td>Functor to invoke from operator()(). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>_A_getter2</em>&nbsp;</td><td>Functor to invoke from operator()(). </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></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>
    </td>
  </tr>
</table>
<a class="anchor" name="ga2" doxytag="sigc::compose"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_setter, class T_getter&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">compose1_functor&lt;T_setter, T_getter&gt; compose           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">const T_setter&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_setter</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const T_getter&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_getter</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates an adaptor of type <a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor</a> which combines two functors. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>_A_setter</em>&nbsp;</td><td>Functor that receives the return value of the invokation of <em>_A_getter</em>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>_A_getter</em>&nbsp;</td><td>Functor to invoke from operator()(). </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Adaptor that executes <em>_A_setter</em> with the value returned from invokation of <em>_A_getter</em>. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="ga1" doxytag="sigc::visit_each"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_action, class T_setter, class T_getter1, class T_getter2&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">void visit_each           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">const T_action&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_action</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const compose2_functor&lt;T_setter, T_getter1, T_getter2&gt;&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_target</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Performs a functor on each of the targets of a functor. 
<p>
The function overload for <a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor</a> performs a functor on the functors stored in the <a class="el" href="structsigc_1_1compose2__functor.html">sigc::compose2_functor</a> object.     </td>
  </tr>
</table>
<a class="anchor" name="ga0" doxytag="sigc::visit_each"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_action, class T_setter, class T_getter&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">void visit_each           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">const T_action&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_action</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const compose1_functor&lt;T_setter, T_getter&gt;&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_target</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Performs a functor on each of the targets of a functor. 
<p>
The function overload for <a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor</a> performs a functor on the functors stored in the <a class="el" href="structsigc_1_1compose1__functor.html">sigc::compose1_functor</a> object.     </td>
  </tr>
</table>
<hr><address><small>
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3.9.1 &copy;&nbsp;1997-2001</small></address>
</body>
</html>