|
1 | 1 | {
|
2 | 2 | "elements": [
|
| 3 | + { |
| 4 | + "brief": "Hashtable capacity. Maximum number of entries poss...", |
| 5 | + "description": "Hashtable capacity. Maximum number of entries possible to store in table", |
| 6 | + "error": "", |
| 7 | + "examples": "", |
| 8 | + "language": "", |
| 9 | + "members": [], |
| 10 | + "name": "Capacity", |
| 11 | + "notes": [], |
| 12 | + "parameters": [], |
| 13 | + "replaces": "", |
| 14 | + "returnvalues": [ |
| 15 | + { |
| 16 | + "doc": "the capacity of the table", |
| 17 | + "name": "", |
| 18 | + "types": [ |
| 19 | + "uint32_t" |
| 20 | + ] |
| 21 | + } |
| 22 | + ], |
| 23 | + "tparams": [], |
| 24 | + "type": "FUNCTION" |
| 25 | + }, |
| 26 | + { |
| 27 | + "brief": "Removes all the entries from the table.", |
| 28 | + "description": "Removes all the entries from the table.", |
| 29 | + "error": "", |
| 30 | + "examples": "", |
| 31 | + "language": "", |
| 32 | + "members": [], |
| 33 | + "name": "Clear", |
| 34 | + "notes": [], |
| 35 | + "parameters": [], |
| 36 | + "replaces": "", |
| 37 | + "returnvalues": [], |
| 38 | + "tparams": [], |
| 39 | + "type": "FUNCTION" |
| 40 | + }, |
3 | 41 | {
|
4 | 42 | "brief": "hashtable",
|
5 | 43 | "description": "Hashtable with chaining for collision resolution, memcpy-copy semantics (POD types) and 32-bit indicies instead of pointers. (NUMA-friendly)",
|
|
17 | 55 | "tparams": [],
|
18 | 56 | "type": "FUNCTION"
|
19 | 57 | },
|
| 58 | + { |
| 59 | + "brief": "Constructor. Create an empty hashtable with zero c...", |
| 60 | + "description": "Constructor. Create an empty hashtable with zero capacity and zero hashtable (buckets)", |
| 61 | + "error": "", |
| 62 | + "examples": "", |
| 63 | + "language": "", |
| 64 | + "members": [], |
| 65 | + "name": "dmHashTable", |
| 66 | + "notes": [], |
| 67 | + "parameters": [], |
| 68 | + "replaces": "", |
| 69 | + "returnvalues": [], |
| 70 | + "tparams": [], |
| 71 | + "type": "FUNCTION" |
| 72 | + }, |
| 73 | + { |
| 74 | + "brief": "Creates a hashtable array with user allocated memo...", |
| 75 | + "description": "Creates a hashtable array with user allocated memory.", |
| 76 | + "error": "", |
| 77 | + "examples": "", |
| 78 | + "language": "", |
| 79 | + "members": [], |
| 80 | + "name": "dmHashTable", |
| 81 | + "notes": [ |
| 82 | + "User allocated arrays can not change capacity." |
| 83 | + ], |
| 84 | + "parameters": [ |
| 85 | + { |
| 86 | + "doc": "Pointer to user allocated continous data-block ((table_size<em>sizeof(uint32_t)) + (capacity</em>sizeof(dmHashTable::Entry))", |
| 87 | + "name": "user_allocated", |
| 88 | + "types": [ |
| 89 | + "" |
| 90 | + ] |
| 91 | + }, |
| 92 | + { |
| 93 | + "doc": "Hashtable size, ie number of buckets. table_size < 0xffffffff", |
| 94 | + "name": "table_size", |
| 95 | + "types": [ |
| 96 | + "" |
| 97 | + ] |
| 98 | + }, |
| 99 | + { |
| 100 | + "doc": "Capacity. capacity < 0xffffffff", |
| 101 | + "name": "capacity", |
| 102 | + "types": [ |
| 103 | + "" |
| 104 | + ] |
| 105 | + } |
| 106 | + ], |
| 107 | + "replaces": "", |
| 108 | + "returnvalues": [], |
| 109 | + "tparams": [], |
| 110 | + "type": "FUNCTION" |
| 111 | + }, |
20 | 112 | {
|
21 | 113 | "brief": "Specialized hash table with <span class=\"type\">uint16_t</span> as key...",
|
22 | 114 | "description": "Specialized hash table with <span class=\"type\">uint16_t</span> as keys",
|
|
62 | 154 | "tparams": [],
|
63 | 155 | "type": "FUNCTION"
|
64 | 156 | },
|
| 157 | + { |
| 158 | + "brief": "Check if the table is empty", |
| 159 | + "description": "Check if the table is empty", |
| 160 | + "error": "", |
| 161 | + "examples": "", |
| 162 | + "language": "", |
| 163 | + "members": [], |
| 164 | + "name": "Empty", |
| 165 | + "notes": [], |
| 166 | + "parameters": [], |
| 167 | + "replaces": "", |
| 168 | + "returnvalues": [ |
| 169 | + { |
| 170 | + "doc": "if the table is empty", |
| 171 | + "name": "true", |
| 172 | + "types": [ |
| 173 | + "" |
| 174 | + ] |
| 175 | + } |
| 176 | + ], |
| 177 | + "tparams": [], |
| 178 | + "type": "FUNCTION" |
| 179 | + }, |
| 180 | + { |
| 181 | + "brief": "Remove key/value pair.", |
| 182 | + "description": "Remove key/value pair.", |
| 183 | + "error": "", |
| 184 | + "examples": "", |
| 185 | + "language": "", |
| 186 | + "members": [], |
| 187 | + "name": "Erase", |
| 188 | + "notes": [ |
| 189 | + "Only valid if key exists in table" |
| 190 | + ], |
| 191 | + "parameters": [ |
| 192 | + { |
| 193 | + "doc": "Key to remove", |
| 194 | + "name": "key", |
| 195 | + "types": [ |
| 196 | + "Key" |
| 197 | + ] |
| 198 | + } |
| 199 | + ], |
| 200 | + "replaces": "", |
| 201 | + "returnvalues": [], |
| 202 | + "tparams": [], |
| 203 | + "type": "FUNCTION" |
| 204 | + }, |
| 205 | + { |
| 206 | + "brief": "Check if the table is full", |
| 207 | + "description": "Check if the table is full", |
| 208 | + "error": "", |
| 209 | + "examples": "", |
| 210 | + "language": "", |
| 211 | + "members": [], |
| 212 | + "name": "Full", |
| 213 | + "notes": [], |
| 214 | + "parameters": [], |
| 215 | + "replaces": "", |
| 216 | + "returnvalues": [ |
| 217 | + { |
| 218 | + "doc": "if the table is full", |
| 219 | + "name": "true", |
| 220 | + "types": [ |
| 221 | + "" |
| 222 | + ] |
| 223 | + } |
| 224 | + ], |
| 225 | + "tparams": [], |
| 226 | + "type": "FUNCTION" |
| 227 | + }, |
| 228 | + { |
| 229 | + "brief": "Get pointer to value from key", |
| 230 | + "description": "Get pointer to value from key", |
| 231 | + "error": "", |
| 232 | + "examples": "", |
| 233 | + "language": "", |
| 234 | + "members": [], |
| 235 | + "name": "Get", |
| 236 | + "notes": [], |
| 237 | + "parameters": [ |
| 238 | + { |
| 239 | + "doc": "Key", |
| 240 | + "name": "key", |
| 241 | + "types": [ |
| 242 | + "Key" |
| 243 | + ] |
| 244 | + } |
| 245 | + ], |
| 246 | + "replaces": "", |
| 247 | + "returnvalues": [ |
| 248 | + { |
| 249 | + "doc": "Pointer to value. NULL if the key/value pair doesn't exist.", |
| 250 | + "name": "value", |
| 251 | + "types": [ |
| 252 | + "T*" |
| 253 | + ] |
| 254 | + } |
| 255 | + ], |
| 256 | + "tparams": [], |
| 257 | + "type": "FUNCTION" |
| 258 | + }, |
65 | 259 | {
|
66 | 260 | "brief": "Get an iterator for the key/value pairs",
|
67 | 261 | "description": "Get an iterator for the key/value pairs",
|
|
85 | 279 | "tparams": [],
|
86 | 280 | "type": "FUNCTION"
|
87 | 281 | },
|
| 282 | + { |
| 283 | + "brief": "Iterate over all entries in table", |
| 284 | + "description": "Iterate over all entries in table", |
| 285 | + "error": "", |
| 286 | + "examples": "", |
| 287 | + "language": "", |
| 288 | + "members": [], |
| 289 | + "name": "Iterate", |
| 290 | + "notes": [], |
| 291 | + "parameters": [ |
| 292 | + { |
| 293 | + "doc": "Call-back called for every entry", |
| 294 | + "name": "call_back", |
| 295 | + "types": [ |
| 296 | + "" |
| 297 | + ] |
| 298 | + }, |
| 299 | + { |
| 300 | + "doc": "Context", |
| 301 | + "name": "context", |
| 302 | + "types": [ |
| 303 | + "" |
| 304 | + ] |
| 305 | + } |
| 306 | + ], |
| 307 | + "replaces": "", |
| 308 | + "returnvalues": [], |
| 309 | + "tparams": [], |
| 310 | + "type": "FUNCTION" |
| 311 | + }, |
88 | 312 | {
|
89 | 313 | "brief": "Iterator to the key/value pairs of a hash table",
|
90 | 314 | "description": "Iterator to the key/value pairs of a hash table",
|
|
133 | 357 | "returnvalues": [],
|
134 | 358 | "tparams": [],
|
135 | 359 | "type": "FUNCTION"
|
| 360 | + }, |
| 361 | + { |
| 362 | + "brief": "Put key/value pair in hash table. NOTE: The method...", |
| 363 | + "description": "Put key/value pair in hash table. NOTE: The method will \"assert\" if the hashtable is full.", |
| 364 | + "error": "", |
| 365 | + "examples": "", |
| 366 | + "language": "", |
| 367 | + "members": [], |
| 368 | + "name": "Put", |
| 369 | + "notes": [], |
| 370 | + "parameters": [ |
| 371 | + { |
| 372 | + "doc": "Key", |
| 373 | + "name": "key", |
| 374 | + "types": [ |
| 375 | + "Key" |
| 376 | + ] |
| 377 | + }, |
| 378 | + { |
| 379 | + "doc": "Value", |
| 380 | + "name": "value", |
| 381 | + "types": [ |
| 382 | + "const T&" |
| 383 | + ] |
| 384 | + } |
| 385 | + ], |
| 386 | + "replaces": "", |
| 387 | + "returnvalues": [], |
| 388 | + "tparams": [], |
| 389 | + "type": "FUNCTION" |
| 390 | + }, |
| 391 | + { |
| 392 | + "brief": "Set hashtable capacity. New capacity must be great...", |
| 393 | + "description": "Set hashtable capacity. New capacity must be greater or equal to current capacity", |
| 394 | + "error": "", |
| 395 | + "examples": "", |
| 396 | + "language": "", |
| 397 | + "members": [], |
| 398 | + "name": "SetCapacity", |
| 399 | + "notes": [], |
| 400 | + "parameters": [ |
| 401 | + { |
| 402 | + "doc": "Hashtable size, ie number of buckets. table_size < 0xffffffff", |
| 403 | + "name": "table_size", |
| 404 | + "types": [ |
| 405 | + "" |
| 406 | + ] |
| 407 | + }, |
| 408 | + { |
| 409 | + "doc": "Capacity. capacity < 0xffffffff", |
| 410 | + "name": "capacity", |
| 411 | + "types": [ |
| 412 | + "" |
| 413 | + ] |
| 414 | + } |
| 415 | + ], |
| 416 | + "replaces": "", |
| 417 | + "returnvalues": [], |
| 418 | + "tparams": [], |
| 419 | + "type": "FUNCTION" |
| 420 | + }, |
| 421 | + { |
| 422 | + "brief": "Number of entries stored in table. (not the actual...", |
| 423 | + "description": "Number of entries stored in table. (not the actual hashtable size)", |
| 424 | + "error": "", |
| 425 | + "examples": "", |
| 426 | + "language": "", |
| 427 | + "members": [], |
| 428 | + "name": "Size", |
| 429 | + "notes": [], |
| 430 | + "parameters": [], |
| 431 | + "replaces": "", |
| 432 | + "returnvalues": [ |
| 433 | + { |
| 434 | + "doc": "of entries.", |
| 435 | + "name": "Number", |
| 436 | + "types": [ |
| 437 | + "" |
| 438 | + ] |
| 439 | + } |
| 440 | + ], |
| 441 | + "tparams": [], |
| 442 | + "type": "FUNCTION" |
| 443 | + }, |
| 444 | + { |
| 445 | + "brief": "Swaps the contents of two hash tables", |
| 446 | + "description": "Swaps the contents of two hash tables", |
| 447 | + "error": "", |
| 448 | + "examples": "", |
| 449 | + "language": "", |
| 450 | + "members": [], |
| 451 | + "name": "Swap", |
| 452 | + "notes": [], |
| 453 | + "parameters": [ |
| 454 | + { |
| 455 | + "doc": "the other table", |
| 456 | + "name": "other", |
| 457 | + "types": [ |
| 458 | + "dmHashTable<KEY, T>&" |
| 459 | + ] |
| 460 | + } |
| 461 | + ], |
| 462 | + "replaces": "", |
| 463 | + "returnvalues": [], |
| 464 | + "tparams": [], |
| 465 | + "type": "FUNCTION" |
136 | 466 | }
|
137 | 467 | ],
|
138 | 468 | "info": {
|
|
0 commit comments