summaryrefslogtreecommitdiff
path: root/doc/html/boost/intrusive/group_functions.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/intrusive/group_functions.html')
-rw-r--r--doc/html/boost/intrusive/group_functions.html108
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/html/boost/intrusive/group_functions.html b/doc/html/boost/intrusive/group_functions.html
new file mode 100644
index 0000000000..2e4b0bb213
--- /dev/null
+++ b/doc/html/boost/intrusive/group_functions.html
@@ -0,0 +1,108 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Struct template group_functions</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
+<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
+<link rel="up" href="../../intrusive/reference.html#header.boost.intrusive.hashtable_hpp" title="Header &lt;boost/intrusive/hashtable.hpp&gt;">
+<link rel="prev" href="get_hashtable_siz_idm30721.html" title="Struct template get_hashtable_size_wrapper_internal">
+<link rel="next" href="hash_bool_flags.html" title="Struct hash_bool_flags">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+</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="get_hashtable_siz_idm30721.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.hashtable_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="hash_bool_flags.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="boost.intrusive.group_functions"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Struct template group_functions</span></h2>
+<p>boost::intrusive::group_functions</p>
+</div>
+<h2 class="refsynopsisdiv-title">Synopsis</h2>
+<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../intrusive/reference.html#header.boost.intrusive.hashtable_hpp" title="Header &lt;boost/intrusive/hashtable.hpp&gt;">boost/intrusive/hashtable.hpp</a>&gt;
+
+</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> NodeTraits<span class="special">&gt;</span>
+<span class="keyword">struct</span> <a class="link" href="group_functions.html" title="Struct template group_functions">group_functions</a> <span class="special">{</span>
+ <span class="comment">// types</span>
+ <span class="keyword">typedef</span> <span class="identifier">NodeTraits</span> <a name="boost.intrusive.group_functions.node_traits"></a><span class="identifier">node_traits</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">unordered_group_adapter</span><span class="special">&lt;</span> <span class="identifier">node_traits</span> <span class="special">&gt;</span> <a name="boost.intrusive.group_functions.group_traits"></a><span class="identifier">group_traits</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">node_traits</span><span class="special">::</span><span class="identifier">node_ptr</span> <a name="boost.intrusive.group_functions.node_ptr"></a><span class="identifier">node_ptr</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">node_traits</span><span class="special">::</span><span class="identifier">node</span> <a name="boost.intrusive.group_functions.node"></a><span class="identifier">node</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">reduced_slist_node_traits</span><span class="special">&lt;</span> <span class="identifier">node_traits</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.intrusive.group_functions.reduced_node_traits"></a><span class="identifier">reduced_node_traits</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">reduced_node_traits</span><span class="special">::</span><span class="identifier">node_ptr</span> <a name="boost.intrusive.group_functions.slist_node_ptr"></a><span class="identifier">slist_node_ptr</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">reduced_node_traits</span><span class="special">::</span><span class="identifier">node</span> <a name="boost.intrusive.group_functions.slist_node"></a><span class="identifier">slist_node</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <a class="link" href="circular_slist_algorithms.html" title="Class template circular_slist_algorithms">circular_slist_algorithms</a><span class="special">&lt;</span> <span class="identifier">group_traits</span> <span class="special">&gt;</span> <a name="boost.intrusive.group_functions.group_algorithms"></a><span class="identifier">group_algorithms</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <a class="link" href="circular_slist_algorithms.html" title="Class template circular_slist_algorithms">circular_slist_algorithms</a><span class="special">&lt;</span> <span class="identifier">node_traits</span> <span class="special">&gt;</span> <a name="boost.intrusive.group_functions.node_algorithms"></a><span class="identifier">node_algorithms</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="group_functions.html#idm30756-bb">public static functions</a></span>
+ <span class="keyword">static</span> <span class="identifier">slist_node_ptr</span>
+ <a class="link" href="group_functions.html#idm30757-bb"><span class="identifier">get_bucket_before_begin</span></a><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">slist_node_ptr</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">static</span> <span class="identifier">slist_node_ptr</span>
+ <a class="link" href="group_functions.html#idm30768-bb"><span class="identifier">get_bucket_before_begin</span></a><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">slist_node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="group_functions.html#idm30779-bb"><span class="identifier">get_prev_to_first_in_group</span></a><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="group_functions.html#idm30785-bb"><span class="identifier">erase_from_group</span></a><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</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">static</span> <span class="keyword">void</span> <a class="link" href="group_functions.html#idm30794-bb"><span class="identifier">erase_from_group</span></a><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="../interprocess/interprocess_mutex.html#idm30803-bb"><span class="identifier">get_last_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="group_functions.html#idm30810-bb"><span class="identifier">get_last_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="group_functions.html#idm30817-bb"><span class="identifier">get_first_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="group_functions.html#idm30824-bb"><span class="identifier">get_first_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</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">static</span> <span class="keyword">bool</span> <a class="link" href="group_functions.html#idm30831-bb"><span class="identifier">is_first_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="group_functions.html#idm30835-bb"><span class="identifier">insert_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</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">static</span> <span class="keyword">void</span> <a class="link" href="group_functions.html#idm30844-bb"><span class="identifier">insert_in_group</span></a><span class="special">(</span><span class="identifier">node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</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">static</span> <span class="identifier">node_ptr</span> <a class="link" href="../interprocess/interprocess_recu_idm30848.html#idm30853-bb"><span class="identifier">split_group</span></a><span class="special">(</span><span class="identifier">node_ptr</span> <span class="keyword">const</span><span class="special">)</span><span class="special">;</span>
+<span class="special">}</span><span class="special">;</span></pre></div>
+<div class="refsect1">
+<a name="id-1.3.18.42.14.19.4"></a><h2>Description</h2>
+<div class="refsect2">
+<a name="id-1.3.18.42.14.19.4.2"></a><h3>
+<a name="idm30756-bb"></a><code class="computeroutput">group_functions</code> public static functions</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">slist_node_ptr</span>
+<a name="idm30757-bb"></a><span class="identifier">get_bucket_before_begin</span><span class="special">(</span><span class="identifier">slist_node_ptr</span> bucket_beg<span class="special">,</span> <span class="identifier">slist_node_ptr</span> bucket_last<span class="special">,</span>
+ <span class="identifier">slist_node_ptr</span> sp<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">slist_node_ptr</span>
+<a name="idm30768-bb"></a><span class="identifier">get_bucket_before_begin</span><span class="special">(</span><span class="identifier">slist_node_ptr</span> bucket_beg<span class="special">,</span> <span class="identifier">slist_node_ptr</span> bucket_last<span class="special">,</span>
+ <span class="identifier">slist_node_ptr</span> sp<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span>
+<a name="idm30779-bb"></a><span class="identifier">get_prev_to_first_in_group</span><span class="special">(</span><span class="identifier">slist_node_ptr</span> bucket_node<span class="special">,</span>
+ <span class="identifier">node_ptr</span> first_in_group<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm30785-bb"></a><span class="identifier">erase_from_group</span><span class="special">(</span><span class="identifier">slist_node_ptr</span> end_ptr<span class="special">,</span> <span class="identifier">node_ptr</span> to_erase_ptr<span class="special">,</span>
+ <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm30794-bb"></a><span class="identifier">erase_from_group</span><span class="special">(</span><span class="identifier">slist_node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span> <a name="idm30803-bb"></a><span class="identifier">get_last_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> first_in_group<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span> <a name="idm30810-bb"></a><span class="identifier">get_last_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> n<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span> <a name="idm30817-bb"></a><span class="identifier">get_first_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> n<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span> <a name="idm30824-bb"></a><span class="identifier">get_first_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> n<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm30831-bb"></a><span class="identifier">is_first_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> ptr<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm30835-bb"></a><span class="identifier">insert_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span> first_in_group<span class="special">,</span> <span class="identifier">node_ptr</span> n<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm30844-bb"></a><span class="identifier">insert_in_group</span><span class="special">(</span><span class="identifier">node_ptr</span><span class="special">,</span> <span class="identifier">node_ptr</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">node_ptr</span> <a name="idm30853-bb"></a><span class="identifier">split_group</span><span class="special">(</span><span class="identifier">node_ptr</span> <span class="keyword">const</span> new_first<span class="special">)</span><span class="special">;</span></pre></li>
+</ol></div>
+</div>
+</div>
+</div>
+<div class="copyright-footer">Copyright © 2005 Olaf Krzikalla<br>Copyright © 2006-2015 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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="get_hashtable_siz_idm30721.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.hashtable_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="hash_bool_flags.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>