3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Struct template expr</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="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="../../proto/reference.html#header.boost.proto.expr_hpp" title="Header <boost/proto/expr.hpp>">
9 <link rel="prev" href="basic_expr.html" title="Struct template basic_expr">
10 <link rel="next" href="expr/result.html" title="Struct template result">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="basic_expr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.expr_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="expr/result.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.proto.expr"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Struct template expr</span></h2>
29 <p>boost::proto::expr — Representation of a node in an expression tree.</p>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../proto/reference.html#header.boost.proto.expr_hpp" title="Header <boost/proto/expr.hpp>">boost/proto/expr.hpp</a>>
34 </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Tag<span class="special">,</span> <span class="keyword">typename</span> Args<span class="special">,</span> <span class="keyword">long</span> Arity <span class="special">=</span> <span class="identifier">Args</span><span class="special">::</span><span class="identifier">arity</span><span class="special">></span>
35 <span class="keyword">struct</span> <a class="link" href="expr.html" title="Struct template expr">expr</a> <span class="special">{</span>
36 <span class="comment">// types</span>
37 <span class="keyword">typedef</span> <span class="identifier">Tag</span> <a name="boost.proto.expr.proto_tag"></a><span class="identifier">proto_tag</span><span class="special">;</span>
38 <span class="keyword">typedef</span> <span class="identifier">Args</span> <a name="boost.proto.expr.proto_args"></a><span class="identifier">proto_args</span><span class="special">;</span>
39 <span class="keyword">typedef</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">long_</span><span class="special"><</span> <span class="identifier">Arity</span> <span class="special">></span> <a name="boost.proto.expr.proto_arity"></a><span class="identifier">proto_arity</span><span class="special">;</span>
40 <span class="keyword">typedef</span> <a class="link" href="default_domain.html" title="Struct default_domain">proto::default_domain</a> <a name="boost.proto.expr.proto_domain"></a><span class="identifier">proto_domain</span><span class="special">;</span>
41 <span class="keyword">typedef</span> <a class="link" href="basic_expr.html" title="Struct template basic_expr">proto::basic_expr</a><span class="special"><</span> <span class="identifier">Tag</span><span class="special">,</span> <span class="identifier">Args</span><span class="special">,</span> <span class="identifier">Arity</span> <span class="special">></span> <a name="boost.proto.expr.proto_grammar"></a><span class="identifier">proto_grammar</span><span class="special">;</span>
42 <span class="keyword">typedef</span> <span class="identifier">expr</span> <a name="boost.proto.expr.proto_base_expr"></a><span class="identifier">proto_base_expr</span><span class="special">;</span>
43 <span class="keyword">typedef</span> <span class="identifier">expr</span> <a name="boost.proto.expr.proto_derived_expr"></a><span class="identifier">proto_derived_expr</span><span class="special">;</span>
44 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">Args</span><span class="special">::</span><span class="identifier">child</span><em class="replaceable"><code><span class="identifier">N</span></code></em> <a name="boost.proto.expr.proto_childN"></a><span class="identifier">proto_childN</span><span class="special">;</span> <span class="comment">// For each <em class="replaceable"><code>N</code></em> in <em class="replaceable"><code>[0,max(Arity,1))</code></em>.</span>
46 <span class="comment">// member classes/structs/unions</span>
47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Signature<span class="special">></span>
48 <span class="keyword">struct</span> <a class="link" href="expr/result.html" title="Struct template result">result</a> <span class="special">{</span>
49 <span class="comment">// types</span>
50 <span class="keyword">typedef</span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr/result.html#boost.proto.expr.result.type"><span class="identifier">type</span></a><span class="special">;</span>
51 <span class="special">}</span><span class="special">;</span>
53 <span class="comment">// <a class="link" href="expr.html#idp205055184-bb">public static functions</a></span>
54 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <span class="keyword">static</span> <span class="identifier">expr</span> <span class="keyword">const</span> <a class="link" href="expr.html#idp205056064-bb"><span class="identifier">make</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
56 <span class="comment">// <a class="link" href="expr.html#idp205063168-bb">public member functions</a></span>
57 <span class="identifier">expr</span> <span class="special">&</span> <a class="link" href="expr.html#idp205063728-bb"><span class="identifier">proto_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
58 <span class="identifier">expr</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="expr.html#idp205065600-bb"><span class="identifier">proto_base</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
59 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205068384-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
60 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205073664-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
61 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205078208-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
62 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205083024-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
63 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205088160-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
64 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205093440-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
65 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205097984-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
66 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205102800-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
67 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205107936-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
68 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a class="link" href="expr.html#idp205113792-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
70 <span class="comment">// public data members</span>
71 <span class="identifier">proto_child</span><em class="replaceable"><code><span class="identifier">N</span></code></em> <span class="identifier">childN</span><span class="special">;</span> <span class="comment">// For each <em class="replaceable"><code>N</code></em> in <em class="replaceable"><code>[0,max(Arity,1))</code></em>.</span>
72 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">long</span> <span class="identifier">proto_arity_c</span><span class="special">;</span> <span class="comment">// <code class="computeroutput">= Arity;</code></span>
73 <span class="special">}</span><span class="special">;</span></pre></div>
74 <div class="refsect1">
75 <a name="idp370144832"></a><h2>Description</h2>
77 <code class="computeroutput">proto::expr<></code> is a node in an expression
78 template tree. It is a container for its child sub-trees. It also serves as the
79 terminal nodes of the tree.
82 <code class="computeroutput">Tag</code> is type that represents the operation
83 encoded by this expression. It is typically one of the structs in the
84 <code class="computeroutput">boost::proto::tag</code> namespace, but it doesn't
85 have to be. If <code class="computeroutput">Arity</code> is 0 then this
86 <code class="computeroutput">expr<></code> type represents a leaf in the
90 <code class="computeroutput">Args</code> is a list of types representing
91 the children of this expression. It is an instantiation of one of
92 <code class="computeroutput"><a class="link" href="listN.html" title="Struct template listN">proto::list1<></a></code>,
93 <code class="computeroutput"><a class="link" href="listN.html" title="Struct template listN">proto::list2<></a></code>,
95 must all themselves be either <code class="computeroutput">proto::expr<></code>
96 or <code class="computeroutput">proto::basic_expr<>&</code> (or extensions thereof via
97 <code class="computeroutput"><a class="link" href="extends.html" title="Struct template extends">proto::extends<></a></code> or
98 <code class="computeroutput"><a class="link" href="../../BOOST_PROTO_EXTENDS.html" title="Macro BOOST_PROTO_EXTENDS">BOOST_PROTO_EXTENDS</a>()</code>), unless
99 <code class="computeroutput">Arity</code> is 0, in which case
100 <code class="computeroutput">Args</code> must be
101 <code class="computeroutput">proto::term<T></code>, where
102 <code class="computeroutput">T</code> can be any type.
105 <code class="computeroutput">proto::expr<></code> is a valid Fusion
106 random-access sequence, where the elements of the sequence are the child
109 <div class="refsect2">
110 <a name="idp370162128"></a><h3>
111 <a name="idp205055184-bb"></a><code class="computeroutput">expr</code> public static functions</h3>
112 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
113 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <span class="keyword">static</span> <span class="identifier">expr</span> <span class="keyword">const</span> <a name="idp205056064-bb"></a><span class="identifier">make</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span> a<span class="special">)</span><span class="special">;</span></pre>
114 <div class="variablelist"><table border="0" class="variablelist compact">
116 <col align="left" valign="top">
121 <td><p><span class="term">Requires:</span></p></td>
123 The number of supplied arguments must be <code class="computeroutput">max(Arity,1)</code>.
127 <td><p><span class="term">Returns:</span></p></td>
129 A new <code class="computeroutput">expr</code> object initialized with the specified arguments.
136 <div class="refsect2">
137 <a name="idp370179280"></a><h3>
138 <a name="idp205063168-bb"></a><code class="computeroutput">expr</code> public member functions</h3>
139 <div class="orderedlist"><ol class="orderedlist" type="1">
140 <li class="listitem">
141 <pre class="literallayout"><span class="identifier">expr</span> <span class="special">&</span> <a name="idp205063728-bb"></a><span class="identifier">proto_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
142 <div class="variablelist"><table border="0" class="variablelist compact">
144 <col align="left" valign="top">
148 <td><p><span class="term">Returns:</span></p></td>
149 <td><p><code class="computeroutput">*this</code></p></td>
153 <li class="listitem">
154 <pre class="literallayout"><span class="identifier">expr</span> <span class="keyword">const</span> <span class="special">&</span> <a name="idp205065600-bb"></a><span class="identifier">proto_base</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
155 <p>This is an overloaded member function, provided for convenience. It differs from
156 the above function only in what argument(s) it accepts.</p>
158 <li class="listitem">
159 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205068384-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
160 <p>Lazy assignment expression</p>
161 <div class="variablelist"><table border="0" class="variablelist compact">
163 <col align="left" valign="top">
167 <td><p><span class="term">Returns:</span></p></td>
168 <td><p>A new expression node representing the assignment operation.</p></td>
172 <li class="listitem">
173 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205073664-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
175 This is an overloaded member function, provided for convenience. It differs from
176 the above function only in what argument(s) it accepts.
179 <li class="listitem">
180 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205078208-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
182 This is an overloaded member function, provided for convenience. It differs from
183 the above function only in what argument(s) it accepts.
186 <li class="listitem">
187 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205083024-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
189 This is an overloaded member function, provided for convenience. It differs from
190 the above function only in what argument(s) it accepts.
193 <li class="listitem">
194 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205088160-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
195 <p>Lazy subscript expression</p>
196 <div class="variablelist"><table border="0" class="variablelist compact">
198 <col align="left" valign="top">
202 <td><p><span class="term">Returns:</span></p></td>
203 <td><p>A new expression node representing the subscript operation.</p></td>
207 <li class="listitem">
208 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205093440-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
210 This is an overloaded member function, provided for convenience. It differs from
211 the above function only in what argument(s) it accepts.
214 <li class="listitem">
215 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205097984-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">A</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
217 This is an overloaded member function, provided for convenience. It differs from
218 the above function only in what argument(s) it accepts.
221 <li class="listitem">
222 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205102800-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
224 This is an overloaded member function, provided for convenience. It differs from
225 the above function only in what argument(s) it accepts.
228 <li class="listitem">
229 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205107936-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span> a<span class="special">)</span><span class="special">;</span></pre>
230 <p>Lazy function call</p>
231 <div class="variablelist"><table border="0" class="variablelist compact">
233 <col align="left" valign="top">
237 <td><p><span class="term">Returns:</span></p></td>
238 <td><p>A new expression node representing the function call operation.</p></td>
242 <li class="listitem">
243 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> A<span class="special">></span> <em class="replaceable"><code><span class="identifier">unspecified</span></code></em> <a name="idp205113792-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">A</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">...</span> a<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
245 This is an overloaded member function, provided for convenience. It differs from
246 the above function only in what argument(s) it accepts.
253 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
254 <td align="left"></td>
255 <td align="right"><div class="copyright-footer">Copyright © 2008 Eric Niebler<p>
256 Distributed under the Boost Software License, Version 1.0. (See accompanying
257 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>)
262 <div class="spirit-nav">
263 <a accesskey="p" href="basic_expr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.expr_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="expr/result.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>