libs/fusion/doc/html/fusion/functional/invocation/functions/invoke.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>invoke</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.2">
   8 <link rel="up" href="../functions.html" title="Functions">
   9 <link rel="prev" href="../functions.html" title="Functions">
  10 <link rel="next" href="invoke_proc.html" title="invoke_procedure">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../functions.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="invoke_proc.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="fusion.functional.invocation.functions.invoke"></a><a class="link" href="invoke.html" title="invoke">invoke</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="fusion.functional.invocation.functions.invoke.h0"></a>
  31             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.description"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.description">Description</a>
  32           </h6>
  33 <p>
  34             Calls a <a class="link" href="../../concepts/def_callable.html" title="Deferred Callable Object">Deferred
  35             Callable Object</a> with the arguments from a <a class="link" href="../../../sequence.html" title="Sequence">Sequence</a>.
  36           </p>
  37 <p>
  38             The first template parameter can be specialized explicitly to avoid copying
  39             and/or to control the const qualification of a function object.
  40           </p>
  41 <p>
  42             If the target function is a pointer to a class members, the corresponding
  43             object can be specified as a reference, pointer, or smart pointer. In
  44             case of the latter, a freestanding <code class="literal">get_pointer</code> function
  45             must be defined (Boost provides this function for <code class="literal">std::auto_ptr</code>
  46             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>).
  47           </p>
  48 <p>
  49             Constructors can be called applying <a href="http://www.boost.org/libs/functional/factory/doc/html/index.html" target="_top">Boost.Functional/Factory</a>.
  50           </p>
  51 <h6>
  52 <a name="fusion.functional.invocation.functions.invoke.h1"></a>
  53             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.synopsis"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.synopsis">Synopsis</a>
  54           </h6>
  55 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  56     <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
  57     <span class="keyword">class</span> <span class="identifier">Sequence</span>
  58     <span class="special">&gt;</span>
  59 <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">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
  60 <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">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
  61
  62 <span class="keyword">template</span><span class="special">&lt;</span>
  63     <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
  64     <span class="keyword">class</span> <span class="identifier">Sequence</span>
  65     <span class="special">&gt;</span>
  66 <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">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
  67 <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">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
  68 </pre>
  69 <h6>
  70 <a name="fusion.functional.invocation.functions.invoke.h2"></a>
  71             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.parameters"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.parameters">Parameters</a>
  72           </h6>
  73 <div class="informaltable"><table class="table">
  74 <colgroup>
  75 <col>
  76 <col>
  77 <col>
  78 </colgroup>
  79 <thead><tr>
  80 <th>
  81                     <p>
  82                       Parameter
  83                     </p>
  84                   </th>
  85 <th>
  86                     <p>
  87                       Requirement
  88                     </p>
  89                   </th>
  90 <th>
  91                     <p>
  92                       Description
  93                     </p>
  94                   </th>
  95 </tr></thead>
  96 <tbody>
  97 <tr>
  98 <td>
  99                     <p>
 100                       <code class="computeroutput"><span class="identifier">f</span></code>
 101                     </p>
 102                   </td>
 103 <td>
 104                     <p>
 105                       A <a class="link" href="../../concepts/def_callable.html" title="Deferred Callable Object">Deferred
 106                       Callable Object</a>
 107                     </p>
 108                   </td>
 109 <td>
 110                     <p>
 111                       The function to call.
 112                     </p>
 113                   </td>
 114 </tr>
 115 <tr>
 116 <td>
 117                     <p>
 118                       <code class="computeroutput"><span class="identifier">s</span></code>
 119                     </p>
 120                   </td>
 121 <td>
 122                     <p>
 123                       A <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
 124                       Sequence</a>
 125                     </p>
 126                   </td>
 127 <td>
 128                     <p>
 129                       The arguments.
 130                     </p>
 131                   </td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 <h6>
 136 <a name="fusion.functional.invocation.functions.invoke.h3"></a>
 137             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.expression_semantics"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.expression_semantics">Expression
 138             Semantics</a>
 139           </h6>
 140 <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>
 141 </pre>
 142 <p>
 143             <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
 144             <code class="computeroutput"><span class="identifier">s</span></code> as its arguments.
 145           </p>
 146 <p>
 147             <span class="bold"><strong>Semantics</strong></span>: Invokes <code class="computeroutput"><span class="identifier">f</span></code>
 148             with the elements in <code class="computeroutput"><span class="identifier">s</span></code>
 149             as arguments and returns the result of the call expression.
 150           </p>
 151 <h6>
 152 <a name="fusion.functional.invocation.functions.invoke.h4"></a>
 153             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.header"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.header">Header</a>
 154           </h6>
 155 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
 156 </pre>
 157 <h6>
 158 <a name="fusion.functional.invocation.functions.invoke.h5"></a>
 159             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.example"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.example">Example</a>
 160           </h6>
 161 <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">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">add</span><span class="special">;</span>
 162 <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>
 163 </pre>
 164 <h6>
 165 <a name="fusion.functional.invocation.functions.invoke.h6"></a>
 166             <span class="phrase"><a name="fusion.functional.invocation.functions.invoke.see_also"></a></span><a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.see_also">See
 167             also</a>
 168           </h6>
 169 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 170 <li class="listitem">
 171                 <a class="link" href="invoke_proc.html" title="invoke_procedure"><code class="computeroutput"><span class="identifier">invoke_procedure</span></code></a>
 172               </li>
 173 <li class="listitem">
 174                 <a class="link" href="invoke_fobj.html" title="invoke_function_object"><code class="computeroutput"><span class="identifier">invoke_function_object</span></code></a>
 175               </li>
 176 <li class="listitem">
 177                 <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>
 178               </li>
 179 <li class="listitem">
 180                 <a class="link" href="../../adapters/fused.html" title="fused"><code class="computeroutput"><span class="identifier">fused</span></code></a>
 181               </li>
 182 <li class="listitem">
 183                 <a class="link" href="../../generation/functions/mk_fused.html" title="make_fused"><code class="computeroutput"><span class="identifier">make_fused</span></code></a>
 184               </li>
 185 </ul></div>
 186 </div>
 187 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 188 <td align="left"></td>
 189 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2006, 2011, 2012 Joel de Guzman,
 190       Dan Marsden, Tobias Schwinger<p>
 191         Distributed under the Boost Software License, Version 1.0. (See accompanying
 192         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>)
 193       </p>
 194 </div></td>
 195 </tr></table>
 196 <hr>
 197 <div class="spirit-nav">
 198 <a accesskey="p" href="../functions.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="invoke_proc.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 199 </div>
 200 </body>
 201 </html>