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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<HTML>
<!--
-- Copyright (c) 1996,1997
-- Silicon Graphics Computer Systems, Inc.
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Silicon Graphics makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-- Copyright (c) 1994
-- Hewlett-Packard Company
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Hewlett-Packard Company makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
--
-->
<Head>
<Title>pointer_to_binary_function<Arg1, Arg2, Result></Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="CorpID.gif"
ALT="Silicon Graphics, Inc." HEIGHT="43" WIDTH="151">
<!--end header-->
<BR Clear>
<H1>pointer_to_binary_function<Arg1, Arg2, Result></H1>
<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "functors.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
<TD Align=right><Img src = "type.gif" Alt="" WIDTH = "194" HEIGHT = "39" ></TD>
</TR>
<TR>
<TD Align=left><Img src = "adaptors.gif" Alt="" WIDTH = "194" HEIGHT = "38" ></TD>
<TD Align=right></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Categories</b>: functors, adaptors</TD>
<TD Align=right VAlign=top><b>Component type</b>: type</TD>
</TR>
</Table>
<h3>Description</h3>
<tt>Pointer_to_binary_function</tt> is a <A href="functors.html">function object</A> adaptor that
allows a function pointer <tt>Result (*f)(Arg1, Arg2)</tt> to be treated as an
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>. That is: if <tt>F</tt> is a
<tt>pointer_to_binary_function<Arg1, Arg2, Result></tt> that was initialized
with an underlying function pointer <tt>f</tt> of type
<tt>Result (*)(Arg1, Arg2)</tt>, then <tt>F(x, y)</tt> calls the function
<tt>f(x, y)</tt>. The difference between <tt>f</tt> and <tt>F</tt> is that
<tt>pointer_to_binary_function</tt> is an <A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>,
<i>i.e.</i> it defines the nested <tt>typedef</tt>s <tt>first_argument_type</tt>,
<tt>second_argument_type</tt>, and <tt>result_type</tt>.
<P>
Note that a function pointer of type <tt>Result (*)(Arg1, Arg2)</tt> is a perfectly
good <A href="BinaryFunction.html">Binary Function</A> object, and may be passed to an STL algorithm
that expects an argument that is a <A href="BinaryFunction.html">Binary Function</A>. The only
reason for using the <tt>pointer_to_binary_function</tt> class is if you need
to use an ordinary function in a context that requires an
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>, <i>e.g.</i> as the argument of a function object
adaptor.
<P>
Most of the time, you need not declare an object of type
<tt>pointer_to_binary_function</tt> directly. It is almost always easier to
construct one using the <tt><A href="ptr_fun.html">ptr_fun</A></tt> function.
<h3>Example</h3>
The following code fragment finds the first string in a list
that is equal to <tt>"OK"</tt>. It uses the standard library function
<tt>strcmp</tt> as an argument to a function object adaptor, so it must
first use a <tt>pointer_to_binary_function</tt> adaptor to give <tt>strcmp</tt>
the <A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A> interface.
<pre>
<A href="List.html">list</A><char*> L;
...
<A href="List.html">list</A><char*>::iterator item =
<A href="find_if.html">find_if</A>(L.begin(), L.end(),
<A href="unary_negate.html">not1</A>(<A href="binder2nd.html">binder2nd</A>(<A href="ptr_fun.html">ptr_fun</A>(strcmp), "OK")));
</pre>
<h3>Definition</h3>
Defined in <A href="function.h">function.h</A>.
<h3>Template parameters</h3>
<Table border>
<TR>
<TH>
Parameter
</TH>
<TH>
Description
</TH>
<TH>
Default
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>Arg1</tt>
</TD>
<TD VAlign=top>
The function object's first argument type
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>Arg2</tt>
</TD>
<TD VAlign=top>
The function object's second argument type
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>Result</tt>
</TD>
<TD VAlign=top>
The function object's result type
</TD>
<TD VAlign=top>
</TD>
</tr>
</table>
<h3>Model of</h3>
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
<h3>Type requirements</h3>
<UL>
<LI>
<tt>Arg1</tt> is <A href="Assignable.html">Assignable</A>.
<LI>
<tt>Arg2</tt> is <A href="Assignable.html">Assignable</A>.
<LI>
<tt>Result</tt> is <A href="Assignable.html">Assignable</A>.
</UL>
<h3>Public base classes</h3>
<tt><A href="binary_function.html">binary_function</A><Arg1, Arg2, Result></tt>
<h3>Members</h3>
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Where defined
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>first_argument_type</tt>
</TD>
<TD VAlign=top>
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
</TD>
<TD VAlign=top>
The type of the first argument: <tt>Arg1</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>second_argument_type</tt>
</TD>
<TD VAlign=top>
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
</TD>
<TD VAlign=top>
The type of the second argument: <tt>Arg2</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>result_type</tt>
</TD>
<TD VAlign=top>
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
</TD>
<TD VAlign=top>
The type of the result: <tt>Result</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>Result operator()(Arg1 x, Arg2 y)</tt>
</TD>
<TD VAlign=top>
<A href="BinaryFunction.html">Binary Function</A>
</TD>
<TD VAlign=top>
Function call operator.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>pointer_to_binary_function(Result (*f)(Arg1, Arg2))</tt>
</TD>
<TD VAlign=top>
<tt>pointer_to_binary_function</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>pointer_to_binary_function()</tt>
</TD>
<TD VAlign=top>
<tt>pointer_to_binary_function</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template <class Arg1, class Arg2, class Result>
pointer_to_unary_function<Arg1, Arg2, Result>
ptr_fun(Result (*x)(Arg1, Arg2));
</pre>
</TD>
<TD VAlign=top>
<tt>pointer_to_binary_function</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</tr>
</table>
<h3>New members</h3>
These members are not defined
in the <A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
requirements, but are specific to
<tt>pointer_to_binary_function</tt>.
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>pointer_to_binary_function(Result (*f)(Arg1, Arg2))</tt>
</TD>
<TD VAlign=top>
The constructor. Creates a <tt>pointer_to_binary_function</tt> whose underlying
function is <tt>f</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>pointer_to_binary_function()</tt>
</TD>
<TD VAlign=top>
The default constructor. This creates a <tt>pointer_to_binary_function</tt>
that does not have an underlying function, and that therefore
cannot actually be called.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template <class Arg1, class Arg2, class Result>
pointer_to_unary_function<Arg1, Arg2, Result>
ptr_fun(Result (*x)(Arg1, Arg2));
</pre>
</TD>
<TD VAlign=top>
If <tt>f</tt> is of type <tt>Result (*)(Arg1, Arg2)</tt> then
<tt>ptr_fun(f)</tt> is equivalent to
<tt>pointer_to_binary_function<Arg1,Arg2,Result>(f)</tt>,
but more convenient. This is a global function, not a member
function.
</TD>
</tr>
</table>
<h3>Notes</h3>
<h3>See also</h3>
<tt><A href="pointer_to_unary_function.html">pointer_to_unary_function</A></tt>, <tt><A href="ptr_fun.html">ptr_fun</A></tt>,
<A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>
<!--start footer-->
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54"
ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif"
HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright ©
1996 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>
|
