summaryrefslogtreecommitdiff
path: root/doc/html/boost/intrusive/any_member_hook.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/intrusive/any_member_hook.html')
-rw-r--r--doc/html/boost/intrusive/any_member_hook.html30
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/html/boost/intrusive/any_member_hook.html b/doc/html/boost/intrusive/any_member_hook.html
index 0b91eff2a9..25137355b9 100644
--- a/doc/html/boost/intrusive/any_member_hook.html
+++ b/doc/html/boost/intrusive/any_member_hook.html
@@ -36,55 +36,55 @@
<span class="keyword">class</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">make_any_member_hook</span><span class="special">::</span><span class="identifier">type</span><span class="special">&lt;</span> <span class="identifier">O1</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">O3</span> <span class="special">&gt;</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="any_member_hook.html#boost.intrusive.any_member_hookconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="any_member_hook.html#idp58922096-bb"><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="any_member_hook.html#idp58925424-bb"><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span> <a class="link" href="any_member_hook.html#idp58931344-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
- <a class="link" href="any_member_hook.html#idp58936640-bb"><span class="special">~</span><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="any_member_hook.html#idp45654320-bb"><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="any_member_hook.html#idp45657648-bb"><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span> <a class="link" href="any_member_hook.html#idp45663568-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="any_member_hook.html#idp45668864-bb"><span class="special">~</span><span class="identifier">any_member_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="any_member_hook.html#idp25356608-bb">public member functions</a></span>
- <span class="keyword">bool</span> <a class="link" href="any_member_hook.html#idp25357168-bb"><span class="identifier">is_linked</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="any_member_hook.html#idp12145776-bb">public member functions</a></span>
+ <span class="keyword">bool</span> <a class="link" href="any_member_hook.html#idp12146336-bb"><span class="identifier">is_linked</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="idp280973872"></a><h2>Description</h2>
+<a name="idp299826528"></a><h2>Description</h2>
<p>Store this hook in a class to be inserted in an intrusive container.</p>
<p>The hook admits the following options: <code class="computeroutput">void_pointer&lt;&gt;</code> and <code class="computeroutput">link_mode&lt;&gt;</code>.</p>
<p><code class="computeroutput">link_mode&lt;&gt;</code> will specify the linking mode of the hook (<code class="computeroutput">normal_link</code> or <code class="computeroutput">safe_link</code>).</p>
<p><code class="computeroutput">void_pointer&lt;&gt;</code> is the pointer type that will be used internally in the hook and the container configured to use this hook. </p>
<div class="refsect2">
-<a name="idp280979600"></a><h3>
+<a name="idp299832256"></a><h3>
<a name="boost.intrusive.any_member_hookconstruct-copy-destruct"></a><code class="computeroutput">any_member_hook</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><a name="idp58922096-bb"></a><span class="identifier">any_member_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45654320-bb"></a><span class="identifier">any_member_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput"><a class="link" href="link_mode.html" title="Struct template link_mode">link_mode</a></code> is or <code class="computeroutput">safe_link</code> initializes the node to an unlinked state.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idp58925424-bb"></a><span class="identifier">any_member_hook</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45657648-bb"></a><span class="identifier">any_member_hook</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput"><a class="link" href="link_mode.html" title="Struct template link_mode">link_mode</a></code> is or <code class="computeroutput">safe_link</code> initializes the node to an unlinked state. The argument is ignored.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing.</p>
<p><span class="bold"><strong>Rationale</strong></span>: Providing a copy-constructor makes classes using the hook STL-compliant without forcing the user to do some additional work. <code class="computeroutput">swap</code> can be used to emulate move-semantics. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span> <a name="idp58931344-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span> <a name="idp45663568-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_member_hook.html" title="Class template any_member_hook">any_member_hook</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Empty function. The argument is ignored.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing.</p>
<p><span class="bold"><strong>Rationale</strong></span>: Providing an assignment operator makes classes using the hook STL-compliant without forcing the user to do some additional work. <code class="computeroutput">swap</code> can be used to emulate move-semantics. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><a name="idp58936640-bb"></a><span class="special">~</span><span class="identifier">any_member_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45668864-bb"></a><span class="special">~</span><span class="identifier">any_member_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput"><a class="link" href="link_mode.html" title="Struct template link_mode">link_mode</a></code> is <code class="computeroutput">normal_link</code>, the destructor does nothing (ie. no code is generated). If <code class="computeroutput"><a class="link" href="link_mode.html" title="Struct template link_mode">link_mode</a></code> is <code class="computeroutput">safe_link</code> and the object is stored in a container an assertion is raised.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
-<a name="idp281021312"></a><h3>
-<a name="idp25356608-bb"></a><code class="computeroutput">any_member_hook</code> public member functions</h3>
+<a name="idp299874160"></a><h3>
+<a name="idp12145776-bb"></a><code class="computeroutput">any_member_hook</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idp25357168-bb"></a><span class="identifier">is_linked</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idp12146336-bb"></a><span class="identifier">is_linked</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><a class="link" href="link_mode.html" title="Struct template link_mode">link_mode</a></code> must be <code class="computeroutput">safe_link</code>.</p>
<p><span class="bold"><strong>Returns</strong></span>: true, if the node belongs to a container, false otherwise. This function can be used to test whether <code class="computeroutput">container::iterator_to</code> will return a valid iterator.</p>
<p><span class="bold"><strong>Complexity</strong></span>: Constant </p>