doc/html/boost/proto/by_value_generator.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct by_value_generator</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../proto/reference.html#header.boost.proto.generate_hpp" title="Header &lt;boost/proto/generate.hpp&gt;">
  10 <link rel="prev" href="pod_generator/result_This_E_idp701464032.html" title="Struct template result&lt;This(Expr)&gt;">
  11 <link rel="next" href="by_value_generator/result_This_E_idp701481968.html" title="Struct template result&lt;This(Expr)&gt;">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="pod_generator/result_This_E_idp701464032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.generate_hpp"><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="by_value_generator/result_This_E_idp701481968.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.proto.by_value_generator"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct by_value_generator</span></h2>
  30 <p>boost::proto::by_value_generator &#8212; A generator that replaces child nodes held by reference with ones held by value.
  31           Use with <code class="computeroutput"><a class="link" href="compose_generators.html" title="Struct template compose_generators">proto::compose_generators&lt;&gt;</a>
  32           </code> to forward that result to another generator.
  33         </p>
  34 </div>
  35 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  36 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../proto/reference.html#header.boost.proto.generate_hpp" title="Header &lt;boost/proto/generate.hpp&gt;">boost/proto/generate.hpp</a>&gt;
  37
  38 </span>
  39 <span class="keyword">struct</span> <a class="link" href="by_value_generator.html" title="Struct by_value_generator">by_value_generator</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="callable.html" title="Struct callable">proto::callable</a> <span class="special">{</span>
  40   <span class="comment">// member classes/structs/unions</span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> This<span class="special">,</span> <span class="keyword">typename</span> <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  42   <span class="keyword">struct</span> <a class="link" href="by_value_generator/result_This_E_idp701481968.html" title="Struct template result&lt;This(Expr)&gt;">result</a><span class="special">&lt;</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">{</span>
  43     <span class="comment">// types</span>
  44     <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="by_value_generator/result_This_E_idp701481968.html#boost.proto.by_value_generator.result_This(E_idp701481968.type"><span class="identifier">type</span></a><span class="special">;</span>
  45   <span class="special">}</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="by_value_generator.html#idp701486448-bb">public member functions</a></span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="by_value_generator.html#idp701487008-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idp467093648"></a><h2>Description</h2>
  52 <p>
  53             Generators are intended for use as the first template parameter to the
  54             <code class="computeroutput"><a class="link" href="domain.html" title="Struct template domain">proto::domain&lt;&gt;</a></code>
  55             class template and control if and how expressions within that domain are to be customized.
  56             <code class="computeroutput">proto::by_value_generator</code> ensures all child nodes are held
  57             by value. This generator is typically composed with a second generator for further processing,
  58             as <code class="computeroutput"><a class="link" href="compose_generators.html" title="Struct template compose_generators">proto::compose_generators</a>&lt;proto::by_value_generator,
  59             MyGenerator&gt;</code>.
  60           </p>
  61 <div class="refsect2">
  62 <a name="idp467098368"></a><h3>
  63 <a name="idp701486448-bb"></a><code class="computeroutput">by_value_generator</code> public member functions</h3>
  64 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  65 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idp701487008-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  66 <div class="variablelist"><table border="0" class="variablelist compact">
  67 <colgroup>
  68 <col align="left" valign="top">
  69 <col>
  70 </colgroup>
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term">Parameters:</span></p></td>
  74 <td><div class="variablelist"><table border="0" class="variablelist compact">
  75 <colgroup>
  76 <col align="left" valign="top">
  77 <col>
  78 </colgroup>
  79 <tbody><tr>
  80 <td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
  81 <td><p>A Proto expression.</p></td>
  82 </tr></tbody>
  83 </table></div></td>
  84 </tr>
  85 <tr>
  86 <td><p><span class="term">Returns:</span></p></td>
  87 <td><p>Equivalent to <code class="computeroutput"><a class="link" href="deep_copy_idp700354384.html" title="Function template deep_copy">proto::deep_copy</a>(expr)</code></p></td>
  88 </tr>
  89 </tbody>
  90 </table></div>
  91 </li></ol></div>
  92 </div>
  93 </div>
  94 </div>
  95 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  96 <td align="left"></td>
  97 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
  98         Distributed under the Boost Software License, Version 1.0. (See accompanying
  99         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>)
 100       </p>
 101 </div></td>
 102 </tr></table>
 103 <hr>
 104 <div class="spirit-nav">
 105 <a accesskey="p" href="pod_generator/result_This_E_idp701464032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.generate_hpp"><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="by_value_generator/result_This_E_idp701481968.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 106 </div>
 107 </body>
 108 </html>