libs/type_traits/doc/html/boost_typetraits/reference/add_lvalue_reference.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>add_lvalue_reference</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="Chapter&#160;1.&#160;Boost.TypeTraits">
   8 <link rel="up" href="../reference.html" title="Alphabetical Reference">
   9 <link rel="prev" href="add_cv.html" title="add_cv">
  10 <link rel="next" href="add_pointer.html" title="add_pointer">
  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="add_cv.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><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="add_pointer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_typetraits.reference.add_lvalue_reference"></a><a class="link" href="add_lvalue_reference.html" title="add_lvalue_reference">add_lvalue_reference</a>
  28 </h3></div></div></div>
  29 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  30 <span class="keyword">struct</span> <span class="identifier">add_lvalue_reference</span>
  31 <span class="special">{</span>
  32    <span class="keyword">typedef</span> <em class="replaceable"><code>see-below</code></em> <span class="identifier">type</span><span class="special">;</span>
  33 <span class="special">};</span>
  34 </pre>
  35 <p>
  36         <span class="bold"><strong>type:</strong></span> If <code class="computeroutput"><span class="identifier">T</span></code>
  37         names an object or function type then the member typedef <code class="computeroutput"><span class="identifier">type</span></code>
  38         shall name <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span></code>;
  39         otherwise, if <code class="computeroutput"><span class="identifier">T</span></code> names a type
  40         <span class="emphasis"><em>rvalue reference to U</em></span> then the member typedef type shall
  41         name <code class="computeroutput"><span class="identifier">U</span><span class="special">&amp;</span></code>;
  42         otherwise, type shall name <code class="computeroutput"><span class="identifier">T</span></code>.
  43       </p>
  44 <p>
  45         <span class="bold"><strong>C++ Standard Reference:</strong></span> 20.7.6.2.
  46       </p>
  47 <p>
  48         <span class="bold"><strong>Compiler Compatibility:</strong></span> If the compiler
  49         does not support partial specialization of class-templates then this template
  50         will compile, but the member <code class="computeroutput"><span class="identifier">type</span></code>
  51         will always be the same as type <code class="computeroutput"><span class="identifier">T</span></code>
  52         except where <a class="link" href="../category/transform.html#boost_typetraits.category.transform.broken_compiler_workarounds_">compiler
  53         workarounds</a> have been applied.
  54       </p>
  55 <p>
  56         <span class="bold"><strong>Header:</strong></span> <code class="computeroutput"> <span class="preprocessor">#include</span>
  57         <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">/</span><span class="identifier">add_lvalue_reference</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  58         or <code class="computeroutput"> <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  59       </p>
  60 <div class="table">
  61 <a name="boost_typetraits.reference.add_lvalue_reference.examples"></a><p class="title"><b>Table&#160;1.12.&#160;Examples</b></p>
  62 <div class="table-contents"><table class="table" summary="Examples">
  63 <colgroup>
  64 <col>
  65 <col>
  66 </colgroup>
  67 <thead><tr>
  68 <th>
  69                 <p>
  70                   Expression
  71                 </p>
  72               </th>
  73 <th>
  74                 <p>
  75                   Result Type
  76                 </p>
  77               </th>
  78 </tr></thead>
  79 <tbody>
  80 <tr>
  81 <td>
  82                 <p>
  83                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;::</span><span class="identifier">type</span></code>
  84                 </p>
  85               </td>
  86 <td>
  87                 <p>
  88                   <code class="computeroutput"><span class="keyword">int</span><span class="special">&amp;</span></code>
  89                 </p>
  90               </td>
  91 </tr>
  92 <tr>
  93 <td>
  94                 <p>
  95                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">int</span>
  96                   <span class="keyword">const</span><span class="special">&amp;&gt;::</span><span class="identifier">type</span></code>
  97                 </p>
  98               </td>
  99 <td>
 100                 <p>
 101                   <code class="computeroutput"><span class="keyword">int</span> <span class="keyword">const</span><span class="special">&amp;</span></code>
 102                 </p>
 103               </td>
 104 </tr>
 105 <tr>
 106 <td>
 107                 <p>
 108                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">*&gt;::</span><span class="identifier">type</span></code>
 109                 </p>
 110               </td>
 111 <td>
 112                 <p>
 113                   <code class="computeroutput"><span class="keyword">int</span><span class="special">*&amp;</span></code>
 114                 </p>
 115               </td>
 116 </tr>
 117 <tr>
 118 <td>
 119                 <p>
 120                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">*&amp;&gt;::</span><span class="identifier">type</span></code>
 121                 </p>
 122               </td>
 123 <td>
 124                 <p>
 125                   <code class="computeroutput"><span class="keyword">int</span><span class="special">*&amp;</span></code>
 126                 </p>
 127               </td>
 128 </tr>
 129 <tr>
 130 <td>
 131                 <p>
 132                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&amp;&gt;::</span><span class="identifier">type</span></code>
 133                 </p>
 134               </td>
 135 <td>
 136                 <p>
 137                   <code class="computeroutput"><span class="keyword">int</span><span class="special">&amp;</span></code>
 138                 </p>
 139               </td>
 140 </tr>
 141 <tr>
 142 <td>
 143                 <p>
 144                   <code class="computeroutput"><span class="identifier">add_lvalue_reference</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">&gt;::</span><span class="identifier">type</span></code>
 145                 </p>
 146               </td>
 147 <td>
 148                 <p>
 149                   <code class="computeroutput"><span class="keyword">void</span></code>
 150                 </p>
 151               </td>
 152 </tr>
 153 </tbody>
 154 </table></div>
 155 </div>
 156 <br class="table-break">
 157 </div>
 158 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 159 <td align="left"></td>
 160 <td align="right"><div class="copyright-footer">Copyright &#169; 2000, 2011 Adobe Systems Inc, David Abrahams,
 161       Frederic Bron, Steve Cleary, Beman Dawes, Aleksey Gurtovoy, Howard Hinnant,
 162       Jesse Jones, Mat Marcus, Itay Maman, John Maddock, Alexander Nasonov, Thorsten
 163       Ottosen, Roman Perepelitsa, Robert Ramey, Jeremy Siek, Robert Stewart and Steven
 164       Watanabe<p>
 165         Distributed under the Boost Software License, Version 1.0. (See accompanying
 166         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>)
 167       </p>
 168 </div></td>
 169 </tr></table>
 170 <hr>
 171 <div class="spirit-nav">
 172 <a accesskey="p" href="add_cv.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><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="add_pointer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 173 </div>
 174 </body>
 175 </html>