/usr/share/doc/libucommon-dev/a00084.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 | <!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: ucc::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="a00214.html">ucc</a>::<a class="el" href="a00084.html">MultiMap</a>
</div>
</div>
<div class="contents">
<h1>ucc::MultiMap Class Reference</h1><!-- doxytag: class="ucc::MultiMap" --><!-- doxytag: inherits="ucc::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="a00195_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::MultiMap:</div>
<div class="dynsection">
<div class="center"><img src="a00447.png" border="0" usemap="#ucc_1_1_multi_map_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_multi_map_inherit__map" id="ucc_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,315,171,344"/><area shape="rect" id="node2" href="a00113.html" title="Reusable objects for forming private heaps." alt="" coords="13,160,163,189"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="21,83,155,112"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="41,5,135,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::MultiMap:</div>
<div class="dynsection">
<div class="center"><img src="a00448.png" border="0" usemap="#ucc_1_1_multi_map_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_multi_map_coll__map" id="ucc_1_1_multi_map_coll__map">
<area shape="rect" id="node2" href="a00113.html" title="Reusable objects for forming private heaps." alt="" coords="5,187,155,216"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="13,96,147,125"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="33,5,127,35"/></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#ab6ccc78dd36386f418effb1d72406fe2">delist</a> (unsigned path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">De-list from a single map path. <a href="#ab6ccc78dd36386f418effb1d72406fe2"></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#a0df064fb7dd6842829cdf5380969d96c">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="#a0df064fb7dd6842829cdf5380969d96c"></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#a62ffe61c50ba2a1cb98ffbde1d32de38">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="#a62ffe61c50ba2a1cb98ffbde1d32de38"></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#abce0919918e30d2ec9abf70f15226ab0">next</a> (unsigned path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next node from single chain. <a href="#abce0919918e30d2ec9abf70f15226ab0"></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#aab0fd96e54c458b1ff3d1c9a27d1049c">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="#aab0fd96e54c458b1ff3d1c9a27d1049c"></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#a2bd94360741f75e58ce7639b8a789d6a">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="#a2bd94360741f75e58ce7639b8a789d6a"></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#a8f5f1a0512a4723ceb3ba62868ffbbec">compare</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="#a8f5f1a0512a4723ceb3ba62868ffbbec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#accaa9d39ffa659de5ec9b91f34544b9d">MultiMap</a> (unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a multilist object. <a href="#accaa9d39ffa659de5ec9b91f34544b9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73bd5fea4021047a11ba5a18a7441d28"></a><!-- doxytag: member="ucc::MultiMap::~MultiMap" ref="a73bd5fea4021047a11ba5a18a7441d28" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html#a73bd5fea4021047a11ba5a18a7441d28">~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="a00195_source.html#l00945">945</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="accaa9d39ffa659de5ec9b91f34544b9d"></a><!-- doxytag: member="ucc::MultiMap::MultiMap" ref="accaa9d39ffa659de5ec9b91f34544b9d" args="(unsigned count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::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="a8f5f1a0512a4723ceb3ba62868ffbbec"></a><!-- doxytag: member="ucc::MultiMap::compare" ref="a8f5f1a0512a4723ceb3ba62868ffbbec" 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 ucc::MultiMap::compare </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="ab6ccc78dd36386f418effb1d72406fe2"></a><!-- doxytag: member="ucc::MultiMap::delist" ref="ab6ccc78dd36386f418effb1d72406fe2" args="(unsigned path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::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="a0df064fb7dd6842829cdf5380969d96c"></a><!-- doxytag: member="ucc::MultiMap::enlist" ref="a0df064fb7dd6842829cdf5380969d96c" 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 ucc::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="a62ffe61c50ba2a1cb98ffbde1d32de38"></a><!-- doxytag: member="ucc::MultiMap::enlist" ref="a62ffe61c50ba2a1cb98ffbde1d32de38" args="(unsigned path, MultiMap **root)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::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="aab0fd96e54c458b1ff3d1c9a27d1049c"></a><!-- doxytag: member="ucc::MultiMap::find" ref="aab0fd96e54c458b1ff3d1c9a27d1049c" 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>* ucc::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="a2bd94360741f75e58ce7639b8a789d6a"></a><!-- doxytag: member="ucc::MultiMap::keyindex" ref="a2bd94360741f75e58ce7639b8a789d6a" 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 ucc::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="abce0919918e30d2ec9abf70f15226ab0"></a><!-- doxytag: member="ucc::MultiMap::next" ref="abce0919918e30d2ec9abf70f15226ab0" 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>* ucc::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="a00195_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:35 2010 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>
|