doc/html/boost/intrusive/pointer__idm45581297693024.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>Struct template pointer_traits&lt;T *&gt;</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="../../intrusive/reference.html#header.boost.intrusive.pointer_traits_hpp" title="Header &lt;boost/intrusive/pointer_traits.hpp&gt;">
  10 <link rel="prev" href="pointer_traits.html" title="Struct template pointer_traits">
  11 <link rel="next" href="pointer__idm45581297693024/rebind_pointer.html" title="Struct template rebind_pointer">
  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="pointer_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.pointer_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="pointer__idm45581297693024/rebind_pointer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.intrusive.pointer__idm45581297693024"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template pointer_traits&lt;T *&gt;</span></h2>
  30 <p>boost::intrusive::pointer_traits&lt;T *&gt;</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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="../../intrusive/reference.html#header.boost.intrusive.pointer_traits_hpp" title="Header &lt;boost/intrusive/pointer_traits.hpp&gt;">boost/intrusive/pointer_traits.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="pointer__idm45581297693024.html" title="Struct template pointer_traits&lt;T *&gt;">pointer_traits</a><span class="special">&lt;</span><span class="identifier">T</span> <span class="special">*</span><span class="special">&gt;</span> <span class="special">{</span>
  37   <span class="comment">// <a class="link" href="pointer__idm45581297693024.html#boost.intrusive.pointer__idm45581297693024types">types</a></span>
  38   <span class="keyword">typedef</span> <span class="identifier">T</span>              <a name="boost.intrusive.pointer__idm45581297693024.element_type"></a><span class="identifier">element_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="special">*</span>            <a name="boost.intrusive.pointer__idm45581297693024.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.intrusive.pointer__idm45581297693024.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="special">&amp;</span>            <a name="boost.intrusive.pointer__idm45581297693024.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">U</span> <span class="special">*</span>            <a class="link" href="pointer__idm45581297693024.html#boost.intrusive.pointer__idm45581297693024.rebind"><span class="identifier">rebind</span></a><span class="special">;</span>
  43
  44   <span class="comment">// member classes/structs/unions</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  46   <span class="keyword">struct</span> <a class="link" href="pointer__idm45581297693024/rebind_pointer.html" title="Struct template rebind_pointer">rebind_pointer</a> <span class="special">{</span>
  47     <span class="comment">// types</span>
  48     <span class="keyword">typedef</span> <span class="identifier">U</span> <span class="special">*</span> <a class="link" href="pointer__idm45581297693024/rebind_pointer.html#boost.intrusive.pointer__idm45581297693024.rebind_pointer.type"><span class="identifier">type</span></a><span class="special">;</span>
  49   <span class="special">}</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="pointer__idm45581297693024.html#idm45581297682368-bb">public static functions</a></span>
  52   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pointer__idm45581297693024.html#idm45581297681808-bb"><span class="identifier">pointer_to</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pointer__idm45581297693024.html#idm45581297679024-bb"><span class="identifier">static_cast_from</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pointer__idm45581297693024.html#idm45581297675376-bb"><span class="identifier">const_cast_from</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pointer__idm45581297693024.html#idm45581297671728-bb"><span class="identifier">dynamic_cast_from</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  56 <span class="special">}</span><span class="special">;</span></pre></div>
  57 <div class="refsect1">
  58 <a name="id-1.3.20.42.26.4.4"></a><h2>Description</h2>
  59 <p>Specialization of <a class="link" href="pointer_traits.html" title="Struct template pointer_traits">pointer_traits</a> for raw pointers </p>
  60 <div class="refsect2">
  61 <a name="id-1.3.20.42.26.4.4.3"></a><h3>
  62 <a name="boost.intrusive.pointer__idm45581297693024types"></a><code class="computeroutput">pointer_traits</code>
  63         public
  64        types</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  66 <p>
  67 <span class="keyword">typedef</span> <span class="identifier">U</span> <span class="special">*</span> <a name="boost.intrusive.pointer__idm45581297693024.rebind"></a><span class="identifier">rebind</span><span class="special">;</span></p>
  68 <pre class="programlisting"><span class="identifier">U</span> <span class="special">*</span></pre>
  69 <p>For portable code for C++03 and C++11, </p>
  70 <pre class="programlisting"><span class="keyword">typename</span> <span class="identifier">rebind_pointer</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span></pre>
  71 <p> shall be used instead of rebind<span style="color: red">&lt;underline&gt; to obtain a pointer to U. &lt;/underline&gt;</span></p>
  72 </li></ol></div>
  73 </div>
  74 <div class="refsect2">
  75 <a name="id-1.3.20.42.26.4.4.4"></a><h3>
  76 <a name="idm45581297682368-bb"></a><code class="computeroutput">pointer_traits</code> public static functions</h3>
  77 <div class="orderedlist"><ol class="orderedlist" type="1">
  78 <li class="listitem">
  79 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45581297681808-bb"></a><span class="identifier">pointer_to</span><span class="special">(</span><span class="identifier">reference</span> r<span class="special">)</span><span class="special">;</span></pre>
  80 <p><span class="bold"><strong>Returns</strong></span>: addressof(r) </p>
  81 </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45581297679024-bb"></a><span class="identifier">static_cast_from</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> uptr<span class="special">)</span><span class="special">;</span></pre>
  84 <p><span class="bold"><strong>Returns</strong></span>: static_cast&lt;pointer&gt;(uptr) </p>
  85 </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45581297675376-bb"></a><span class="identifier">const_cast_from</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> uptr<span class="special">)</span><span class="special">;</span></pre>
  88 <p><span class="bold"><strong>Returns</strong></span>: const_cast&lt;pointer&gt;(uptr) </p>
  89 </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45581297671728-bb"></a><span class="identifier">dynamic_cast_from</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> uptr<span class="special">)</span><span class="special">;</span></pre>
  92 <p><span class="bold"><strong>Returns</strong></span>: dynamic_cast&lt;pointer&gt;(uptr) </p>
  93 </li>
  94 </ol></div>
  95 </div>
  96 </div>
  97 </div>
  98 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  99 <td align="left"></td>
 100 <td align="right"><div class="copyright-footer">Copyright &#169; 2005 Olaf Krzikalla<br>Copyright &#169; 2006-2015 Ion Gaztanaga<p>
 101         Distributed under the Boost Software License, Version 1.0. (See accompanying
 102         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>)
 103       </p>
 104 </div></td>
 105 </tr></table>
 106 <hr>
 107 <div class="spirit-nav">
 108 <a accesskey="p" href="pointer_traits.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.pointer_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="pointer__idm45581297693024/rebind_pointer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 109 </div>
 110 </body>
 111 </html>