diff options
Diffstat (limited to 'doc/html/boost/intrusive/any_base_hook.html')
| -rw-r--r-- | doc/html/boost/intrusive/any_base_hook.html | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/html/boost/intrusive/any_base_hook.html b/doc/html/boost/intrusive/any_base_hook.html index 358f4454fa..6aeed8bd3e 100644 --- a/doc/html/boost/intrusive/any_base_hook.html +++ b/doc/html/boost/intrusive/any_base_hook.html @@ -36,56 +36,56 @@ <span class="keyword">class</span> <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">make_any_base_hook</span><span class="special">::</span><span class="identifier">type</span><span class="special"><</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">></span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="any_base_hook.html#boost.intrusive.any_base_hookconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="any_base_hook.html#idp25327840-bb"><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="any_base_hook.html#idp25331104-bb"><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span> <a class="link" href="any_base_hook.html#idp25336880-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_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="any_base_hook.html#idp25342176-bb"><span class="special">~</span><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="any_base_hook.html#idp12117008-bb"><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="any_base_hook.html#idp12120272-bb"><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span> <a class="link" href="any_base_hook.html#idp12126048-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_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="any_base_hook.html#idp12131344-bb"><span class="special">~</span><span class="identifier">any_base_hook</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="any_base_hook.html#idp49499520-bb">public member functions</a></span> - <span class="keyword">bool</span> <a class="link" href="any_base_hook.html#idp49500080-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_base_hook.html#idp36231696-bb">public member functions</a></span> + <span class="keyword">bool</span> <a class="link" href="any_base_hook.html#idp36232256-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="idp280848640"></a><h2>Description</h2> +<a name="idp299701328"></a><h2>Description</h2> <p>Derive a class from this hook in order to store objects of that class in an intrusive container.</p> <p>The hook admits the following options: <code class="computeroutput">tag<></code>, <code class="computeroutput">void_pointer<></code> and <code class="computeroutput">link_mode<></code>.</p> <p><code class="computeroutput">tag<></code> defines a tag to identify the node. The same tag value can be used in different classes, but if a class is derived from more than one <code class="computeroutput"><a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a></code>, then each <code class="computeroutput"><a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a></code> needs its unique tag.</p> <p><code class="computeroutput">link_mode<></code> will specify the linking mode of the hook (<code class="computeroutput">normal_link</code>, <code class="computeroutput">safe_link</code>).</p> <p><code class="computeroutput">void_pointer<></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="idp280858592"></a><h3> +<a name="idp299711280"></a><h3> <a name="boost.intrusive.any_base_hookconstruct-copy-destruct"></a><code class="computeroutput">any_base_hook</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp25327840-bb"></a><span class="identifier">any_base_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp12117008-bb"></a><span class="identifier">any_base_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="idp25331104-bb"></a><span class="identifier">any_base_hook</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp12120272-bb"></a><span class="identifier">any_base_hook</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <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. 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_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span> <a name="idp25336880-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_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="any_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</span> <a name="idp12126048-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_base_hook.html" title="Class template any_base_hook">any_base_hook</a> <span class="special">&</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="idp25342176-bb"></a><span class="special">~</span><span class="identifier">any_base_hook</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp12131344-bb"></a><span class="special">~</span><span class="identifier">any_base_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="idp280900448"></a><h3> -<a name="idp49499520-bb"></a><code class="computeroutput">any_base_hook</code> public member functions</h3> +<a name="idp299753184"></a><h3> +<a name="idp36231696-bb"></a><code class="computeroutput">any_base_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="idp49500080-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="idp36232256-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> |