File: as_child_id1264710.html

package info (click to toggle)
boost1.42 1.42.0-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 277,864 kB
  • ctags: 401,076
  • sloc: cpp: 1,235,659; xml: 74,142; ansic: 41,313; python: 26,756; sh: 11,840; cs: 2,118; makefile: 655; perl: 494; yacc: 456; asm: 353; csh: 6
file content (80 lines) | stat: -rwxr-xr-x 6,862 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Function as_child</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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 &lt;boost/proto/traits.hpp&gt;">
<link rel="prev" href="as_expr_id1264483.html" title="Function as_expr">
<link rel="next" href="child_id1264914.html" title="Function child">
</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="as_expr_id1264483.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.traits_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="child_id1264914.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Function as_child">
<a name="boost.proto.as_child_id1264710"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function as_child</span></h2>
<p>boost::proto::as_child &#8212; A function that wraps non-Proto expression types in Proto terminals (by reference) and leaves
          Proto expression types alone.</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="emphasis"><em>// In header: &lt;<a class="link" href="../../proto/reference.html#header.boost.proto.traits_hpp" title="Header &lt;boost/proto/traits.hpp&gt;">boost/proto/traits.hpp</a>&gt;

</em></span>
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; 
  <span class="type"><span class="bold"><strong>typename</strong></span> <a class="link" href="result_of/as_child.html" title="Struct template as_child">proto::result_of::as_child</a>&lt; T &gt;::type</span> as_child(T &amp; t);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; 
  <span class="type"><span class="bold"><strong>typename</strong></span> <a class="link" href="result_of/as_child.html" title="Struct template as_child">proto::result_of::as_child</a>&lt; T <span class="bold"><strong>const</strong></span> &gt;::type</span> as_child(T <span class="bold"><strong>const</strong></span> &amp; t);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Domain, <span class="bold"><strong>typename</strong></span> T&gt; 
  <span class="type"><span class="bold"><strong>typename</strong></span> <a class="link" href="result_of/as_child.html" title="Struct template as_child">proto::result_of::as_child</a>&lt; T, Domain &gt;::type</span> as_child(T &amp; t);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Domain, <span class="bold"><strong>typename</strong></span> T&gt; 
  <span class="type"><span class="bold"><strong>typename</strong></span> <a class="link" href="result_of/as_child.html" title="Struct template as_child">proto::result_of::as_child</a>&lt; T <span class="bold"><strong>const</strong></span>, Domain &gt;::type</span> 
  as_child(T <span class="bold"><strong>const</strong></span> &amp; t);</pre></div>
<div class="refsect1" title="Description">
<a name="id1660907"></a><h2>Description</h2>
<p>
            The <code class="computeroutput">proto::as_child()</code> function turns objects into Proto terminals
            if they are not Proto expression types already. Non-Proto types are held by reference. Types which
            are already Proto types are simply returned as-is.
          </p>
<p>
            This function can be called either with an explicitly specified
            <code class="computeroutput">Domain</code> parameter
            (i.e., <code class="computeroutput">proto::as_child&lt;Domain&gt;(t)</code>), or without
            (i.e., <code class="computeroutput">proto::as_child(t)</code>). If no domain is specified,
            <code class="computeroutput"><code class="computeroutput"><a class="link" href="default_domain.html" title="Struct default_domain">proto::default_domain</a></code></code> is assumed.
          </p>
<p>
            If <code class="computeroutput"><code class="computeroutput"><a class="link" href="is_expr.html" title="Struct template is_expr">proto::is_expr</a></code>&lt;T&gt;::value</code> is
            <code class="computeroutput">true</code>, then the argument is returned as-is. Otherwise,
            <code class="computeroutput">proto::as_child()</code> returns
            <code class="computeroutput">Domain()(<code class="computeroutput"><a class="link" href="terminal.html" title="Struct template terminal">proto::terminal</a></code>&lt;T &amp;&gt;::type::make(t))</code>.
          </p>
</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 &#169; 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="as_expr_id1264483.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.traits_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="child_id1264914.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>