doc/html/boost/proto/lit_idp701561072.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function lit</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../proto/reference.html#header.boost.proto.literal_hpp" title="Header &lt;boost/proto/literal.hpp&gt;">
  10 <link rel="prev" href="literal.html" title="Struct template literal">
  11 <link rel="next" href="functional/make_expr.html" title="Struct template make_expr">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="literal.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.literal_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="functional/make_expr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.proto.lit_idp701561072"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function lit</span></h2>
  30 <p>boost::proto::lit &#8212; A helper function for creating a <code class="computeroutput">
  31           <a class="link" href="literal.html" title="Struct template literal">proto::literal&lt;&gt;</a></code> wrapper.
  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.literal_hpp" title="Header &lt;boost/proto/literal.hpp&gt;">boost/proto/literal.hpp</a>&gt;
  36
  37 </span>
  38 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="literal.html" title="Struct template literal">proto::literal</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&amp;</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">lit</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&amp;</span> t<span class="special">)</span><span class="special">;</span>
  39 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="literal.html" title="Struct template literal">proto::literal</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">lit</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> t<span class="special">)</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp467514560"></a><h2>Description</h2>
  42 <div class="variablelist"><table border="0" class="variablelist compact">
  43 <colgroup>
  44 <col align="left" valign="top">
  45 <col>
  46 </colgroup>
  47 <tbody>
  48 <tr>
  49 <td><p><span class="term">Parameters:</span></p></td>
  50 <td><div class="variablelist"><table border="0" class="variablelist compact">
  51 <colgroup>
  52 <col align="left" valign="top">
  53 <col>
  54 </colgroup>
  55 <tbody><tr>
  56 <td><p><span class="term"><code class="computeroutput">t</code></span></p></td>
  57 <td><p>The object to wrap.</p></td>
  58 </tr></tbody>
  59 </table></div></td>
  60 </tr>
  61 <tr>
  62 <td><p><span class="term">Returns:</span></p></td>
  63 <td><p>
  64             <code class="computeroutput"><a class="link" href="literal.html" title="Struct template literal">proto::literal</a>&lt;T &amp;&gt;(t)</code>
  65           </p></td>
  66 </tr>
  67 <tr>
  68 <td><p><span class="term">Throws:</span></p></td>
  69 <td>Will not throw.</td>
  70 </tr>
  71 <tr>
  72 <td><p><span class="term">Notes:</span></p></td>
  73 <td><p>The returned value holds the argument by reference. </p></td>
  74 </tr>
  75 </tbody>
  76 </table></div>
  77 </div>
  78 </div>
  79 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  80 <td align="left"></td>
  81 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Eric Niebler<p>
  82         Distributed under the Boost Software License, Version 1.0. (See accompanying
  83         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>)
  84       </p>
  85 </div></td>
  86 </tr></table>
  87 <hr>
  88 <div class="spirit-nav">
  89 <a accesskey="p" href="literal.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../proto/reference.html#header.boost.proto.literal_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="functional/make_expr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  90 </div>
  91 </body>
  92 </html>