<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: ucommon::MultiMap Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00084.html">MultiMap</a>
</div>
</div>
<div class="contents">
<h1>ucommon::MultiMap Class Reference</h1><!-- doxytag: class="ucommon::MultiMap" --><!-- doxytag: inherits="ucommon::ReusableObject" -->
<p>A multipath linked list where membership is managed in multiple lists.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::MultiMap:</div>
<div class="dynsection">
<div class="center"><img src="a00442.png" border="0" usemap="#ucommon_1_1_multi_map_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_multi_map_inherit__map" id="ucommon_1_1_multi_map_inherit__map">
<area shape="rect" id="node9" href="a00085.html" title="Embed data objects into a multipap structured memory database." alt="" coords="5,304,277,331"/><area shape="rect" id="node2" href="a00116.html" title="Reusable objects for forming private heaps." alt="" coords="16,155,267,181"/><area shape="rect" id="node4" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="25,80,257,107"/><area shape="rect" id="node6" href="a00095.html" title="A common base class for all managed objects." alt="" coords="16,5,267,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::MultiMap:</div>
<div class="dynsection">
<div class="center"><img src="a00443.png" border="0" usemap="#ucommon_1_1_multi_map_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_multi_map_coll__map" id="ucommon_1_1_multi_map_coll__map">
<area shape="rect" id="node2" href="a00116.html" title="Reusable objects for forming private heaps." alt="" coords="5,176,256,203"/><area shape="rect" id="node4" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="15,91,247,117"/><area shape="rect" id="node6" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a1eca6101880fb07cd12223c3fbfad271">delist</a> (unsigned path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">De-list from a single map path. <a href="#a1eca6101880fb07cd12223c3fbfad271"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a6ffc0c49921173a98ba9a0eaf32b9b24">enlist</a> (unsigned path, <a class="el" href="a00084.html">MultiMap</a> **index, caddr_t key, unsigned size, size_t keysize=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enlist binary key on a single map path. <a href="#a6ffc0c49921173a98ba9a0eaf32b9b24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a1176f1af25986e8eaa80b3cf2791a01b">enlist</a> (unsigned path, <a class="el" href="a00084.html">MultiMap</a> **root)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enlist on a single linked list. <a href="#a1176f1af25986e8eaa80b3cf2791a01b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00084.html">MultiMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a81e73662a5bcde63ff149d58cc4412c1">next</a> (unsigned path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next node from single chain. <a href="#a81e73662a5bcde63ff149d58cc4412c1"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00084.html">MultiMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a337ba2a107e4bce8c661acba02133bc7">find</a> (unsigned path, <a class="el" href="a00084.html">MultiMap</a> **index, caddr_t key, unsigned max, size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a multikey node. <a href="#a337ba2a107e4bce8c661acba02133bc7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#ae99f934db349169a0509a7f81fafb978">keyindex</a> (caddr_t key, unsigned max, size_t size=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute binary key index. <a href="#ae99f934db349169a0509a7f81fafb978"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#ad9039c0d8b052c4c2651b6f58a8ef8e2">equal</a> (unsigned path, caddr_t key, size_t size) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifiable interface for key matching. <a href="#ad9039c0d8b052c4c2651b6f58a8ef8e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#ab486ce7737f85e8eaf53fc70a043e1f0">MultiMap</a> (unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a multilist object. <a href="#ab486ce7737f85e8eaf53fc70a043e1f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc506ea7f1f57d2536bbed02d8ec2215"></a><!-- doxytag: member="ucommon::MultiMap::~MultiMap" ref="adc506ea7f1f57d2536bbed02d8ec2215" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#adc506ea7f1f57d2536bbed02d8ec2215">~MultiMap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a multilist object. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A multipath linked list where membership is managed in multiple lists. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00958">958</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab486ce7737f85e8eaf53fc70a043e1f0"></a><!-- doxytag: member="ucommon::MultiMap::MultiMap" ref="ab486ce7737f85e8eaf53fc70a043e1f0" args="(unsigned count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::MultiMap::MultiMap </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>count</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize a multilist object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>of link paths. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1eca6101880fb07cd12223c3fbfad271"></a><!-- doxytag: member="ucommon::MultiMap::delist" ref="a1eca6101880fb07cd12223c3fbfad271" args="(unsigned path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::MultiMap::delist </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>De-list from a single map path. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to detach from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6ffc0c49921173a98ba9a0eaf32b9b24"></a><!-- doxytag: member="ucommon::MultiMap::enlist" ref="a6ffc0c49921173a98ba9a0eaf32b9b24" args="(unsigned path, MultiMap **index, caddr_t key, unsigned size, size_t keysize=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::MultiMap::enlist </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00084.html">MultiMap</a> ** </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>keysize</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enlist binary key on a single map path. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to attach through. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>to attach to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>value to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keysize</em> </td><td>of key or 0 if NULL terminated string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1176f1af25986e8eaa80b3cf2791a01b"></a><!-- doxytag: member="ucommon::MultiMap::enlist" ref="a1176f1af25986e8eaa80b3cf2791a01b" args="(unsigned path, MultiMap **root)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::MultiMap::enlist </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00084.html">MultiMap</a> ** </td>
<td class="paramname"> <em>root</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enlist on a single linked list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to attach through. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>of list to attach. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad9039c0d8b052c4c2651b6f58a8ef8e2"></a><!-- doxytag: member="ucommon::MultiMap::equal" ref="ad9039c0d8b052c4c2651b6f58a8ef8e2" args="(unsigned path, caddr_t key, size_t size) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ucommon::MultiMap::equal </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modifiable interface for key matching. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of key to check or 0 if NULL terminated string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if matches key. </dd></dl>
</div>
</div>
<a class="anchor" id="a337ba2a107e4bce8c661acba02133bc7"></a><!-- doxytag: member="ucommon::MultiMap::find" ref="a337ba2a107e4bce8c661acba02133bc7" args="(unsigned path, MultiMap **index, caddr_t key, unsigned max, size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00084.html">MultiMap</a>* ucommon::MultiMap::find </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00084.html">MultiMap</a> ** </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a multikey node. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>node that is found or NULL if none. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>of table. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of hash table. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>to locate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>size of index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of key or 0 if NULL terminated string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae99f934db349169a0509a7f81fafb978"></a><!-- doxytag: member="ucommon::MultiMap::keyindex" ref="ae99f934db349169a0509a7f81fafb978" args="(caddr_t key, unsigned max, size_t size=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned ucommon::MultiMap::keyindex </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute binary key index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>memory to compute. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>size of index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of key or 0 if NULL terminated string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>associated hash value. </dd></dl>
</div>
</div>
<a class="anchor" id="a81e73662a5bcde63ff149d58cc4412c1"></a><!-- doxytag: member="ucommon::MultiMap::next" ref="a81e73662a5bcde63ff149d58cc4412c1" args="(unsigned path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00084.html">MultiMap</a>* ucommon::MultiMap::next </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get next node from single chain. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>to follow. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:45 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
