diff options
Diffstat (limited to 'doc/html/boost/interprocess/offset_ptr.html')
| -rwxr-xr-x | doc/html/boost/interprocess/offset_ptr.html | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/doc/html/boost/interprocess/offset_ptr.html b/doc/html/boost/interprocess/offset_ptr.html new file mode 100755 index 0000000000..86b9229cb6 --- /dev/null +++ b/doc/html/boost/interprocess/offset_ptr.html @@ -0,0 +1,264 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template offset_ptr</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.offset_ptr_hpp" title="Header <boost/interprocess/offset_ptr.hpp>"> +<link rel="prev" href="simple_seq_fit.html" title="Class template simple_seq_fit"> +<link rel="next" href="offset_ptr/rebind.html" title="Struct template rebind"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.offset_ptr_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="offset_ptr/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.interprocess.offset_ptr"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template offset_ptr</span></h2> +<p>boost::interprocess::offset_ptr</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.offset_ptr_hpp" title="Header <boost/interprocess/offset_ptr.hpp>">boost/interprocess/offset_ptr.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> PointedType<span class="special">,</span> <span class="keyword">typename</span> DifferenceType<span class="special">,</span> <span class="keyword">typename</span> OffsetType<span class="special">,</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> OffsetAlignment<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">PointedType</span> <a name="boost.interprocess.offset_ptr.element_type"></a><span class="identifier">element_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">PointedType</span> <span class="special">*</span> <a name="boost.interprocess.offset_ptr.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.interprocess.offset_ptr.reference"></a><span class="identifier">reference</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.interprocess.offset_ptr.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">DifferenceType</span> <a name="boost.interprocess.offset_ptr.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">random_access_iterator_tag</span> <a name="boost.interprocess.offset_ptr.iterator_category"></a><span class="identifier">iterator_category</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">OffsetType</span> <a name="boost.interprocess.offset_ptr.offset_type"></a><span class="identifier">offset_type</span><span class="special">;</span> + + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="offset_ptr/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <a class="link" href="offset_ptr/rebind.html#boost.interprocess.offset_ptr.rebind.other"><span class="identifier">other</span></a><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="offset_ptr.html#boost.interprocess.offset_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="offset_ptr.html#id988545-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">pointer</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="offset_ptr.html#id988559-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#id988585-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a class="link" href="offset_ptr.html#id988606-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a class="link" href="offset_ptr.html#id988660-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a class="link" href="offset_ptr.html#id988704-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a class="link" href="offset_ptr.html#id988748-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a class="link" href="offset_ptr.html#id988793-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> + offset_ptr& <a class="link" href="offset_ptr.html#id988837-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span><span class="special">;</span> + offset_ptr& <a class="link" href="offset_ptr.html#id988848-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + offset_ptr& <a class="link" href="offset_ptr.html#id988869-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="offset_ptr.html#id988312-bb">public member functions</a></span> + <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#id988315-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">offset_type</span> <a class="link" href="offset_ptr.html#id988327-bb"><span class="identifier">get_offset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#id988334-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#id988347-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#id988365-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#id988389-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#id988414-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#id988445-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id988465-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#id988483-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id988502-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#id988521-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="offset_ptr.html#id988533-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="offset_ptr.html#id988914-bb">public static functions</a></span> + <span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id988917-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> + + <span class="comment">// <a class="link" href="offset_ptr.html#id988937-bb">friend functions</a></span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id988940-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id988975-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id989009-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#id989042-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="identifier">difference_type</span> <a class="link" href="offset_ptr.html#id989076-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id1804223"></a><h2>Description</h2> +<p>A smart pointer that stores the offset between between the pointer and the the object it points. This allows offset allows special properties, since the pointer is independent from the address address of the pointee, if the pointer and the pointee are still separated by the same offset. This feature converts <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> in a smart pointer that can be placed in shared memory and memory mapped files mapped in different addresses in every process. </p> +<div class="refsect2"> +<a name="id1804244"></a><h3> +<a name="boost.interprocess.offset_ptrconstruct-copy-destruct"></a><code class="computeroutput">offset_ptr</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id988545-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">pointer</span> ptr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Constructor from raw pointer (allows "0" pointer conversion). Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="id988559-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Constructor from other pointer. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id988585-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<p>Constructor from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a name="id988606-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<p>Constructor from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. If pointers of pointee types are convertible, offset_ptrs will be convertibles. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a name="id988660-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> +<p>Emulates static_cast operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a name="id988704-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> +<p>Emulates const_cast operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a name="id988748-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> +<p>Emulates dynamic_cast operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + <a name="id988793-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> +<p>Emulates reinterpret_cast operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout">offset_ptr& <a name="id988837-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> from<span class="special">)</span><span class="special">;</span></pre> +<p>Assignment from pointer (saves extra conversion). Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout">offset_ptr& <a name="id988848-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt<span class="special">)</span><span class="special">;</span></pre> +<p>Assignment from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> + offset_ptr& <a name="id988869-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<p>Assignment from related <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. If pointers of pointee types are assignable, offset_ptrs will be assignable. Never throws. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1805601"></a><h3> +<a name="id988312-bb"></a><code class="computeroutput">offset_ptr</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id988315-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Obtains raw pointer from offset. Never throws. </p> +</li> +<li class="listitem"><pre class="literallayout"><span class="identifier">offset_type</span> <a name="id988327-bb"></a><span class="identifier">get_offset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id988334-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Pointer-like -> operator. It can return 0 pointer. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">reference</span> <a name="id988347-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Dereferencing operator, if it is a null <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> behavior is undefined. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">reference</span> <a name="id988365-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">T</span> idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Indexing operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="id988389-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="identifier">difference_type</span> offset<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> += difference_type. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="id988414-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="identifier">T</span> offset<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> -= difference_type. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="id988445-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre> +<p>++offset_ptr. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id988465-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> +<p>offset_ptr++. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="id988483-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre> +<p>--offset_ptr. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id988502-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> +<p>offset_ptr--. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id988521-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>safe bool conversion operator. Never throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id988533-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Not operator. Not needed in theory, but improves portability. Never throws </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1806328"></a><h3> +<a name="id988914-bb"></a><code class="computeroutput">offset_ptr</code> public static functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id988917-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> +<p>Compatibility with pointer_traits </p> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id1806397"></a><h3> +<a name="id988937-bb"></a><code class="computeroutput">offset_ptr</code> friend functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id988940-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> right<span class="special">)</span><span class="special">;</span></pre> +<p>difference_type + <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> operation </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id988975-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> + difference_type operation </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id989009-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - diff operation </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="id989042-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> right<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - diff operation </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">difference_type</span> +<a name="id989076-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt2<span class="special">)</span><span class="special">;</span></pre> +<p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> operation </p> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2005-2011 Ion Gaztanaga<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.offset_ptr_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="offset_ptr/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |