snapraid/cov/tommyds/tommyhashdyn.h.gcov.html
Andrea Mazzoleni 359d943ad8 Auto update
2026-04-29 15:08:50 +02:00

386 lines
35 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LCOV - lcov.info - tommyds/tommyhashdyn.h</title>
<link rel="stylesheet" type="text/css" href="../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LCOV - code coverage report</td></tr>
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td width="10%" class="headerItem">Current view:</td>
<td width="35%" class="headerValue"><a href="../index.html">top level</a> - <a href="index.html">tommyds</a> - tommyhashdyn.h<span style="font-size: 80%;"> (source / <a href="tommyhashdyn.h.func-sort-c.html">functions</a>)</span></td>
<td width="5%"></td>
<td width="15%"></td>
<td width="10%" class="headerCovTableHead">Hit</td>
<td width="10%" class="headerCovTableHead">Total</td>
<td width="15%" class="headerCovTableHead">Coverage</td>
</tr>
<tr>
<td class="headerItem">Test:</td>
<td class="headerValue">lcov.info</td>
<td></td>
<td class="headerItem">Lines:</td>
<td class="headerCovTableEntry">11</td>
<td class="headerCovTableEntry">11</td>
<td class="headerCovTableEntryHi">100.0 %</td>
</tr>
<tr>
<td class="headerItem">Date:</td>
<td class="headerValue">2026-04-29 15:04:44</td>
<td></td>
<td class="headerItem">Functions:</td>
<td class="headerCovTableEntry">3</td>
<td class="headerCovTableEntry">3</td>
<td class="headerCovTableEntryHi">100.0 %</td>
</tr>
<tr><td><img src="../glass.png" width=3 height=3 alt=""></td></tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td>
<pre class="sourceHeading"> Line data Source code</pre>
<pre class="source">
<a name="1"><span class="lineNum"> 1 </span> : // SPDX-License-Identifier: BSD-2-Clause</a>
<a name="2"><span class="lineNum"> 2 </span> : // Copyright (C) 2010 Andrea Mazzoleni</a>
<a name="3"><span class="lineNum"> 3 </span> : </a>
<a name="4"><span class="lineNum"> 4 </span> : /** \file</a>
<a name="5"><span class="lineNum"> 5 </span> : * Dynamic chained hashtable.</a>
<a name="6"><span class="lineNum"> 6 </span> : *</a>
<a name="7"><span class="lineNum"> 7 </span> : * This hashtable resizes dynamically. It starts with the minimal size of 16 buckets, it doubles</a>
<a name="8"><span class="lineNum"> 8 </span> : * the size when it reaches a load factor greater than 0.5 and it halves the size when the load</a>
<a name="9"><span class="lineNum"> 9 </span> : * factor is lower than 0.125.</a>
<a name="10"><span class="lineNum"> 10 </span> : *</a>
<a name="11"><span class="lineNum"> 11 </span> : * All the elements are reallocated in a single resize operation done inside</a>
<a name="12"><span class="lineNum"> 12 </span> : * tommy_hashdyn_insert() or tommy_hashdyn_remove().</a>
<a name="13"><span class="lineNum"> 13 </span> : *</a>
<a name="14"><span class="lineNum"> 14 </span> : * Note that the resize operation takes approximately 100 [ms] with 1 million of elements,</a>
<a name="15"><span class="lineNum"> 15 </span> : * and 1 [second] with 10 millions. This could be a problem in real-time applications.</a>
<a name="16"><span class="lineNum"> 16 </span> : *</a>
<a name="17"><span class="lineNum"> 17 </span> : * The resize also **fragments** the heap, as it involves allocating a double-sized table, **copying** elements,</a>
<a name="18"><span class="lineNum"> 18 </span> : * and deallocating the older table, **leaving** a big hole in the heap.</a>
<a name="19"><span class="lineNum"> 19 </span> : *</a>
<a name="20"><span class="lineNum"> 20 </span> : * The ::tommy_hashlin hashtable fixes both problems.</a>
<a name="21"><span class="lineNum"> 21 </span> : *</a>
<a name="22"><span class="lineNum"> 22 </span> : * To initialize the hashtable you have to call tommy_hashdyn_init().</a>
<a name="23"><span class="lineNum"> 23 </span> : *</a>
<a name="24"><span class="lineNum"> 24 </span> : * \code</a>
<a name="25"><span class="lineNum"> 25 </span> : * tommy_hashdyn hashdyn;</a>
<a name="26"><span class="lineNum"> 26 </span> : *</a>
<a name="27"><span class="lineNum"> 27 </span> : * tommy_hashdyn_init(&amp;hashdyn);</a>
<a name="28"><span class="lineNum"> 28 </span> : * \endcode</a>
<a name="29"><span class="lineNum"> 29 </span> : *</a>
<a name="30"><span class="lineNum"> 30 </span> : * To insert elements in the hashtable you have to call tommy_hashdyn_insert() for</a>
<a name="31"><span class="lineNum"> 31 </span> : * each element.</a>
<a name="32"><span class="lineNum"> 32 </span> : * In the insertion call you have to specify the address of the node, the</a>
<a name="33"><span class="lineNum"> 33 </span> : * address of the object, and the hash value of the key to use.</a>
<a name="34"><span class="lineNum"> 34 </span> : * The address of the object is used to initialize the tommy_node::data field</a>
<a name="35"><span class="lineNum"> 35 </span> : * of the node, and the hash to initialize the tommy_node::key field.</a>
<a name="36"><span class="lineNum"> 36 </span> : *</a>
<a name="37"><span class="lineNum"> 37 </span> : * \code</a>
<a name="38"><span class="lineNum"> 38 </span> : * struct object {</a>
<a name="39"><span class="lineNum"> 39 </span> : * int value;</a>
<a name="40"><span class="lineNum"> 40 </span> : * // other fields</a>
<a name="41"><span class="lineNum"> 41 </span> : * tommy_node node;</a>
<a name="42"><span class="lineNum"> 42 </span> : * };</a>
<a name="43"><span class="lineNum"> 43 </span> : *</a>
<a name="44"><span class="lineNum"> 44 </span> : * struct object* obj = malloc(sizeof(struct object)); // creates the object</a>
<a name="45"><span class="lineNum"> 45 </span> : *</a>
<a name="46"><span class="lineNum"> 46 </span> : * obj-&gt;value = ...; // initializes the object</a>
<a name="47"><span class="lineNum"> 47 </span> : *</a>
<a name="48"><span class="lineNum"> 48 </span> : * tommy_hashdyn_insert(&amp;hashdyn, &amp;obj-&gt;node, obj, tommy_inthash_u32(obj-&gt;value)); // inserts the object</a>
<a name="49"><span class="lineNum"> 49 </span> : * \endcode</a>
<a name="50"><span class="lineNum"> 50 </span> : *</a>
<a name="51"><span class="lineNum"> 51 </span> : * To find an element in the hashtable you have to call tommy_hashtable_search()</a>
<a name="52"><span class="lineNum"> 52 </span> : * providing a comparison function, its argument, and the hash of the key to search.</a>
<a name="53"><span class="lineNum"> 53 </span> : *</a>
<a name="54"><span class="lineNum"> 54 </span> : * \code</a>
<a name="55"><span class="lineNum"> 55 </span> : * int compare(const void* arg, const void* obj)</a>
<a name="56"><span class="lineNum"> 56 </span> : * {</a>
<a name="57"><span class="lineNum"> 57 </span> : * return *(const int*)arg != ((const struct object*)obj)-&gt;value;</a>
<a name="58"><span class="lineNum"> 58 </span> : * }</a>
<a name="59"><span class="lineNum"> 59 </span> : *</a>
<a name="60"><span class="lineNum"> 60 </span> : * int value_to_find = 1;</a>
<a name="61"><span class="lineNum"> 61 </span> : * struct object* obj = tommy_hashdyn_search(&amp;hashdyn, compare, &amp;value_to_find, tommy_inthash_u32(value_to_find));</a>
<a name="62"><span class="lineNum"> 62 </span> : * if (!obj) {</a>
<a name="63"><span class="lineNum"> 63 </span> : * // not found</a>
<a name="64"><span class="lineNum"> 64 </span> : * } else {</a>
<a name="65"><span class="lineNum"> 65 </span> : * // found</a>
<a name="66"><span class="lineNum"> 66 </span> : * }</a>
<a name="67"><span class="lineNum"> 67 </span> : * \endcode</a>
<a name="68"><span class="lineNum"> 68 </span> : *</a>
<a name="69"><span class="lineNum"> 69 </span> : * To iterate over all the elements in the hashtable with the same key, you have to</a>
<a name="70"><span class="lineNum"> 70 </span> : * use tommy_hashdyn_bucket() and follow the tommy_node::next pointer until NULL.</a>
<a name="71"><span class="lineNum"> 71 </span> : * You have also to check explicitly for the key, as the bucket may contain</a>
<a name="72"><span class="lineNum"> 72 </span> : * different keys.</a>
<a name="73"><span class="lineNum"> 73 </span> : *</a>
<a name="74"><span class="lineNum"> 74 </span> : * \code</a>
<a name="75"><span class="lineNum"> 75 </span> : * int value_to_find = 1;</a>
<a name="76"><span class="lineNum"> 76 </span> : * tommy_node* i = tommy_hashdyn_bucket(&amp;hashdyn, tommy_inthash_u32(value_to_find));</a>
<a name="77"><span class="lineNum"> 77 </span> : * while (i) {</a>
<a name="78"><span class="lineNum"> 78 </span> : * struct object* obj = i-&gt;data; // gets the object pointer</a>
<a name="79"><span class="lineNum"> 79 </span> : *</a>
<a name="80"><span class="lineNum"> 80 </span> : * if (obj-&gt;value == value_to_find) {</a>
<a name="81"><span class="lineNum"> 81 </span> : * printf(&quot;%d\n&quot;, obj-&gt;value); // process the object</a>
<a name="82"><span class="lineNum"> 82 </span> : * }</a>
<a name="83"><span class="lineNum"> 83 </span> : *</a>
<a name="84"><span class="lineNum"> 84 </span> : * i = i-&gt;next; // goes to the next element</a>
<a name="85"><span class="lineNum"> 85 </span> : * }</a>
<a name="86"><span class="lineNum"> 86 </span> : * \endcode</a>
<a name="87"><span class="lineNum"> 87 </span> : *</a>
<a name="88"><span class="lineNum"> 88 </span> : * To remove an element from the hashtable you have to call tommy_hashdyn_remove()</a>
<a name="89"><span class="lineNum"> 89 </span> : * providing a comparison function, its argument, and the hash of the key to search</a>
<a name="90"><span class="lineNum"> 90 </span> : * and remove.</a>
<a name="91"><span class="lineNum"> 91 </span> : *</a>
<a name="92"><span class="lineNum"> 92 </span> : * \code</a>
<a name="93"><span class="lineNum"> 93 </span> : * struct object* obj = tommy_hashdyn_remove(&amp;hashdyn, compare, &amp;value_to_remove, tommy_inthash_u32(value_to_remove));</a>
<a name="94"><span class="lineNum"> 94 </span> : * if (obj) {</a>
<a name="95"><span class="lineNum"> 95 </span> : * free(obj); // frees the object allocated memory</a>
<a name="96"><span class="lineNum"> 96 </span> : * }</a>
<a name="97"><span class="lineNum"> 97 </span> : * \endcode</a>
<a name="98"><span class="lineNum"> 98 </span> : *</a>
<a name="99"><span class="lineNum"> 99 </span> : * To destroy the hashtable you have to remove all the elements, and deinitialize</a>
<a name="100"><span class="lineNum"> 100 </span> : * the hashtable calling tommy_hashdyn_done().</a>
<a name="101"><span class="lineNum"> 101 </span> : *</a>
<a name="102"><span class="lineNum"> 102 </span> : * \code</a>
<a name="103"><span class="lineNum"> 103 </span> : * tommy_hashdyn_done(&amp;hashdyn);</a>
<a name="104"><span class="lineNum"> 104 </span> : * \endcode</a>
<a name="105"><span class="lineNum"> 105 </span> : *</a>
<a name="106"><span class="lineNum"> 106 </span> : * If you need to iterate over all the elements in the hashtable, you can use</a>
<a name="107"><span class="lineNum"> 107 </span> : * tommy_hashdyn_foreach() or tommy_hashdyn_foreach_arg().</a>
<a name="108"><span class="lineNum"> 108 </span> : * If you need a more precise control with a real iteration, you have to insert</a>
<a name="109"><span class="lineNum"> 109 </span> : * all the elements also in a ::tommy_list, and use the list to iterate.</a>
<a name="110"><span class="lineNum"> 110 </span> : * See the \ref multiindex example for more detail.</a>
<a name="111"><span class="lineNum"> 111 </span> : */</a>
<a name="112"><span class="lineNum"> 112 </span> : </a>
<a name="113"><span class="lineNum"> 113 </span> : #ifndef __TOMMYHASHDYN_H</a>
<a name="114"><span class="lineNum"> 114 </span> : #define __TOMMYHASHDYN_H</a>
<a name="115"><span class="lineNum"> 115 </span> : </a>
<a name="116"><span class="lineNum"> 116 </span> : #include &quot;tommyhash.h&quot;</a>
<a name="117"><span class="lineNum"> 117 </span> : </a>
<a name="118"><span class="lineNum"> 118 </span> : /******************************************************************************/</a>
<a name="119"><span class="lineNum"> 119 </span> : /* hashdyn */</a>
<a name="120"><span class="lineNum"> 120 </span> : </a>
<a name="121"><span class="lineNum"> 121 </span> : /** \internal</a>
<a name="122"><span class="lineNum"> 122 </span> : * Initial and minimal size of the hashtable expressed as a power of 2.</a>
<a name="123"><span class="lineNum"> 123 </span> : * The initial size is 2^TOMMY_HASHDYN_BIT.</a>
<a name="124"><span class="lineNum"> 124 </span> : */</a>
<a name="125"><span class="lineNum"> 125 </span> : #define TOMMY_HASHDYN_BIT 4</a>
<a name="126"><span class="lineNum"> 126 </span> : </a>
<a name="127"><span class="lineNum"> 127 </span> : /**</a>
<a name="128"><span class="lineNum"> 128 </span> : * Hashtable node.</a>
<a name="129"><span class="lineNum"> 129 </span> : * This is the node that you have to include inside your objects.</a>
<a name="130"><span class="lineNum"> 130 </span> : */</a>
<a name="131"><span class="lineNum"> 131 </span> : typedef tommy_node tommy_hashdyn_node;</a>
<a name="132"><span class="lineNum"> 132 </span> : </a>
<a name="133"><span class="lineNum"> 133 </span> : /**</a>
<a name="134"><span class="lineNum"> 134 </span> : * Hashtable container type.</a>
<a name="135"><span class="lineNum"> 135 </span> : * \note Don't use internal fields directly, but access the container only using functions.</a>
<a name="136"><span class="lineNum"> 136 </span> : */</a>
<a name="137"><span class="lineNum"> 137 </span> : typedef struct tommy_hashdyn_struct {</a>
<a name="138"><span class="lineNum"> 138 </span> : tommy_hashdyn_node** bucket; /**&lt; Hash buckets. One list for each hash modulus. */</a>
<a name="139"><span class="lineNum"> 139 </span> : tommy_size_t bucket_max; /**&lt; Number of buckets. */</a>
<a name="140"><span class="lineNum"> 140 </span> : tommy_size_t bucket_mask; /**&lt; Bit mask to access the buckets. */</a>
<a name="141"><span class="lineNum"> 141 </span> : tommy_size_t count; /**&lt; Number of elements. */</a>
<a name="142"><span class="lineNum"> 142 </span> : tommy_uint_t bucket_bit; /**&lt; Bits used in the bit mask. */</a>
<a name="143"><span class="lineNum"> 143 </span> : } tommy_hashdyn;</a>
<a name="144"><span class="lineNum"> 144 </span> : </a>
<a name="145"><span class="lineNum"> 145 </span> : /**</a>
<a name="146"><span class="lineNum"> 146 </span> : * Initializes the hashtable.</a>
<a name="147"><span class="lineNum"> 147 </span> : */</a>
<a name="148"><span class="lineNum"> 148 </span> : TOMMY_API void tommy_hashdyn_init(tommy_hashdyn* hashdyn);</a>
<a name="149"><span class="lineNum"> 149 </span> : </a>
<a name="150"><span class="lineNum"> 150 </span> : /**</a>
<a name="151"><span class="lineNum"> 151 </span> : * Deinitializes the hashtable.</a>
<a name="152"><span class="lineNum"> 152 </span> : *</a>
<a name="153"><span class="lineNum"> 153 </span> : * You can call this function with elements still contained,</a>
<a name="154"><span class="lineNum"> 154 </span> : * but such elements are not going to be freed by this call.</a>
<a name="155"><span class="lineNum"> 155 </span> : */</a>
<a name="156"><span class="lineNum"> 156 </span> : TOMMY_API void tommy_hashdyn_done(tommy_hashdyn* hashdyn);</a>
<a name="157"><span class="lineNum"> 157 </span> : </a>
<a name="158"><span class="lineNum"> 158 </span> : /**</a>
<a name="159"><span class="lineNum"> 159 </span> : * Inserts an element in the hashtable.</a>
<a name="160"><span class="lineNum"> 160 </span> : */</a>
<a name="161"><span class="lineNum"> 161 </span> : TOMMY_API void tommy_hashdyn_insert(tommy_hashdyn* hashdyn, tommy_hashdyn_node* node, void* data, tommy_hash_t hash);</a>
<a name="162"><span class="lineNum"> 162 </span> : </a>
<a name="163"><span class="lineNum"> 163 </span> : /**</a>
<a name="164"><span class="lineNum"> 164 </span> : * Searches and removes an element from the hashtable.</a>
<a name="165"><span class="lineNum"> 165 </span> : * You have to provide a compare function and the hash of the element you want to remove.</a>
<a name="166"><span class="lineNum"> 166 </span> : * If the element is not found, 0 is returned.</a>
<a name="167"><span class="lineNum"> 167 </span> : * If more equal elements are present, the first one is removed.</a>
<a name="168"><span class="lineNum"> 168 </span> : * \param cmp Compare function called with cmp_arg as first argument and with the element to compare as a second one.</a>
<a name="169"><span class="lineNum"> 169 </span> : * The function should return 0 for equal elements, anything other for different elements.</a>
<a name="170"><span class="lineNum"> 170 </span> : * \param cmp_arg Compare argument passed as first argument of the compare function.</a>
<a name="171"><span class="lineNum"> 171 </span> : * \param hash Hash of the element to find and remove.</a>
<a name="172"><span class="lineNum"> 172 </span> : * \return The removed element, or 0 if not found.</a>
<a name="173"><span class="lineNum"> 173 </span> : */</a>
<a name="174"><span class="lineNum"> 174 </span> : TOMMY_API void* tommy_hashdyn_remove(tommy_hashdyn* hashdyn, tommy_search_func* cmp, const void* cmp_arg, tommy_hash_t hash);</a>
<a name="175"><span class="lineNum"> 175 </span> : </a>
<a name="176"><span class="lineNum"> 176 </span> : /**</a>
<a name="177"><span class="lineNum"> 177 </span> : * Gets the bucket of the specified hash.</a>
<a name="178"><span class="lineNum"> 178 </span> : * The bucket is guaranteed to contain ALL the elements with the specified hash,</a>
<a name="179"><span class="lineNum"> 179 </span> : * but it can contain also others.</a>
<a name="180"><span class="lineNum"> 180 </span> : * You can access elements in the bucket following the ::next pointer until 0.</a>
<a name="181"><span class="lineNum"> 181 </span> : * \param hash Hash of the element to find.</a>
<a name="182"><span class="lineNum"> 182 </span> : * \return The head of the bucket, or 0 if empty.</a>
<a name="183"><span class="lineNum"> 183 </span> : */</a>
<a name="184"><span class="lineNum"> 184 </span><span class="lineCov"> 3443191 : tommy_inline tommy_hashdyn_node* tommy_hashdyn_bucket(tommy_hashdyn* hashdyn, tommy_hash_t hash)</span></a>
<a name="185"><span class="lineNum"> 185 </span> : {</a>
<a name="186"><span class="lineNum"> 186 </span><span class="lineCov"> 3443191 : return hashdyn-&gt;bucket[hash &amp; hashdyn-&gt;bucket_mask];</span></a>
<a name="187"><span class="lineNum"> 187 </span> : }</a>
<a name="188"><span class="lineNum"> 188 </span> : </a>
<a name="189"><span class="lineNum"> 189 </span> : /**</a>
<a name="190"><span class="lineNum"> 190 </span> : * Searches an element in the hashtable.</a>
<a name="191"><span class="lineNum"> 191 </span> : * You have to provide a compare function and the hash of the element you want to find.</a>
<a name="192"><span class="lineNum"> 192 </span> : * If more equal elements are present, the first one is returned.</a>
<a name="193"><span class="lineNum"> 193 </span> : * \param cmp Compare function called with cmp_arg as first argument and with the element to compare as a second one.</a>
<a name="194"><span class="lineNum"> 194 </span> : * The function should return 0 for equal elements, anything other for different elements.</a>
<a name="195"><span class="lineNum"> 195 </span> : * \param cmp_arg Compare argument passed as first argument of the compare function.</a>
<a name="196"><span class="lineNum"> 196 </span> : * \param hash Hash of the element to find.</a>
<a name="197"><span class="lineNum"> 197 </span> : * \return The first element found, or 0 if none.</a>
<a name="198"><span class="lineNum"> 198 </span> : */</a>
<a name="199"><span class="lineNum"> 199 </span><span class="lineCov"> 3379275 : tommy_inline void* tommy_hashdyn_search(tommy_hashdyn* hashdyn, tommy_search_func* cmp, const void* cmp_arg, tommy_hash_t hash)</span></a>
<a name="200"><span class="lineNum"> 200 </span> : {</a>
<a name="201"><span class="lineNum"> 201 </span><span class="lineCov"> 3379275 : tommy_hashdyn_node* i = tommy_hashdyn_bucket(hashdyn, hash);</span></a>
<a name="202"><span class="lineNum"> 202 </span> : </a>
<a name="203"><span class="lineNum"> 203 </span><span class="lineCov"> 4110568 : while (i) {</span></a>
<a name="204"><span class="lineNum"> 204 </span> : /* we first check if the hash matches, as in the same bucket we may have multiple hash values */</a>
<a name="205"><span class="lineNum"> 205 </span><span class="lineCov"> 2039363 : if (i-&gt;index == hash &amp;&amp; cmp(cmp_arg, i-&gt;data) == 0)</span></a>
<a name="206"><span class="lineNum"> 206 </span><span class="lineCov"> 1308070 : return i-&gt;data;</span></a>
<a name="207"><span class="lineNum"> 207 </span><span class="lineCov"> 731293 : i = i-&gt;next;</span></a>
<a name="208"><span class="lineNum"> 208 </span> : }</a>
<a name="209"><span class="lineNum"> 209 </span><span class="lineCov"> 2071205 : return 0;</span></a>
<a name="210"><span class="lineNum"> 210 </span> : }</a>
<a name="211"><span class="lineNum"> 211 </span> : </a>
<a name="212"><span class="lineNum"> 212 </span> : /**</a>
<a name="213"><span class="lineNum"> 213 </span> : * Removes an element from the hashtable.</a>
<a name="214"><span class="lineNum"> 214 </span> : * You must already have the address of the element to remove.</a>
<a name="215"><span class="lineNum"> 215 </span> : * \return The tommy_node::data field of the node removed.</a>
<a name="216"><span class="lineNum"> 216 </span> : */</a>
<a name="217"><span class="lineNum"> 217 </span> : TOMMY_API void* tommy_hashdyn_remove_existing(tommy_hashdyn* hashdyn, tommy_hashdyn_node* node);</a>
<a name="218"><span class="lineNum"> 218 </span> : </a>
<a name="219"><span class="lineNum"> 219 </span> : /**</a>
<a name="220"><span class="lineNum"> 220 </span> : * Calls the specified function for each element in the hashtable.</a>
<a name="221"><span class="lineNum"> 221 </span> : *</a>
<a name="222"><span class="lineNum"> 222 </span> : * You cannot add or remove elements from the inside of the callback,</a>
<a name="223"><span class="lineNum"> 223 </span> : * but can use it to deallocate them.</a>
<a name="224"><span class="lineNum"> 224 </span> : *</a>
<a name="225"><span class="lineNum"> 225 </span> : * \code</a>
<a name="226"><span class="lineNum"> 226 </span> : * tommy_hashdyn hashdyn;</a>
<a name="227"><span class="lineNum"> 227 </span> : *</a>
<a name="228"><span class="lineNum"> 228 </span> : * // initializes the hashtable</a>
<a name="229"><span class="lineNum"> 229 </span> : * tommy_hashdyn_init(&amp;hashdyn);</a>
<a name="230"><span class="lineNum"> 230 </span> : *</a>
<a name="231"><span class="lineNum"> 231 </span> : * ...</a>
<a name="232"><span class="lineNum"> 232 </span> : *</a>
<a name="233"><span class="lineNum"> 233 </span> : * // creates an object</a>
<a name="234"><span class="lineNum"> 234 </span> : * struct object* obj = malloc(sizeof(struct object));</a>
<a name="235"><span class="lineNum"> 235 </span> : *</a>
<a name="236"><span class="lineNum"> 236 </span> : * ...</a>
<a name="237"><span class="lineNum"> 237 </span> : *</a>
<a name="238"><span class="lineNum"> 238 </span> : * // insert it in the hashtable</a>
<a name="239"><span class="lineNum"> 239 </span> : * tommy_hashdyn_insert(&amp;hashdyn, &amp;obj-&gt;node, obj, tommy_inthash_u32(obj-&gt;value));</a>
<a name="240"><span class="lineNum"> 240 </span> : *</a>
<a name="241"><span class="lineNum"> 241 </span> : * ...</a>
<a name="242"><span class="lineNum"> 242 </span> : *</a>
<a name="243"><span class="lineNum"> 243 </span> : * // deallocates all the objects iterating the hashtable</a>
<a name="244"><span class="lineNum"> 244 </span> : * tommy_hashdyn_foreach(&amp;hashdyn, free);</a>
<a name="245"><span class="lineNum"> 245 </span> : *</a>
<a name="246"><span class="lineNum"> 246 </span> : * // deallocates the hashtable</a>
<a name="247"><span class="lineNum"> 247 </span> : * tommy_hashdyn_done(&amp;hashdyn);</a>
<a name="248"><span class="lineNum"> 248 </span> : * \endcode</a>
<a name="249"><span class="lineNum"> 249 </span> : */</a>
<a name="250"><span class="lineNum"> 250 </span> : TOMMY_API void tommy_hashdyn_foreach(tommy_hashdyn* hashdyn, tommy_foreach_func* func);</a>
<a name="251"><span class="lineNum"> 251 </span> : </a>
<a name="252"><span class="lineNum"> 252 </span> : /**</a>
<a name="253"><span class="lineNum"> 253 </span> : * Calls the specified function with an argument for each element in the hashtable.</a>
<a name="254"><span class="lineNum"> 254 </span> : */</a>
<a name="255"><span class="lineNum"> 255 </span> : TOMMY_API void tommy_hashdyn_foreach_arg(tommy_hashdyn* hashdyn, tommy_foreach_arg_func* func, void* arg);</a>
<a name="256"><span class="lineNum"> 256 </span> : </a>
<a name="257"><span class="lineNum"> 257 </span> : /**</a>
<a name="258"><span class="lineNum"> 258 </span> : * Gets the number of elements.</a>
<a name="259"><span class="lineNum"> 259 </span> : */</a>
<a name="260"><span class="lineNum"> 260 </span><span class="lineCov"> 476 : tommy_inline tommy_size_t tommy_hashdyn_count(tommy_hashdyn* hashdyn)</span></a>
<a name="261"><span class="lineNum"> 261 </span> : {</a>
<a name="262"><span class="lineNum"> 262 </span><span class="lineCov"> 476 : return hashdyn-&gt;count;</span></a>
<a name="263"><span class="lineNum"> 263 </span> : }</a>
<a name="264"><span class="lineNum"> 264 </span> : </a>
<a name="265"><span class="lineNum"> 265 </span> : /**</a>
<a name="266"><span class="lineNum"> 266 </span> : * Gets the size of allocated memory.</a>
<a name="267"><span class="lineNum"> 267 </span> : * It includes the size of the ::tommy_hashdyn_node of the stored elements.</a>
<a name="268"><span class="lineNum"> 268 </span> : */</a>
<a name="269"><span class="lineNum"> 269 </span> : TOMMY_API tommy_size_t tommy_hashdyn_memory_usage(tommy_hashdyn* hashdyn);</a>
<a name="270"><span class="lineNum"> 270 </span> : </a>
<a name="271"><span class="lineNum"> 271 </span> : /**</a>
<a name="272"><span class="lineNum"> 272 </span> : * \brief Transfers all elements from the hashtable into a tommy_list.</a>
<a name="273"><span class="lineNum"> 273 </span> : *</a>
<a name="274"><span class="lineNum"> 274 </span> : * Removes every element from the \p hashdyn hashtable and inserts them</a>
<a name="275"><span class="lineNum"> 275 </span> : * into the provided \p list (at the tail), preserving the per-bucket order</a>
<a name="276"><span class="lineNum"> 276 </span> : * but not guaranteeing any particular global order.</a>
<a name="277"><span class="lineNum"> 277 </span> : *</a>
<a name="278"><span class="lineNum"> 278 </span> : * After the call:</a>
<a name="279"><span class="lineNum"> 279 </span> : * - the hashtable is left completely empty</a>
<a name="280"><span class="lineNum"> 280 </span> : * - the target list contains all the elements that were previously in the hashtable</a>
<a name="281"><span class="lineNum"> 281 </span> : *</a>
<a name="282"><span class="lineNum"> 282 </span> : * This function is useful when you need to:</a>
<a name="283"><span class="lineNum"> 283 </span> : * - extract all elements to process/sort them outside the hash table</a>
<a name="284"><span class="lineNum"> 284 </span> : * - convert the hashtable into a list for sequential iteration</a>
<a name="285"><span class="lineNum"> 285 </span> : * - prepare for a full clear + re-insertion with different hash/ordering</a>
<a name="286"><span class="lineNum"> 286 </span> : * - move ownership of the nodes to a list-based container</a>
<a name="287"><span class="lineNum"> 287 </span> : *</a>
<a name="288"><span class="lineNum"> 288 </span> : * \note The operation is O(n) where n is the number of elements.</a>
<a name="289"><span class="lineNum"> 289 </span> : * \note No memory allocation is performed.</a>
<a name="290"><span class="lineNum"> 290 </span> : * \note The relative order of elements that were in the same bucket is preserved,</a>
<a name="291"><span class="lineNum"> 291 </span> : * but the order among different buckets is bucket-order dependent.</a>
<a name="292"><span class="lineNum"> 292 </span> : *</a>
<a name="293"><span class="lineNum"> 293 </span> : * Typical usage pattern:</a>
<a name="294"><span class="lineNum"> 294 </span> : * \code</a>
<a name="295"><span class="lineNum"> 295 </span> : * tommy_list all_elements;</a>
<a name="296"><span class="lineNum"> 296 </span> : * tommy_list_init(&amp;all_elements);</a>
<a name="297"><span class="lineNum"> 297 </span> : *</a>
<a name="298"><span class="lineNum"> 298 </span> : * // move everything out of the hashtable into the list</a>
<a name="299"><span class="lineNum"> 299 </span> : * tommy_hashdyn_to_list(&amp;hashdyn, &amp;all_elements);</a>
<a name="300"><span class="lineNum"> 300 </span> : *</a>
<a name="301"><span class="lineNum"> 301 </span> : * // now you can sort, filter, process sequentially, etc.</a>
<a name="302"><span class="lineNum"> 302 </span> : * tommy_list_sort(&amp;all_elements, compare_by_value);</a>
<a name="303"><span class="lineNum"> 303 </span> : * \endcode</a>
<a name="304"><span class="lineNum"> 304 </span> : *</a>
<a name="305"><span class="lineNum"> 305 </span> : * \param hashdyn The dynamic hashtable to drain</a>
<a name="306"><span class="lineNum"> 306 </span> : * \param list The list that will receive all the elements</a>
<a name="307"><span class="lineNum"> 307 </span> : */</a>
<a name="308"><span class="lineNum"> 308 </span> : TOMMY_API void tommy_hashdyn_to_list(tommy_hashdyn* hashdyn, tommy_list* list);</a>
<a name="309"><span class="lineNum"> 309 </span> : </a>
<a name="310"><span class="lineNum"> 310 </span> : #endif</a>
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="https://github.com/linux-test-project/lcov" target="_parent">LCOV version 1.0</a></td></tr>
</table>
<br>
</body>
</html>