doc/html/boost/proto/functional/value.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct value</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="../../../proto/reference.html#header.boost.proto.traits_hpp" title="Header &lt;boost/proto/traits.hpp&gt;">
   9 <link rel="prev" href="child/result_This_E_idp203592768.html" title="Struct template result&lt;This(Expr)&gt;">
  10 <link rel="next" href="value/result_This_E_idp203618048.html" title="Struct template result&lt;This(Expr)&gt;">
  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="child/result_This_E_idp203592768.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.traits_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="value/result_This_E_idp203618048.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.proto.functional.value"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct value</span></h2>
  29 <p>boost::proto::functional::value &#8212;
  30             A callable <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> that is equivalent to the
  31             <code class="computeroutput"><a class="link" href="../value_idp227717568.html" title="Function value">proto::value()</a></code> function.
  32           </p>
  33 </div>
  34 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  35 <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="../../../proto/reference.html#header.boost.proto.traits_hpp" title="Header &lt;boost/proto/traits.hpp&gt;">boost/proto/traits.hpp</a>&gt;
  36
  37 </span>
  38 <span class="keyword">struct</span> <a class="link" href="value.html" title="Struct value">value</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="../callable.html" title="Struct callable">proto::callable</a> <span class="special">{</span>
  39   <span class="comment">// member classes/structs/unions</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> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  41   <span class="keyword">struct</span> <a class="link" href="value/result_This_E_idp203618048.html" title="Struct template result&lt;This(Expr)&gt;">result</a><span class="special">&lt;</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Expr</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="../result_of/value.html" title="Struct template value">proto::result_of::value</a>&lt; Expr &gt; <span class="special">{</span>
  42   <span class="special">}</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="value.html#idp203622416-bb">public member functions</a></span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  46     <span class="keyword">typename</span> <a class="link" href="../result_of/value.html" title="Struct template value">proto::result_of::value</a><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="special">&amp;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="value.html#idp203622976-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Expr</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  48     <span class="keyword">typename</span> <a class="link" href="../result_of/value.html" title="Struct template value">proto::result_of::value</a><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  49     <a class="link" href="value.html#idp203634336-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</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="idp381571584"></a><h2>Description</h2>
  53 <div class="refsect2">
  54 <a name="idp381572000"></a><h3>
  55 <a name="idp203622416-bb"></a><code class="computeroutput">value</code> public member functions</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1">
  57 <li class="listitem">
  58 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
  59   <span class="keyword">typename</span> <a class="link" href="../result_of/value.html" title="Struct template value">proto::result_of::value</a><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="special">&amp;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  60   <a name="idp203622976-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Expr</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  61 <p>
  62                   Return the value of the given terminal expression.
  63                 </p>
  64 <div class="variablelist"><table border="0" class="variablelist compact">
  65 <colgroup>
  66 <col align="left" valign="top">
  67 <col>
  68 </colgroup>
  69 <tbody>
  70 <tr>
  71 <td><p><span class="term">Parameters:</span></p></td>
  72 <td><div class="variablelist"><table border="0" class="variablelist compact">
  73 <colgroup>
  74 <col align="left" valign="top">
  75 <col>
  76 </colgroup>
  77 <tbody><tr>
  78 <td><p><span class="term"><code class="computeroutput">expr</code></span></p></td>
  79 <td><p>The terminal expression node. </p></td>
  80 </tr></tbody>
  81 </table></div></td>
  82 </tr>
  83 <tr>
  84 <td><p><span class="term">Requires:</span></p></td>
  85 <td>
  86 <p>
  87                   <code class="computeroutput"><a class="link" href="../is_expr.html" title="Struct template is_expr">proto::is_expr</a>&lt;Expr&gt;::value</code> is
  88                   <code class="computeroutput">true</code>
  89                 </p>
  90 <p>
  91                   <code class="computeroutput">0 == Expr::proto_arity::value</code>
  92                 </p>
  93 </td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term">Returns:</span></p></td>
  97 <td><p>
  98                   <code class="computeroutput"><a class="link" href="../value_idp227717568.html" title="Function value">proto::value</a>(expr)</code>
  99                 </p></td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term">Throws:</span></p></td>
 103 <td>Will not throw.</td>
 104 </tr>
 105 </tbody>
 106 </table></div>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../../Expr.html" title="Concept Expr">Expr</a><span class="special">&gt;</span>
 110   <span class="keyword">typename</span> <a class="link" href="../result_of/value.html" title="Struct template value">proto::result_of::value</a><span class="special">&lt;</span> <span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
 111   <a name="idp203634336-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Expr</span> <span class="keyword">const</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 112 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 113 </li>
 114 </ol></div>
 115 </div>
 116 </div>
 117 </div>
 118 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 119 <td align="left"></td>
 120 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
 121         Distributed under the Boost Software License, Version 1.0. (See accompanying
 122         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>)
 123       </p>
 124 </div></td>
 125 </tr></table>
 126 <hr>
 127 <div class="spirit-nav">
 128 <a accesskey="p" href="child/result_This_E_idp203592768.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.traits_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="value/result_This_E_idp203618048.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 129 </div>
 130 </body>
 131 </html>