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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct _byref</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.transform.arg_hpp" title="Header <boost/proto/transform/arg.hpp>">
<link rel="prev" href="_value/impl.html" title="Struct template impl">
<link rel="next" href="_byref/result_This_T____id1266633.html" title="Struct template result<This(T &)>">
</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="_value/impl.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.arg_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="_byref/result_This_T____id1266633.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Struct _byref">
<a name="boost.proto._byref"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct _byref</span></h2>
<p>boost::proto::_byref — A unary callable <a class="link" href="../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> that wraps its argument
in a <code class="computeroutput">boost::reference_wrapper<></code>.</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: <<a class="link" href="../../proto/reference.html#header.boost.proto.transform.arg_hpp" title="Header <boost/proto/transform/arg.hpp>">boost/proto/transform/arg.hpp</a>>
</em></span>
<span class="bold"><strong>struct</strong></span> <a class="link" href="_byref.html" title="Struct _byref">_byref</a> : <span class="bold"><strong></strong></span> <a class="link" href="callable.html" title="Struct callable">proto::callable</a> {
<span class="emphasis"><em>// member classes/structs/unions</em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> This, <span class="bold"><strong>typename</strong></span> T>
<span class="bold"><strong>struct</strong></span> <a class="link" href="_byref/result_This_T____id1266633.html" title="Struct template result<This(T &)>">result</a><This(T &)> {
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> boost::reference_wrapper< T > <span class="bold"><strong>const</strong></span> <a class="link" href="_byref/result_This_T____id1266633.html#boost.proto._byref.result_This(T_&)_id1266633.type">type</a>;
};
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> This, <span class="bold"><strong>typename</strong></span> T>
<span class="bold"><strong>struct</strong></span> <a class="link" href="_byref/result_This_T__id1266669.html" title="Struct template result<This(T)>">result</a><This(T)> {
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> boost::reference_wrapper< T <span class="bold"><strong>const</strong></span> > <span class="bold"><strong>const</strong></span> <a class="link" href="_byref/result_This_T__id1266669.html#boost.proto._byref.result_This(T)_id1266669.type">type</a>;
};
<span class="emphasis"><em>// <a class="link" href="_byref.html#id1266705-bb">public member functions</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T>
<span class="type">boost::reference_wrapper< T > <span class="bold"><strong>const</strong></span></span> <a class="link" href="_byref.html#id1266710-bb"><span class="bold"><strong>operator</strong></span>()</a>(T &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T>
<span class="type">boost::reference_wrapper< T <span class="bold"><strong>const</strong></span> > <span class="bold"><strong>const</strong></span></span> <a class="link" href="_byref.html#id1266783-bb"><span class="bold"><strong>operator</strong></span>()</a>(T <span class="bold"><strong>const</strong></span> &) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1665012"></a><h2>Description</h2>
<p>
Example:
</p>
<pre class="programlisting"><a class="link" href="terminal.html" title="Struct template terminal">proto::terminal</a><int>::type i = {42};
boost::reference_wrapper<<a class="link" href="terminal.html" title="Struct template terminal">proto::terminal</a><int>::type> j
= <a class="link" href="when.html" title="Struct template when">proto::when</a><<a class="link" href="_.html" title="Struct _">proto::_</a>, proto::_byref(_)>()(i);
assert( boost::addressof(i) == boost::addressof(j.get()) );</pre>
<p>
</p>
<div class="refsect2" title="_byref public member functions">
<a name="id1665060"></a><h3>
<a name="id1266705-bb"></a><code class="computeroutput">_byref</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T>
<span class="type">boost::reference_wrapper< T > <span class="bold"><strong>const</strong></span></span> <a name="id1266710-bb"></a><span class="bold"><strong>operator</strong></span>()(T & t) <span class="bold"><strong>const</strong></span>;</pre>
<p>
Wrap the parameter <code class="computeroutput">t</code> in a
<code class="computeroutput">boost::reference_wrapper<></code>
</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">t</code></span></p></td>
<td><p>The object to wrap </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>
<code class="computeroutput">boost::ref(t)</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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T>
<span class="type">boost::reference_wrapper< T <span class="bold"><strong>const</strong></span> > <span class="bold"><strong>const</strong></span></span> <a name="id1266783-bb"></a><span class="bold"><strong>operator</strong></span>()(T <span class="bold"><strong>const</strong></span> & t) <span class="bold"><strong>const</strong></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="_value/impl.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.transform.arg_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="_byref/result_This_T____id1266633.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
