doc/html/boost/xpressive/op/top.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct top</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_hpp" title="Header &lt;boost/xpressive/regex_actions.hpp&gt;">
   9 <link rel="prev" href="back/result_This_S_idp355384384.html" title="Struct template result&lt;This(Sequence)&gt;">
  10 <link rel="next" href="top/result.html" title="Struct template result">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="back/result_This_S_idp355384384.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="top/result.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.xpressive.op.top"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct top</span></h2>
  29 <p>boost::xpressive::op::top &#8212; <code class="computeroutput">top</code> is a PolymorphicFunctionObject for fetching the top element of a stack. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../xpressive/reference.html#header.boost.xpressive.regex_actions_hpp" title="Header &lt;boost/xpressive/regex_actions.hpp&gt;">boost/xpressive/regex_actions.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">struct</span> <a class="link" href="top.html" title="Struct top">top</a> <span class="special">{</span>
  36   <span class="comment">// member classes/structs/unions</span>
  37   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sig<span class="special">&gt;</span>
  38   <span class="keyword">struct</span> <a class="link" href="top/result.html" title="Struct template result">result</a> <span class="special">{</span>
  39   <span class="special">}</span><span class="special">;</span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> This<span class="special">,</span> <span class="keyword">typename</span> Sequence<span class="special">&gt;</span>
  41   <span class="keyword">struct</span> <a class="link" href="top/result_This_S_idp355396816.html" title="Struct template result&lt;This(Sequence)&gt;">result</a><span class="special">&lt;</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">{</span>
  42     <span class="comment">// types</span>
  43     <span class="keyword">typedef</span> <span class="identifier">remove_reference</span><span class="special">&lt;</span> <span class="identifier">Sequence</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                                                                                    <a class="link" href="top/result_This_S_idp355396816.html#boost.xpressive.op.top.result_This(S_idp355396816.sequence_type"><span class="identifier">sequence_type</span></a><span class="special">;</span>
  44     <span class="keyword">typedef</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">if_c</span><span class="special">&lt;</span> <span class="identifier">is_const</span><span class="special">&lt;</span> <span class="identifier">sequence_type</span> <span class="special">&gt;</span><span class="special">::</span><a class="link" href="../value.html" title="Struct template value">value</a><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">sequence_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">sequence_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">&amp;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="top/result_This_S_idp355396816.html#boost.xpressive.op.top.result_This(S_idp355396816.type"><span class="identifier">type</span></a><span class="special">;</span>
  45   <span class="special">}</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="top.html#idp355401296-bb">public member functions</a></span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sequence<span class="special">&gt;</span>
  49     <a class="link" href="top/result.html" title="Struct template result">result</a><span class="special">&lt;</span> <a class="link" href="top.html" title="Struct top">top</a><span class="special">(</span><span class="identifier">Sequence</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="top.html#idp355401856-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Sequence</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50 <span class="special">}</span><span class="special">;</span></pre></div>
  51 <div class="refsect1">
  52 <a name="idp532106768"></a><h2>Description</h2>
  53 <div class="refsect2">
  54 <a name="idp532107184"></a><h3>
  55 <a name="idp355401296-bb"></a><code class="computeroutput">top</code> public member functions</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  57 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sequence<span class="special">&gt;</span>
  58   <a class="link" href="top/result.html" title="Struct template result">result</a><span class="special">&lt;</span> <a class="link" href="top.html" title="Struct top">top</a><span class="special">(</span><span class="identifier">Sequence</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="idp355401856-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="special">&amp;</span> seq<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  59 <p>
  60
  61 </p>
  62 <div class="variablelist"><table border="0" class="variablelist compact">
  63 <colgroup>
  64 <col align="left" valign="top">
  65 <col>
  66 </colgroup>
  67 <tbody>
  68 <tr>
  69 <td><p><span class="term">Parameters:</span></p></td>
  70 <td><div class="variablelist"><table border="0" class="variablelist compact">
  71 <colgroup>
  72 <col align="left" valign="top">
  73 <col>
  74 </colgroup>
  75 <tbody><tr>
  76 <td><p><span class="term"><code class="computeroutput">seq</code></span></p></td>
  77 <td><p>The sequence from which to fetch the top. </p></td>
  78 </tr></tbody>
  79 </table></div></td>
  80 </tr>
  81 <tr>
  82 <td><p><span class="term">Returns:</span></p></td>
  83 <td><p><code class="computeroutput">seq.top()</code> </p></td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </li></ol></div>
  88 </div>
  89 </div>
  90 </div>
  91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92 <td align="left"></td>
  93 <td align="right"><div class="copyright-footer">Copyright &#169; 2007 Eric Niebler<p>
  94         Distributed under the Boost Software License, Version 1.0. (See accompanying
  95         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>)
  96       </p>
  97 </div></td>
  98 </tr></table>
  99 <hr>
 100 <div class="spirit-nav">
 101 <a accesskey="p" href="back/result_This_S_idp355384384.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="top/result.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 102 </div>
 103 </body>
 104 </html>