/Src/Dependencies/Boost/libs/phoenix/doc/html/phoenix/actor.html

http://hadesmem.googlecode.com/ · HTML · 90 lines · 87 code · 3 blank · 0 comment · 0 complexity · dd3ee98065ff5641094983939fa3634d MD5 · raw file 

    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Actor</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
    7. 

  7. <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
    8. 

  8. <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
    9. 

  9. <link rel="prev" href="organization.html" title="Organization">
    10. 

  10. <link rel="next" href="modules.html" title="Modules">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="organization.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="modules.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
    27. 

  27. <a name="phoenix.actor"></a><a class="link" href="actor.html" title="Actor">Actor</a>
    28. 

  28. </h2></div></div></div>
    29. 

  29. <p>
    30. 

  30.       The <code class="computeroutput"><span class="identifier">Actor</span></code> is the main concept
    31. 

  31.       behind the library. Actors are function objects. An actor can accept 0 to
    32. 

  32.       <code class="computeroutput"><span class="identifier">BOOST_PHOENIX_LIMIT</span></code> arguments.
    33. 

  33.     </p>
    34. 

  34. <div class="note"><table border="0" summary="Note">
    35. 

  35. <tr>
    36. 

  36. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
    37. 

  37. <th align="left">Note</th>
    38. 

  38. </tr>
    39. 

  39. <tr><td align="left" valign="top"><p>
    40. 

  40.         You can set <code class="computeroutput"><span class="identifier">BOOST_PHOENIX_LIMIT</span></code>,
    41. 

  41.         the predefined maximum arity an actor can take. By default, <code class="computeroutput"><span class="identifier">BOOST_PHOENIX_LIMIT</span></code> is set to 10.
    42. 

  42.       </p></td></tr>
    43. 

  43. </table></div>
    44. 

  44. <p>
    45. 

  45.       Phoenix supplies an <code class="computeroutput"><span class="identifier">actor</span></code> class
    46. 

  46.       template whose specializations model the <code class="computeroutput"><span class="identifier">Actor</span></code>
    47. 

  47.       concept. <code class="computeroutput"><span class="identifier">actor</span></code> has one template
    48. 

  48.       parameter, <code class="computeroutput"><span class="identifier">Expr</span></code>, that supplies
    49. 

  49.       the underlying expression to evaluate.
    50. 

  50.     </p>
    51. 

  51. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Expr</span><span class="special">&gt;</span>
    52. 

  52. <span class="keyword">struct</span> <span class="identifier">actor</span>
    53. 

  53. <span class="special">{</span>
    54. 

  54.     <span class="identifier">return_type</span>
    55. 

  55.     <span class="keyword">operator</span><span class="special">()()</span> <span class="keyword">const</span><span class="special">;</span>
    56. 

  56. 

  57.     <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">&gt;</span>
    58. 

  58.     <span class="identifier">return_type</span>
    59. 

  59.     <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">T0</span><span class="special">&amp;</span> <span class="identifier">_0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    60. 

  60. 

  61.     <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">&gt;</span>
    62. 

  62.     <span class="identifier">return_type</span>
    63. 

  63.     <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">T0</span><span class="special">&amp;</span> <span class="identifier">_0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">&amp;</span> <span class="identifier">_1</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    64. 

  64. 

  65.     <span class="comment">//...
    66. 

  66. </span><span class="special">};</span>
    67. 

  67. </pre>
    68. 

  68. <p>
    69. 

  69.       The actor class accepts the arguments through a set of function call operators
    70. 

  70.       for 0 to <code class="computeroutput"><span class="identifier">BOOST_PHOENIX_LIMIT</span></code>
    71. 

  71.       arities (Don't worry about the details, for now. Note, for example, that we
    72. 

  72.       skimp over the details regarding <code class="computeroutput"><span class="identifier">return_type</span></code>).
    73. 

  73.       The arguments are passed through to the evaluation mechanism. For more information
    74. 

  74.       see <a class="link" href="inside/actor.html" title="Actors in Detail">Inside Actors</a>.
    75. 

  75.     </p>
    76. 

  76. </div>
    77. 

  77. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    78. 

  78. <td align="left"></td>
    79. 

  79. <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2005, 2010 Joel de Guzman, Dan Marsden, Thomas Heller<p>
    80. 

  80.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    81. 

  81.         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>)
    82. 

  82.       </p>
    83. 

  83. </div></td>
    84. 

  84. </tr></table>
    85. 

  85. <hr>
    86. 

  86. <div class="spirit-nav">
    87. 

  87. <a accesskey="p" href="organization.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="modules.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
    88. 

  88. </div>
    89. 

  89. </body>
    90. 

  90. </html>
    91.