diff options
Diffstat (limited to 'doc/html/boost/xpressive/value.html')
| -rw-r--r-- | doc/html/boost/xpressive/value.html | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/html/boost/xpressive/value.html b/doc/html/boost/xpressive/value.html index b0b7e407a8..76c725c705 100644 --- a/doc/html/boost/xpressive/value.html +++ b/doc/html/boost/xpressive/value.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_hpp" title="Header <boost/xpressive/xpressive_fwd.hpp>"> -<link rel="prev" href="regex_compiler.html" title="Struct template regex_compiler"> -<link rel="next" href="reference.html" title="Struct template reference"> +<link rel="prev" href="sub_match.html" title="Struct template sub_match"> +<link rel="next" href="../../BOOST_PROTO_FUSION_V2.html" title="Macro BOOST_PROTO_FUSION_V2"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="regex_compiler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_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="reference.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="sub_match.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_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="../../BOOST_PROTO_FUSION_V2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.xpressive.value"></a><div class="titlepage"></div> @@ -37,44 +37,44 @@ <span class="keyword">public</span> <span class="identifier">proto</span><span class="special">::</span><span class="identifier">extends</span><span class="special"><</span> <span class="identifier">proto</span><span class="special">::</span><span class="identifier">terminal</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span><span class="special">,</span> <span class="identifier">value</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <span class="special">{</span> <span class="comment">// <a class="link" href="value.html#boost.xpressive.valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="value.html#id-1_3_47_5_18_2_1_14_6-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_14_7-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="value.html#id-1_3_47_5_18_2_1_17_6-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_17_7-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="value.html#id-1_3_47_5_18_2_1_14_5-bb">public member functions</a></span> - <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_14_5_1-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_14_5_2-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="value.html#id-1_3_47_5_18_2_1_17_5-bb">public member functions</a></span> + <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_17_5_1-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="value.html#id-1_3_47_5_18_2_1_17_5_2-bb"><span class="identifier">get</span></a><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="id-1.3.47.5.19.24.4"></a><h2>Description</h2> +<a name="id-1.3.47.5.19.27.4"></a><h2>Description</h2> <p> Below is an example that shows where <code class="computeroutput"><code class="computeroutput">value<></code></code> is useful.</p> <pre class="programlisting"><span class="identifier">sregex</span> <span class="identifier">good_voodoo</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">pi</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">xpressive</span><span class="special">;</span> <span class="comment">// Use val() to hold the shared_ptr by value:</span> - <a class="link" href="basic_regex.html" title="Struct template basic_regex">sregex</a> <span class="identifier">rex</span> <span class="special">=</span> <span class="special">+</span><span class="special">(</span> <span class="identifier">_d</span> <span class="special">[</span> <span class="special">++</span><span class="special">*</span><span class="identifier">val</span><span class="special">(</span><span class="identifier">pi</span><span class="special">)</span> <span class="special">]</span> <span class="special">>></span> <span class="char">'!'</span> <span class="special">)</span><span class="special">;</span> + <span class="identifier">sregex</span> <span class="identifier">rex</span> <span class="special">=</span> <span class="special">+</span><span class="special">(</span> <span class="identifier">_d</span> <span class="special">[</span> <span class="special">++</span><span class="special">*</span><span class="identifier">val</span><span class="special">(</span><span class="identifier">pi</span><span class="special">)</span> <span class="special">]</span> <span class="special">>></span> <span class="char">'!'</span> <span class="special">)</span><span class="special">;</span> <span class="comment">// OK, rex holds a reference count to the integer.</span> <span class="keyword">return</span> <span class="identifier">rex</span><span class="special">;</span> <span class="special">}</span> </pre> -<p> In the above code, <code class="computeroutput">xpressive::val()</code> is a function that returns a <code class="computeroutput">value<></code> object. Had <code class="computeroutput">val()</code> not been used here, the operation <code class="computeroutput">++*pi</code> would have been evaluated eagerly once, instead of lazily when the regex match happens. </p> +<p>In the above code, <code class="computeroutput">xpressive::val()</code> is a function that returns a <code class="computeroutput">value<></code> object. Had <code class="computeroutput">val()</code> not been used here, the operation <code class="computeroutput">++*pi</code> would have been evaluated eagerly once, instead of lazily when the regex match happens. </p> <div class="refsect2"> -<a name="id-1.3.47.5.19.24.4.3"></a><h3>Template Parameters</h3> +<a name="id-1.3.47.5.19.27.4.3"></a><h3>Template Parameters</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">typename</span> T</pre> <p>The type of the value to store.</p> </li></ol></div> </div> <div class="refsect2"> -<a name="id-1.3.47.5.19.24.4.4"></a><h3> +<a name="id-1.3.47.5.19.27.4.4"></a><h3> <a name="boost.xpressive.valueconstruct-copy-destruct"></a><code class="computeroutput">value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id-1_3_47_5_18_2_1_14_6-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Store a default-constructed <code class="computeroutput">T</code>. </li> +<pre class="literallayout"><a name="id-1_3_47_5_18_2_1_17_6-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Store a default-constructed <code class="computeroutput">T</code>. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_47_5_18_2_1_14_7-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre>Store a copy of <code class="computeroutput">t</code>. <p> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_47_5_18_2_1_17_7-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre>Store a copy of <code class="computeroutput">t</code>. <p> </p> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> @@ -99,15 +99,15 @@ Below is an example that shows where <code class="computeroutput"><code class="c </ol></div> </div> <div class="refsect2"> -<a name="id-1.3.47.5.19.24.4.5"></a><h3> -<a name="id-1_3_47_5_18_2_1_14_5-bb"></a><code class="computeroutput">value</code> public member functions</h3> +<a name="id-1.3.47.5.19.27.4.5"></a><h3> +<a name="id-1_3_47_5_18_2_1_17_5-bb"></a><code class="computeroutput">value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">T</span> <span class="special">&</span> <a name="id-1_3_47_5_18_2_1_14_5_1-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">T</span> <span class="special">&</span> <a name="id-1_3_47_5_18_2_1_17_5_1-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</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> <li class="listitem"> -<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_47_5_18_2_1_14_5_2-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Fetch the stored value. </li> +<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_47_5_18_2_1_17_5_2-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Fetch the stored value. </li> </ol></div> </div> </div> @@ -122,7 +122,7 @@ Below is an example that shows where <code class="computeroutput"><code class="c </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="regex_compiler.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_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="reference.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="sub_match.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.xpressive_fwd_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="../../BOOST_PROTO_FUSION_V2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |