diff options
Diffstat (limited to 'doc/html/boost/xpressive/op/at.html')
| -rw-r--r-- | doc/html/boost/xpressive/op/at.html | 94 |
1 files changed, 70 insertions, 24 deletions
diff --git a/doc/html/boost/xpressive/op/at.html b/doc/html/boost/xpressive/op/at.html index 5127aa61e6..4c049f6800 100644 --- a/doc/html/boost/xpressive/op/at.html +++ b/doc/html/boost/xpressive/op/at.html @@ -3,11 +3,11 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Struct at</title> <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.regex_actions_hpp" title="Header <boost/xpressive/regex_actions.hpp>"> -<link rel="prev" href="../regex_id_filter_predicate.html" title="Struct template regex_id_filter_predicate"> -<link rel="next" href="at/result_This_Cont_id1891485.html" title="Struct template result<This(Cont &, Idx)>"> +<link rel="prev" href="../swap_idp355202096.html" title="Function template swap"> +<link rel="next" href="at/result.html" title="Struct template result"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,13 +20,13 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../regex_id_filter_predicate.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_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="at/result_This_Cont_id1891485.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../swap_idp355202096.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_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="at/result.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.xpressive.op.at"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Struct at</span></h2> -<p>boost::xpressive::op::at</p> +<p>boost::xpressive::op::at — <code class="computeroutput">at</code> is a PolymorphicFunctionObject for indexing into a sequence </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="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_hpp" title="Header <boost/xpressive/regex_actions.hpp>">boost/xpressive/regex_actions.hpp</a>> @@ -34,39 +34,85 @@ </span> <span class="keyword">struct</span> <a class="link" href="at.html" title="Struct at">at</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> Sig<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="at/result.html" title="Struct template result">result</a> <span class="special">{</span> + <span class="special">}</span><span class="special">;</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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="keyword">struct</span> <a class="link" href="at/result_This_Cont_id1891485.html" title="Struct template result<This(Cont &, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> + <span class="keyword">struct</span> <a class="link" href="at/result_This_C_idp355294080.html" title="Struct template result<This(Cont &, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> <span class="comment">// types</span> - <span class="keyword">typedef</span> <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> <a class="link" href="at/result_This_Cont_id1891485.html#boost.xpressive.op.at.result_This(Cont_id1891485.type"><span class="identifier">type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> <a class="link" href="at/result_This_C_idp355294080.html#boost.xpressive.op.at.result_This(C_idp355294080.type"><span class="identifier">type</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="keyword">struct</span> <a class="link" href="at/result_This_Cont_id1891515.html" title="Struct template result<This(Cont const &, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> + <span class="keyword">struct</span> <a class="link" href="at/result_This_C_idp355298000.html" title="Struct template result<This(Cont const &, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> <span class="comment">// types</span> - <span class="keyword">typedef</span> <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a class="link" href="at/result_This_Cont_id1891515.html#boost.xpressive.op.at.result_This(Cont_id1891515.type"><span class="identifier">type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a class="link" href="at/result_This_C_idp355298000.html#boost.xpressive.op.at.result_This(C_idp355298000.type"><span class="identifier">type</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="keyword">struct</span> <a class="link" href="at/result_This_Cont_id1891546.html" title="Struct template result<This(Cont, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">xpressive</span><span class="special">::</span><span class="identifier">op</span><span class="special">::</span><span class="identifier">at</span><span class="special">::</span><span class="identifier">result</span><span class="special"><</span> <span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> - <span class="special">{</span> + <span class="keyword">struct</span> <a class="link" href="at/result_This_C_idp355301920.html" title="Struct template result<This(Cont, Idx)>">result</a><span class="special"><</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Cont</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a class="link" href="at/result_This_C_idp355301920.html#boost.xpressive.op.at.result_This(C_idp355301920.type"><span class="identifier">type</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span> - <span class="comment">// <a class="link" href="at.html#id1891577-bb">public member functions</a></span> + <span class="comment">// <a class="link" href="at.html#idp355305840-bb">public member functions</a></span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> <a class="link" href="at.html#id1891580-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span> <span class="identifier">idx</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> <a class="link" href="at.html#idp355306400-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a class="link" href="at.html#id1891611-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a class="link" href="at.html#idp355312992-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Idx</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="id3870523"></a><h2>Description</h2> +<a name="idp531378672"></a><h2>Description</h2> <div class="refsect2"> -<a name="id3870527"></a><h3> -<a name="id1891577-bb"></a><code class="computeroutput">at</code> public member functions</h3> +<a name="idp531379088"></a><h3> +<a name="idp355305840-bb"></a><code class="computeroutput">at</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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> - <a name="id1891580-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">Idx</span> <span class="identifier">idx</span> BOOST_PROTO_DISABLE_IF_IS_CONST<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> - <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a name="id1891611-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">Idx</span> idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> + <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">reference</span> <a name="idp355306400-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Cont</span> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">Idx</span> idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p> + + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">c</code></span></p></td> +<td><p>The RandomAccessSequence to index into </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">idx</code></span></p></td> +<td><p>The index </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td><p><code class="computeroutput">Cont</code> is a model of RandomAccessSequence </p></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p><code class="computeroutput">c[idx]</code> </p></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> Cont<span class="special">,</span> <span class="keyword">typename</span> Idx<span class="special">></span> + <span class="identifier">Cont</span><span class="special">::</span><span class="identifier">const_reference</span> <a name="idp355312992-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Cont</span> <span class="keyword">const</span> <span class="special">&</span> c<span class="special">,</span> <span class="identifier">Idx</span> idx<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> @@ -81,7 +127,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../regex_id_filter_predicate.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_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="at/result_This_Cont_id1891485.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../swap_idp355202096.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_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="at/result.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |