diff options
Diffstat (limited to 'doc/html/boost/proto/functional/child.html')
-rwxr-xr-x | doc/html/boost/proto/functional/child.html | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/doc/html/boost/proto/functional/child.html b/doc/html/boost/proto/functional/child.html new file mode 100755 index 0000000000..4979a1b950 --- /dev/null +++ b/doc/html/boost/proto/functional/child.html @@ -0,0 +1,129 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template child</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../proto/reference.html#header.boost.proto.traits_hpp" title="Header <boost/proto/traits.hpp>"> +<link rel="prev" href="child_c/result_This_Expr__id1518688.html" title="Struct template result<This(Expr)>"> +<link rel="next" href="child/result_This_Expr__id1518943.html" title="Struct template result<This(Expr)>"> +</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> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<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> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="child_c/result_This_Expr__id1518688.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.traits_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="child/result_This_Expr__id1518943.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.proto.functional.child"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template child</span></h2> +<p>boost::proto::functional::child — A callable <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> that is equivalent to the + <code class="computeroutput"><a class="link" href="../child_id1527766.html" title="Function child">proto::child()</a></code> function.</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<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.traits_hpp" title="Header <boost/proto/traits.hpp>">boost/proto/traits.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> N <span class="special">=</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">long_</span><span class="special"><</span><span class="number">0</span><span class="special">></span> <span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="child.html" title="Struct template child">child</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> + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</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">></span> + <span class="keyword">struct</span> <a class="link" href="child/result_This_Expr__id1518943.html" title="Struct template result<This(Expr)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">)</span><span class="special">></span> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="../result_of/child.html" title="Struct template child">proto::result_of::child</a>< Expr, N > <span class="special">{</span> + <span class="special">}</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="child.html#id1518979-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">></span> + <span class="keyword">typename</span> <a class="link" href="../result_of/child.html" title="Struct template child">proto::result_of::child</a><span class="special"><</span> <span class="identifier">Expr</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> + <a class="link" href="child.html#id1518984-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="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">></span> + <span class="keyword">typename</span> <a class="link" href="../result_of/child.html" title="Struct template child">proto::result_of::child</a><span class="special"><</span> <span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> + <a class="link" href="child.html#id1519091-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id2806478"></a><h2>Description</h2> +<p> + A callable <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> that is equivalent to the + <code class="computeroutput"><a class="link" href="../child_id1527766.html" title="Function child">proto::child()</a></code> + function. <code class="computeroutput">N</code> is required to be an MPL Integral Constant. + </p> +<div class="refsect2"> +<a name="id2806512"></a><h3> +<a name="id1518979-bb"></a><code class="computeroutput">child</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">></span> + <span class="keyword">typename</span> <a class="link" href="../result_of/child.html" title="Struct template child">proto::result_of::child</a><span class="special"><</span> <span class="identifier">Expr</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> + <a name="id1518984-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="special">&</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p> + Return the <em class="replaceable"><code>N</code></em><sup>th</sup> child of the given expression. + </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><code class="computeroutput">expr</code></span></p></td> +<td><p>The expression node. </p></td> +</tr></tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> +<p> + <code class="computeroutput"><a class="link" href="../is_expr.html" title="Struct template is_expr">proto::is_expr</a><Expr>::value</code> is + <code class="computeroutput">true</code> + </p> +<p> + <code class="computeroutput">N::value < Expr::proto_arity::value</code> + </p> +</td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p> + <code class="computeroutput"><a class="link" href="../child_id1527766.html" title="Function child">proto::child</a><N>(expr)</code> + </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>Will not throw.</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">></span> + <span class="keyword">typename</span> <a class="link" href="../result_of/child.html" title="Struct template child">proto::result_of::child</a><span class="special"><</span> <span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> + <a name="id1519091-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">&</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2008 Eric Niebler<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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="child_c/result_This_Expr__id1518688.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.traits_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="child/result_This_Expr__id1518943.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |