2007-11-06 12:13:52 +00:00
< html >
< head >
2009-12-11 21:01:22 +00:00
< meta http-equiv = "Content-Type" content = "text/html; charset=US-ASCII" >
2007-11-06 12:13:52 +00:00
< title > invoke< / title >
2007-11-07 03:46:23 +00:00
< link rel = "stylesheet" href = "../../../../../../../../doc/html/boostbook.css" type = "text/css" >
2009-10-24 10:59:01 +00:00
< meta name = "generator" content = "DocBook XSL Stylesheets V1.75.1" >
2009-12-11 21:01:22 +00:00
< link rel = "home" href = "../../../../index.html" title = "Chapter 1. Fusion 2.0" >
2007-11-06 12:13:52 +00:00
< link rel = "up" href = "../functions.html" title = "Functions" >
2009-09-25 00:21:53 +00:00
< link rel = "prev" href = "../functions.html" title = "Functions" >
< link rel = "next" href = "invoke_proc.html" title = "invoke_procedure" >
2007-11-06 12:13:52 +00:00
< / 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 >
2008-07-17 23:59:22 +00:00
< td align = "center" > < a href = "../../../../../../../../index.html" > Home< / a > < / td >
2007-11-06 12:13:52 +00:00
< td align = "center" > < a href = "../../../../../../../libraries.htm" > Libraries< / a > < / td >
2008-07-17 23:59:22 +00:00
< td align = "center" > < a href = "http://www.boost.org/users/people.html" > People< / a > < / td >
< td align = "center" > < a href = "http://www.boost.org/users/faq.html" > FAQ< / a > < / td >
2007-11-06 12:13:52 +00:00
< 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 >
2009-09-25 00:21:53 +00:00
< div class = "section" title = "invoke" >
< div class = "titlepage" > < div > < div > < h5 class = "title" >
< a name = "fusion.functional.invocation.functions.invoke" > < / a > < a class = "link" href = "invoke.html" title = "invoke" > invoke< / a >
< / h5 > < / div > < / div > < / div >
2007-11-06 12:13:52 +00:00
< a name = "fusion.functional.invocation.functions.invoke.description" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828112" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.description" > Description< / a >
2007-11-06 12:13:52 +00:00
< / h6 >
< p >
2009-09-25 00:21:53 +00:00
Calls a < a class = "link" href = "../../concepts/def_callable.html" title = "Deferred Callable Object" > Deferred
Callable Object< / a > with the arguments from a < a class = "link" href = "../../../sequence.html" title = "Sequence" > Sequence< / a > .
2007-11-06 12:13:52 +00:00
< / 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
2009-09-25 00:21:53 +00:00
case of the latter, a freestanding < code class = "literal" > get_pointer< / code > function
must be defined (Boost provides this function for < code class = "literal" > std::auto_ptr< / code >
and < a href = "http://www.boost.org/libs/smart_ptr/shared_ptr.htm" target = "_top" > < code class = "computeroutput" > < span class = "identifier" > boost< / span > < span class = "special" > ::< / span > < span class = "identifier" > shared_ptr< / span > < / code > < / a > ).
2009-02-22 06:27:12 +00:00
< / p >
< p >
Constructors can be called applying < a href = "http://www.boost.org/libs/functional/factory/doc/html/index.html" target = "_top" > Boost.Functional/Factory< / a > .
2007-11-06 12:13:52 +00:00
< / p >
< a name = "fusion.functional.invocation.functions.invoke.synopsis" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828183" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.synopsis" > Synopsis< / a >
2007-11-06 12:13:52 +00:00
< / h6 >
2009-02-22 06:27:12 +00:00
< 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 >
2009-09-25 00:21:53 +00:00
< span class = "keyword" > typename< / span > < a class = "link" href = "../metafunctions/invoke.html" title = "invoke" > < code class = "computeroutput" > < span class = "identifier" > result_of< / span > < span class = "special" > ::< / span > < span class = "identifier" > invoke< / span > < / code > < / 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 >
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 = "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 >
2009-09-25 00:21:53 +00:00
< span class = "keyword" > typename< / span > < a class = "link" href = "../metafunctions/invoke.html" title = "invoke" > < code class = "computeroutput" > < span class = "identifier" > result_of< / span > < span class = "special" > ::< / span > < span class = "identifier" > invoke< / span > < / code > < / 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 >
2009-12-29 14:10:17 +00:00
< a name = "id828450" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.parameters" > Parameters< / a >
2007-11-06 12:13:52 +00:00
< / h6 >
< div class = "informaltable" > < table class = "table" >
< colgroup >
< col >
< col >
< col >
< / colgroup >
< thead > < tr >
2009-09-25 00:21:53 +00:00
< th >
< p >
2007-11-06 12:13:52 +00:00
Parameter
2009-09-25 00:21:53 +00:00
< / p >
< / th >
< th >
< p >
2007-11-06 12:13:52 +00:00
Requirement
2009-09-25 00:21:53 +00:00
< / p >
< / th >
< th >
< p >
2007-11-06 12:13:52 +00:00
Description
2009-09-25 00:21:53 +00:00
< / p >
< / th >
2007-11-06 12:13:52 +00:00
< / tr > < / thead >
< tbody >
< tr >
2009-09-25 00:21:53 +00:00
< td >
< p >
< code class = "computeroutput" > < span class = "identifier" > f< / span > < / code >
< / p >
< / td >
< td >
< p >
A < a class = "link" href = "../../concepts/def_callable.html" title = "Deferred Callable Object" > Deferred
2007-11-06 12:13:52 +00:00
Callable Object< / a >
2009-09-25 00:21:53 +00:00
< / p >
< / td >
< td >
< p >
2007-11-06 12:13:52 +00:00
The function to call.
2009-09-25 00:21:53 +00:00
< / p >
< / td >
2007-11-06 12:13:52 +00:00
< / tr >
< tr >
2009-09-25 00:21:53 +00:00
< td >
< p >
< code class = "computeroutput" > < span class = "identifier" > s< / span > < / code >
< / p >
< / td >
< td >
< p >
A < a class = "link" href = "../../../sequence/concepts/forward_sequence.html" title = "Forward Sequence" > Forward
2007-11-06 12:13:52 +00:00
Sequence< / a >
2009-09-25 00:21:53 +00:00
< / p >
< / td >
< td >
< p >
2007-11-06 12:13:52 +00:00
The arguments.
2009-09-25 00:21:53 +00:00
< / p >
< / td >
2007-11-06 12:13:52 +00:00
< / tr >
< / tbody >
< / table > < / div >
< a name = "fusion.functional.invocation.functions.invoke.expression_semantics" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828576" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.expression_semantics" > Expression
2007-11-06 12:13:52 +00:00
Semantics< / a >
< / h6 >
2009-02-22 06:27:12 +00:00
< 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 >
2007-11-06 12:13:52 +00:00
< / pre >
< p >
2009-09-25 00:21:53 +00:00
< span class = "bold" > < strong > Return type< / strong > < / span > : Return type of < code class = "computeroutput" > < span class = "identifier" > f< / span > < / code > when invoked with the elements in
< code class = "computeroutput" > < span class = "identifier" > s< / span > < / code > as its arguments.
2007-11-06 12:13:52 +00:00
< / p >
< p >
2009-09-25 00:21:53 +00:00
< span class = "bold" > < strong > Semantics< / strong > < / span > : Invokes < code class = "computeroutput" > < span class = "identifier" > f< / span > < / code >
with the elements in < code class = "computeroutput" > < span class = "identifier" > s< / span > < / code >
2007-11-06 12:13:52 +00:00
as arguments and returns the result of the call expression.
< / p >
2009-02-22 06:27:12 +00:00
< a name = "fusion.functional.invocation.functions.invoke.header" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828661" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.header" > Header< / a >
2009-02-22 06:27:12 +00:00
< / h6 >
< pre class = "programlisting" > < span class = "preprocessor" > #include< / span > < span class = "special" > < < / span > < span class = "identifier" > boost< / span > < span class = "special" > /< / span > < span class = "identifier" > fusion< / span > < span class = "special" > /< / span > < span class = "identifier" > functional< / span > < span class = "special" > /< / span > < span class = "identifier" > invocation< / span > < span class = "special" > /< / span > < span class = "identifier" > invoke< / span > < span class = "special" > .< / span > < span class = "identifier" > hpp< / span > < span class = "special" > > < / span >
< / pre >
2007-11-06 12:13:52 +00:00
< a name = "fusion.functional.invocation.functions.invoke.example" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828730" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.example" > Example< / a >
2007-11-06 12:13:52 +00:00
< / h6 >
2009-09-25 00:21:53 +00:00
< pre class = "programlisting" > < a href = "http://www.sgi.com/tech/stl/plus.html" target = "_top" > < code class = "computeroutput" > < span class = "identifier" > std< / span > < span class = "special" > ::< / span > < span class = "identifier" > plus< / span > < / code > < / 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 class = "link" href = "../../../container/generation/functions/make_vector.html" title = "make_vector" > < code class = "computeroutput" > < span class = "identifier" > make_vector< / span > < / code > < / 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 >
2007-11-06 12:13:52 +00:00
< / pre >
< a name = "fusion.functional.invocation.functions.invoke.see_also" > < / a > < h6 >
2009-12-29 14:10:17 +00:00
< a name = "id828846" > < / a >
2009-09-25 00:21:53 +00:00
< a class = "link" href = "invoke.html#fusion.functional.invocation.functions.invoke.see_also" > See
2007-11-06 12:13:52 +00:00
also< / a >
< / h6 >
2009-09-25 00:21:53 +00:00
< div class = "itemizedlist" > < ul class = "itemizedlist" type = "disc" >
< li class = "listitem" > < a class = "link" href = "invoke_proc.html" title = "invoke_procedure" > < code class = "computeroutput" > < span class = "identifier" > invoke_procedure< / span > < / code > < / a > < / li >
< li class = "listitem" > < a class = "link" href = "invoke_fobj.html" title = "invoke_function_object" > < code class = "computeroutput" > < span class = "identifier" > invoke_function_object< / span > < / code > < / a > < / li >
< li class = "listitem" > < a class = "link" href = "../metafunctions/invoke.html" title = "invoke" > < code class = "computeroutput" > < span class = "identifier" > result_of< / span > < span class = "special" > ::< / span > < span class = "identifier" > invoke< / span > < / code > < / a > < / li >
< li class = "listitem" > < a class = "link" href = "../../adapters/fused.html" title = "fused" > < code class = "computeroutput" > < span class = "identifier" > fused< / span > < / code > < / a > < / li >
< li class = "listitem" > < a class = "link" href = "../../generation/functions/mk_fused.html" title = "make_fused" > < code class = "computeroutput" > < span class = "identifier" > make_fused< / span > < / code > < / a > < / li >
2007-11-06 12:13:52 +00:00
< / ul > < / div >
< / div >
< table xmlns:rev = "http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width = "100%" > < tr >
< td align = "left" > < / td >
2009-12-11 21:01:22 +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 >
