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
|
<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>binary_compose<AdaptableBinaryFunction,AdaptableUnaryFunction1,AdaptableUnaryFunction2></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>binary_compose<AdaptableBinaryFunction,AdaptableUnaryFunction1,AdaptableUnaryFunction2></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>Binary_compose</tt> is a <A href="functors.html">function object</A> adaptor.
If <tt>f</tt> is an <A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A> and <tt>g1</tt> and <tt>g2</tt> are both
<A href="AdaptableUnaryFunction.html">Adaptable Unary Functions</A>, and if <tt>g1</tt>'s and <tt>g2</tt>'s return types
are convertible to <tt>f</tt>'s argument types, then <tt>binary_compose</tt> can be
used to create a function object <tt>h</tt> such that <tt>h(x)</tt> is the same as
<tt>f(g1(x), g2(x))</tt>. <A href="#1">[1]</A> <A href="#2">[2]</A>
<h3>Example</h3>
Finds the first element in a list that lies in the range from 1 to 10.
<pre>
<A href="List.html">list</A><int> L;
...
<A href="List.html">list</A><int>::iterator in_range =
<A href="find_if.html">find_if</A>(L.begin(), L.end(),
compose2(<A href="logical_and.html">logical_and</A><bool>(),
<A href="binder2nd.html">bind2nd</A>(<A href="greater_equal.html">greater_equal</A><int>(), 1),
<A href="binder2nd.html">bind2nd</A>(<A href="less_equal.html">less_equal</A><int>(), 10)));
assert(in_range == L.end() || (*in_range >= 1 && *in_range <= 10));
</pre>
<P>
Computes <tt>sin(x)/(x + DBL_MIN)</tt> for each element of a range.
<pre>
<A href="transform.html">transform</A>(first, last, first,
compose2(<A href="divides.html">divides</A><double>(),
<A href="ptr_fun.html">ptr_fun</A>(sin),
<A href="binder2nd.html">bind2nd</A>(<A href="plus.html">plus</A><double>(), DBL_MIN)));
</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>AdaptableBinaryFunction</tt>
</TD>
<TD VAlign=top>
The type of the "outer" function in the function composition
operation. That is, if the <tt>binary_compose</tt> is a function object
<tt>h</tt> such that <tt>h(x) = f(g1(x), g2(x))</tt>, then <tt>AdaptableBinaryFunction</tt>
is the type of <tt>f</tt>.
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>AdaptableUnaryFunction1</tt>
</TD>
<TD VAlign=top>
The type of the first "inner" function in the function composition
operation. That is, if the <tt>binary_compose</tt> is a function object
<tt>h</tt> such that <tt>h(x) = f(g1(x), g2(x))</tt>, then <tt>AdaptableBinaryFunction</tt>
is the type of <tt>g1</tt>.
</TD>
<TD VAlign=top>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>AdaptableUnaryFunction2</tt>
</TD>
<TD VAlign=top>
The type of the second "inner" function in the function composition
operation. That is, if the <tt>binary_compose</tt> is a function object
<tt>h</tt> such that <tt>h(x) = f(g1(x), g2(x))</tt>, then <tt>AdaptableBinaryFunction</tt>
is the type of <tt>g2</tt>.
</TD>
<TD VAlign=top>
</TD>
</tr>
</table>
<h3>Model of</h3>
<A href="AdaptableUnaryFunction.html">Adaptable Unary Function</A>
<h3>Type requirements</h3>
<tt>AdaptableBinaryFunction</tt> must be a model of <A href="AdaptableBinaryFunction.html">Adaptable Binary Function</A>.
<tt>AdaptableUnaryFunction1</tt> and <tt>AdaptableUnaryFunction2</tt> must both
be models of <A href="AdaptableUnaryFunction.html">Adaptable Unary Function</A>.
The argument types of <tt>AdaptableUnaryFunction1</tt> and
<tt>AdaptableUnaryFunction2</tt> must be convertible to each other.
The result types of <tt>AdaptableUnaryFunction1</tt> and
<tt>AdaptableUnaryFunction2</tt> must be convertible, respectively, to
the first and second argument types of <tt>AdaptableBinaryFunction</tt>.
<h3>Public base classes</h3>
<pre>
<A href="unary_function.html">unary_function</A><AdaptableUnaryFunction1::argument_type,
AdaptableBinaryFunction::result_type>
</pre>
<h3>Members</h3>
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Where defined
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>argument_type</tt>
</TD>
<TD VAlign=top>
<A href="AdaptableUnaryFunction.html">Adaptable Unary Function</A>
</TD>
<TD VAlign=top>
The type of the function object's argument:
<tt>AdaptableUnaryFunction::argument_type</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>result_type</tt>
</TD>
<TD VAlign=top>
<A href="AdaptableUnaryFunction.html">Adaptable Unary Function</A>
</TD>
<TD VAlign=top>
The type of the result: <tt>AdaptableBinaryFunction::result_type</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
binary_compose(const AdaptableBinaryFunction& f,
const AdaptableUnaryFunction1& g1,
const AdaptableUnaryFunction1& g2);
</pre>
</TD>
<TD VAlign=top>
<tt>binary_compose</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template <class <A href="AdaptableBinaryFunction.html">AdaptableBinaryFunction</A>,
class <A href="AdaptableUnaryFunction.html">AdaptableUnaryFunction</A>1,
class <A href="AdaptableUnaryFunction.html">AdaptableUnaryFunction</A>2>
binary_compose<AdaptableBinaryFunction,
AdaptableUnaryFunction1,
AdaptableUnaryFunction2>
compose2(const AdaptableBinaryFunction&,
const AdaptableUnaryFunction1&,
const AdaptableUnaryFunction2&);
</pre>
</TD>
<TD VAlign=top>
<tt>binary_compose</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</tr>
</table>
<h3>New members</h3>
These members are not defined in the
<A href="AdaptableUnaryFunction.html">Adaptable Unary Function</A>
requirements, but are specific to
<tt>binary_compose</tt>.
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<pre>
binary_compose(const AdaptableBinaryFunction& f,
const AdaptableUnaryFunction1& g1,
const AdaptableUnaryFunction1& g2);
</pre>
</TD>
<TD VAlign=top>
The constructor. Constructs a <tt>binary_compose</tt> object such that
calling that object with the argument <tt>x</tt> returns
<tt>f(g1(x), g2(x))</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template <class <A href="AdaptableBinaryFunction.html">AdaptableBinaryFunction</A>,
class <A href="AdaptableUnaryFunction.html">AdaptableUnaryFunction</A>1,
class <A href="AdaptableUnaryFunction.html">AdaptableUnaryFunction</A>2>
binary_compose<AdaptableBinaryFunction,
AdaptableUnaryFunction1,
AdaptableUnaryFunction2>
compose2(const AdaptableBinaryFunction&,
const AdaptableUnaryFunction1&,
const AdaptableUnaryFunction2&);
</pre>
</TD>
<TD VAlign=top>
Creates a <tt>binary_compose</tt> object. If <tt>f</tt>, <tt>g</tt>, and <tt>g2</tt> are, respectively,
of classes <tt>AdaptableBinaryFunction</tt>, <tt>AdaptableUnaryFunction1</tt>, and
<tt>AdaptableUnaryFunction2</tt>, then <tt>compose2(f, g1, g2)</tt> is equivalent to
<tt>binary_compose<AdaptableBinaryFunction, AdaptableUnaryFunction1,
AdaptableUnaryFunction2>(f, g1, g2)</tt>, but is more convenient.
This is a global function, not a member function.
</TD>
</tr>
</table>
<h3>Notes</h3>
<P><A name="1">[1]</A>
This is a form of function composition. The <tt><A href="unary_compose.html">unary_compose</A></tt>
adaptor allows composition of <A href="AdaptableUnaryFunction.html">Adaptable Unary Functions</A>; note,
however, that once binary functions are introduced, there are several
possible patterns of function composition. The <tt>binary_compose</tt>
allows you to form a unary function by putting together two unary
functions and a binary function, but you could also, for example,
imagine putting together two unary functions and a binary function to
form a binary function. In that case, <tt>f</tt>, <tt>g1</tt>, and <tt>g2</tt> would be
combined into a function object <tt>h</tt> such that <tt>h(x,y) = f(g1(x),
g2(y))</tt>.
<h3>See also</h3>
The <A href="functors.html">function object overview</A>, <tt><A href="unary_compose.html">unary_compose</A></tt>,
<tt><A href="binder1st.html">binder1st</A></tt>, <tt><A href="binder2nd.html">binder2nd</A></tt>.
<!--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>
|