2007-11-06 12:13:52 +00:00
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > invoke</ title >
2007-11-07 03:46:23 +00:00
< link rel = "stylesheet" href = "../../../../../../../../doc/html/boostbook.css" type = "text/css" >
2007-11-06 12:13:52 +00:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.66.1" >
< link rel = "start" href = "../../../../index.html" title = "Chapter >
< link rel = "up" href = "../functions.html" title = "Functions" >
< link rel = "prev" href = "../functions.html" title = "Functions" >
< link rel = "next" href = "invoke_proc.html" title = "
invoke_procedure" >
</ head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
< table cellpadding = "2" width = "100%" >< tr >
< td valign = "top" >< img alt = "Boost C++ Libraries" width = "277" height = "86" src = "../../../../../../../../boost.png" ></ td >
< td align = "center" >< a href = "../../../../../../../../index.htm" > Home</ a ></ td >
< td align = "center" >< a href = "../../../../../../../libraries.htm" > Libraries</ a ></ td >
< td align = "center" >< a href = "../../../../../../../../people/people.htm" > People</ a ></ td >
< td align = "center" >< a href = "../../../../../../../../more/faq.htm" > FAQ</ a ></ td >
< td align = "center" >< a href = "../../../../../../../../more/index.htm" > More</ a ></ td >
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "../functions.html" >< img src = "../../../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../functions.html" >< img src = "../../../../../../../../doc/html/images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../../../index.html" >< img src = "../../../../../../../../doc/html/images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "invoke_proc.html" >< img src = "../../../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
< div class = "section" lang = "en" >
< div class = "titlepage" >< div >< div >< h5 class = "title" >
< a name = "fusion.functional.invocation.functions.invoke" ></ a >< a href = "invoke.html" title = "invoke" > invoke</ a ></ h5 ></ div ></ div ></ div >
< a name = "fusion.functional.invocation.functions.invoke.description" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id657347" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.description" > Description</ a >
</ h6 >
< p >
Calls a < a href = "../../concepts/def_callable.html" title = " Deferred
Callable Object" > Deferred
Callable Object</ a > with the arguments from a < a href = "../../../sequence.html" title = "Sequence" > Sequence</ a > .
</ p >
< p >
The first template parameter can be specialized explicitly to avoid copying
and/or to control the const qualification of a function object.
</ p >
< p >
If the target function is a pointer to a class members, the corresponding
object can be specified as a reference, pointer, or smart pointer. In
case of the latter, a freestanding < tt class = "literal" > get_pointer</ tt > function
must be defined (Boost provides this function for < tt class = "literal" > std::auto_ptr</ tt >
and < a href = "http://www.boost.org/libs/smart_ptr/shared_ptr.htm" target = "_top" >< tt class = "computeroutput" >< span class = "identifier" > boost</ span >< span class = "special" > ::</ span >< span class = "identifier" > shared_ptr</ span ></ tt ></ a > ).
</ p >
< a name = "fusion.functional.invocation.functions.invoke.synopsis" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id657450" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.synopsis" > Synopsis</ a >
</ h6 >
< pre class = "programlisting" >
< span class = "keyword" > template</ span >< span class = "special" > < </ span >
2007-11-07 02:12:28 +00:00
< span class = "keyword" > typename</ span > < span class = "identifier" > Function</ span >< span class = "special" > ,</ span >
2007-11-06 12:13:52 +00:00
< span class = "keyword" > class</ span > < span class = "identifier" > Sequence</ span >
< span class = "special" > > </ span >
< span class = "keyword" > typename</ span > < a href = "../metafunctions/invoke.html" title = "invoke" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > invoke</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > Function</ span >< span class = "special" > ,</ span > < span class = "identifier" > Sequence</ span >< span class = "special" > > ::</ span >< span class = "identifier" > type</ span >
< span class = "identifier" > invoke</ span >< span class = "special" > (</ span >< span class = "identifier" > Function</ span > < span class = "identifier" > f</ span >< span class = "special" > ,</ span > < span class = "identifier" > Sequence</ span > < span class = "special" > & </ span > < span class = "identifier" > s</ span >< span class = "special" > );</ span >
< span class = "keyword" > template</ span >< span class = "special" > < </ span >
2007-11-07 02:12:28 +00:00
< span class = "keyword" > typename</ span > < span class = "identifier" > Function</ span >< span class = "special" > ,</ span >
2007-11-06 12:13:52 +00:00
< span class = "keyword" > class</ span > < span class = "identifier" > Sequence</ span >
< span class = "special" > > </ span >
2007-11-07 02:12:28 +00:00
< span class = "keyword" > typename</ span > < a href = "../metafunctions/invoke.html" title = "invoke" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > invoke</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "identifier" > Function</ span >< span class = "special" > ,</ span > < span class = "identifier" > Sequence</ span > < span class = "keyword" > const</ span >< span class = "special" > > ::</ span >< span class = "identifier" > type</ span >
2007-11-06 12:13:52 +00:00
< span class = "identifier" > invoke</ span >< span class = "special" > (</ span >< span class = "identifier" > Function</ span > < span class = "identifier" > f</ span >< span class = "special" > ,</ span > < span class = "identifier" > Sequence</ span > < span class = "keyword" > const</ span > < span class = "special" > & </ span > < span class = "identifier" > s</ span >< span class = "special" > );</ span >
</ pre >
< a name = "fusion.functional.invocation.functions.invoke.parameters" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id657828" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.parameters" > Parameters</ a >
</ h6 >
< div class = "informaltable" >< table class = "table" >
< colgroup >
< col >
< col >
< col >
</ colgroup >
< thead >< tr >
< th >
< p >
Parameter
</ p >
</ th >
< th >
< p >
Requirement
</ p >
</ th >
< th >
< p >
Description
</ p >
</ th >
</ tr ></ thead >
< tbody >
< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > f</ span ></ tt >
</ p >
</ td >
< td >
< p >
A < a href = "../../concepts/def_callable.html" title = " Deferred
Callable Object" > Deferred
Callable Object</ a >
</ p >
</ td >
< td >
< p >
The function to call.
</ p >
</ td >
</ tr >
< tr >
< td >
< p >
< tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt >
</ p >
</ td >
< td >
< p >
A < a href = "../../../sequence/concepts/forward_sequence.html" title = "Forward
Sequence" > Forward
Sequence</ a >
</ p >
</ td >
< td >
< p >
The arguments.
</ p >
</ td >
</ tr >
</ tbody >
</ table ></ div >
< a name = "fusion.functional.invocation.functions.invoke.expression_semantics" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id657989" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.expression_semantics" > Expression
Semantics</ a >
</ h6 >
< pre class = "programlisting" >
< span class = "identifier" > invoke</ span >< span class = "special" > (</ span >< span class = "identifier" > f</ span >< span class = "special" > ,</ span >< span class = "identifier" > s</ span >< span class = "special" > );</ span >
</ pre >
< p >
< span class = "bold" >< b > Return type</ b ></ span > : Return type of < tt class = "computeroutput" >< span class = "identifier" > f</ span ></ tt > when invoked with the elements in
< tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt > as its arguments.
</ p >
< p >
< span class = "bold" >< b > Semantics</ b ></ span > : Invokes < tt class = "computeroutput" >< span class = "identifier" > f</ span ></ tt >
with the elements in < tt class = "computeroutput" >< span class = "identifier" > s</ span ></ tt >
as arguments and returns the result of the call expression.
</ p >
< p >
/functional/invocation/invoke.hpp>
</ p >
< a name = "fusion.functional.invocation.functions.invoke.example" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id658132" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.example" > Example</ a >
</ h6 >
< pre class = "programlisting" >
< a href = "http://www.sgi.com/tech/stl/plus.html" target = "_top" >< tt class = "computeroutput" >< span class = "identifier" > std</ span >< span class = "special" > ::</ span >< span class = "identifier" > plus</ span ></ tt ></ a >< span class = "special" > < </ span >< span class = "keyword" > int</ span >< span class = "special" > > </ span > < span class = "identifier" > add</ span >< span class = "special" > ;</ span >
< span class = "identifier" > assert</ span >< span class = "special" > (</ span >< span class = "identifier" > invoke</ span >< span class = "special" > (</ span >< span class = "identifier" > add</ span >< span class = "special" > ,</ span >< a href = "../../../container/generation/functions/make_vector.html" title = "make_vector" >< tt class = "computeroutput" >< span class = "identifier" > make_vector</ span ></ tt ></ a >< span class = "special" > (</ span >< span class = "number" > 1</ span >< span class = "special" > ,</ span >< span class = "number" > 1</ span >< span class = "special" > ))</ span > < span class = "special" > ==</ span > < span class = "number" > 2</ span >< span class = "special" > );</ span >
</ pre >
< a name = "fusion.functional.invocation.functions.invoke.see_also" ></ a >< h6 >
2007-12-20 23:28:26 +00:00
< a name = "id658300" ></ a >
2007-11-06 12:13:52 +00:00
< a href = "invoke.html#fusion.functional.invocation.functions.invoke.see_also" > See
also</ a >
</ h6 >
< div class = "itemizedlist" >< ul type = "disc" >
< li >< a href = "invoke_proc.html" title = "
invoke_procedure" >< tt class = "computeroutput" >< span class = "identifier" > invoke_procedure</ span ></ tt ></ a ></ li >
< li >< a href = "invoke_fobj.html" title = "
invoke_function_object" >< tt class = "computeroutput" >< span class = "identifier" > invoke_function_object</ span ></ tt ></ a ></ li >
< li >< a href = "../metafunctions/invoke.html" title = "invoke" >< tt class = "computeroutput" >< span class = "identifier" > result_of</ span >< span class = "special" > ::</ span >< span class = "identifier" > invoke</ span ></ tt ></ a ></ li >
< li >< a href = "../../adapters/fused.html" title = "fused" >< tt class = "computeroutput" >< span class = "identifier" > fused</ span ></ tt ></ a ></ li >
</ ul ></ div >
</ div >
< table xmlns:rev = "http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width = "100%" >< tr >
< td align = "left" ></ td >
2007-11-14 10:17:09 +00:00
< td align = "right" >< div class = "copyright-footer" > Copyright © 2001-2007 Joel de Guzman, Dan Marsden, Tobias
2007-11-07 02:12:28 +00:00
Schwinger< p >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt</ a > )
2007-11-14 10:17:09 +00:00
</ p >
</ div ></ td >
2007-11-06 12:13:52 +00:00
</ tr ></ table >
< hr >
< div class = "spirit-nav" >
< a accesskey = "p" href = "../functions.html" >< img src = "../../../../../../../../doc/html/images/prev.png" alt = "Prev" ></ a >< a accesskey = "u" href = "../functions.html" >< img src = "../../../../../../../../doc/html/images/up.png" alt = "Up" ></ a >< a accesskey = "h" href = "../../../../index.html" >< img src = "../../../../../../../../doc/html/images/home.png" alt = "Home" ></ a >< a accesskey = "n" href = "invoke_proc.html" >< img src = "../../../../../../../../doc/html/images/next.png" alt = "Next" ></ a >
</ div >
</ body >
</ html >
