File: htrie_set.h

package info (click to toggle)
spades 3.15.5%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 96,896 kB
  • sloc: cpp: 850,748; ansic: 156,813; python: 23,134; perl: 4,547; sh: 2,352; makefile: 1,273; java: 890; pascal: 875; xml: 19
file content (586 lines) | stat: -rw-r--r-- 19,612 bytes parent folder | download | duplicates (3)
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/**
 * MIT License
 * 
 * Copyright (c) 2017 Tessil
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef TSL_HTRIE_SET_H
#define TSL_HTRIE_SET_H

#include <cstddef>
#include <cstring>
#include <initializer_list>
#include <string>
#include <utility>
#include "htrie_hash.h"

namespace tsl {
    
/**
 * Implementation of a hat-trie set.
 * 
 * The size of a key string is limited to std::numeric_limits<KeySizeT>::max() - 1. 
 * That is 65 535 characters by default, but can be raised with the KeySizeT template parameter. 
 * See max_key_size() for an easy access to this limit.
 * 
 * Iterators invalidation:
 *  - clear, operator=: always invalidate the iterators.
 *  - insert: always invalidate the iterators.
 *  - erase: always invalidate the iterators.
 */ 
template<class CharT,
         class Hash = tsl::ah::str_hash<CharT>,
         class KeySizeT = std::uint16_t>
class htrie_set {
private:
    template<typename U>
    using is_iterator = tsl::detail_array_hash::is_iterator<U>;
    
    using ht = tsl::detail_htrie_hash::htrie_hash<CharT, void, Hash, KeySizeT>;
    
public:
    using char_type = typename ht::char_type;
    using key_size_type = typename ht::key_size_type;
    using size_type = typename ht::size_type;
    using hasher = typename ht::hasher;
    using iterator = typename ht::iterator;
    using const_iterator = typename ht::const_iterator;
    using prefix_iterator = typename ht::prefix_iterator;
    using const_prefix_iterator = typename ht::const_prefix_iterator;
    
public:
    explicit htrie_set(const Hash& hash = Hash()): m_ht(hash, ht::HASH_NODE_DEFAULT_MAX_LOAD_FACTOR,
                                                        ht::DEFAULT_BURST_THRESHOLD) 
    {
    }
    
    explicit htrie_set(size_type burst_threshold, 
                       const Hash& hash = Hash()): m_ht(hash, ht::HASH_NODE_DEFAULT_MAX_LOAD_FACTOR, 
                                                        burst_threshold) 
    {
    }   
    
    template<class InputIt, typename std::enable_if<is_iterator<InputIt>::value>::type* = nullptr>
    htrie_set(InputIt first, InputIt last,
             const Hash& hash = Hash()): htrie_set(hash)
    {
        insert(first, last);
    }
    
    
    
#ifdef TSL_HT_HAS_STRING_VIEW
    htrie_set(std::initializer_list<std::basic_string_view<CharT>> init,
              const Hash& hash = Hash()): htrie_set(hash)
    {
        insert(init);
    }
#else    
    htrie_set(std::initializer_list<const CharT*> init,
              const Hash& hash = Hash()): htrie_set(hash)
    {
        insert(init);
    }
#endif
    
    

#ifdef TSL_HT_HAS_STRING_VIEW
    htrie_set& operator=(std::initializer_list<std::basic_string_view<CharT>> ilist) {
        clear();
        insert(ilist);
        
        return *this;
    }
#else
    htrie_set& operator=(std::initializer_list<const CharT*> ilist) {
        clear();
        insert(ilist);
        
        return *this;
    }
#endif 
    
    
    
    /*
     * Iterators
     */
    iterator begin() noexcept { return m_ht.begin(); }
    const_iterator begin() const noexcept { return m_ht.begin(); }
    const_iterator cbegin() const noexcept { return m_ht.cbegin(); }
    
    iterator end() noexcept { return m_ht.end(); }
    const_iterator end() const noexcept { return m_ht.end(); }
    const_iterator cend() const noexcept { return m_ht.cend(); }
    
    
    /*
     * Capacity
     */
    bool empty() const noexcept { return m_ht.empty(); }
    size_type size() const noexcept { return m_ht.size(); }
    size_type max_size() const noexcept { return m_ht.max_size(); }
    size_type max_key_size() const noexcept { return m_ht.max_key_size(); }
    
    /**
     * Call shrink_to_fit() on each hash node of the hat-trie to reduce its size.
     */    
    void shrink_to_fit() { m_ht.shrink_to_fit(); }
    
        
    /*
     * Modifiers
     */
    void clear() noexcept { m_ht.clear(); }
    
    

    std::pair<iterator, bool> insert_ks(const CharT* key, size_type key_size) {
        return m_ht.insert(key, key_size);
    }    
#ifdef TSL_HT_HAS_STRING_VIEW
    std::pair<iterator, bool> insert(const std::basic_string_view<CharT>& key) {
        return m_ht.insert(key.data(), key.size()); 
    }
#else
    std::pair<iterator, bool> insert(const CharT* key) {
        return m_ht.insert(key, std::strlen(key));
    }
    
    std::pair<iterator, bool> insert(const std::basic_string<CharT>& key) {
        return m_ht.insert(key.data(), key.size()); 
    }
#endif
       
       
       
    template<class InputIt, typename std::enable_if<is_iterator<InputIt>::value>::type* = nullptr>
    void insert(InputIt first, InputIt last) {
        for(auto it = first; it != last; ++it) {
            insert(*it);
        }
    }
    
    

#ifdef TSL_HT_HAS_STRING_VIEW
    void insert(std::initializer_list<std::basic_string_view<CharT>> ilist) {
        insert(ilist.begin(), ilist.end());
    }
#else
    void insert(std::initializer_list<const CharT*> ilist) {
        insert(ilist.begin(), ilist.end());
    }
#endif
    
    

    std::pair<iterator, bool> emplace_ks(const CharT* key, size_type key_size) {
        return m_ht.insert(key, key_size);
    }     
#ifdef TSL_HT_HAS_STRING_VIEW
    std::pair<iterator, bool> emplace(const std::basic_string_view<CharT>& key) {
        return m_ht.insert(key.data(), key.size());
    }
#else
    std::pair<iterator, bool> emplace(const CharT* key) {
        return m_ht.insert(key, std::strlen(key));
    }
    
    std::pair<iterator, bool> emplace(const std::basic_string<CharT>& key) {
        return m_ht.insert(key.data(), key.size());
    }
#endif
    
    
    
    iterator erase(const_iterator pos) { return m_ht.erase(pos); }
    iterator erase(const_iterator first, const_iterator last) { return m_ht.erase(first, last); }

    

    size_type erase_ks(const CharT* key, size_type key_size) {
        return m_ht.erase(key, key_size);
    }    
#ifdef TSL_HT_HAS_STRING_VIEW
    size_type erase(const std::basic_string_view<CharT>& key) {
        return m_ht.erase(key.data(), key.size());
    }
#else
    size_type erase(const CharT* key) {
        return m_ht.erase(key, std::strlen(key));
    }
    
    size_type erase(const std::basic_string<CharT>& key) {
        return m_ht.erase(key.data(), key.size());
    }
#endif
    
    
    
    /**
     * Erase all the elements which have 'prefix' as prefix. Return the number of erase elements.
     */
    size_type erase_prefix_ks(const CharT* prefix, size_type prefix_size) {
        return m_ht.erase_prefix(prefix, prefix_size);
    }    
#ifdef TSL_HT_HAS_STRING_VIEW
    /**
     * @copydoc erase_prefix_ks(const CharT* prefix, size_type prefix_size)
     */
    size_type erase_prefix(const std::basic_string_view<CharT>& prefix) {
        return m_ht.erase_prefix(prefix.data(), prefix.size());
    }
#else
    /**
     * @copydoc erase_prefix_ks(const CharT* prefix, size_type prefix_size)
     */
    size_type erase_prefix(const CharT* prefix) {
        return m_ht.erase_prefix(prefix, std::strlen(prefix));
    }
    
    /**
     * @copydoc erase_prefix_ks(const CharT* prefix, size_type prefix_size)
     */
    size_type erase_prefix(const std::basic_string<CharT>& prefix) {
        return m_ht.erase_prefix(prefix.data(), prefix.size());
    }
#endif
    
    
    
    void swap(htrie_set& other) { other.m_ht.swap(m_ht); }
    
    
    /*
     * Lookup
     */
    size_type count_ks(const CharT* key, size_type key_size) const { return m_ht.count(key, key_size); }
#ifdef TSL_HT_HAS_STRING_VIEW 
    size_type count(const std::basic_string_view<CharT>& key) const { return m_ht.count(key.data(), key.size()); }
#else
    size_type count(const CharT* key) const { return m_ht.count(key, std::strlen(key)); }
    size_type count(const std::basic_string<CharT>& key) const { return m_ht.count(key.data(), key.size()); }
#endif
    
    

    iterator find_ks(const CharT* key, size_type key_size) {
        return m_ht.find(key, key_size);
    }
    
    const_iterator find_ks(const CharT* key, size_type key_size) const {
        return m_ht.find(key, key_size);
    }
#ifdef TSL_HT_HAS_STRING_VIEW 
    iterator find(const std::basic_string_view<CharT>& key) {
        return m_ht.find(key.data(), key.size());
    }
    
    const_iterator find(const std::basic_string_view<CharT>& key) const {
        return m_ht.find(key.data(), key.size());
    }
#else
    iterator find(const CharT* key) {
        return m_ht.find(key, std::strlen(key));
    }
    
    const_iterator find(const CharT* key) const {
        return m_ht.find(key, std::strlen(key));
    }
    
    iterator find(const std::basic_string<CharT>& key) {
        return m_ht.find(key.data(), key.size());
    }
    
    const_iterator find(const std::basic_string<CharT>& key) const {
        return m_ht.find(key.data(), key.size());
    }
#endif    
    

 
    std::pair<iterator, iterator> equal_range_ks(const CharT* key, size_type key_size) {
        return m_ht.equal_range(key, key_size);
    }
    
    std::pair<const_iterator, const_iterator> equal_range_ks(const CharT* key, size_type key_size) const {
        return m_ht.equal_range(key, key_size);
    }    
#ifdef TSL_HT_HAS_STRING_VIEW 
    std::pair<iterator, iterator> equal_range(const std::basic_string_view<CharT>& key) {
        return m_ht.equal_range(key.data(), key.size());
    }
    
    std::pair<const_iterator, const_iterator> equal_range(const std::basic_string_view<CharT>& key) const {
        return m_ht.equal_range(key.data(), key.size());
    }
#else
    std::pair<iterator, iterator> equal_range(const CharT* key) {
        return m_ht.equal_range(key, std::strlen(key));
    }
    
    std::pair<const_iterator, const_iterator> equal_range(const CharT* key) const {
        return m_ht.equal_range(key, std::strlen(key));
    }
    
    std::pair<iterator, iterator> equal_range(const std::basic_string<CharT>& key) {
        return m_ht.equal_range(key.data(), key.size());
    }
    
    std::pair<const_iterator, const_iterator> equal_range(const std::basic_string<CharT>& key) const {
        return m_ht.equal_range(key.data(), key.size());
    }
#endif   
    

    
    /**
     * Return a range containing all the elements which have 'prefix' as prefix. The range is defined by a pair
     * of iterator, the first being the begin iterator and the second being the end iterator.
     */
    std::pair<prefix_iterator, prefix_iterator> equal_prefix_range_ks(const CharT* prefix, size_type prefix_size) {
        return m_ht.equal_prefix_range(prefix, prefix_size);
    }
    
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<const_prefix_iterator, const_prefix_iterator> equal_prefix_range_ks(const CharT* prefix, size_type prefix_size) const {
        return m_ht.equal_prefix_range(prefix, prefix_size);
    }    
#ifdef TSL_HT_HAS_STRING_VIEW 
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<prefix_iterator, prefix_iterator> equal_prefix_range(const std::basic_string_view<CharT>& prefix) {
        return m_ht.equal_prefix_range(prefix.data(), prefix.size());
    }
     
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<const_prefix_iterator, const_prefix_iterator> equal_prefix_range(const std::basic_string_view<CharT>& prefix) const {
        return m_ht.equal_prefix_range(prefix.data(), prefix.size());
    }
#else 
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<prefix_iterator, prefix_iterator> equal_prefix_range(const CharT* prefix) {
        return m_ht.equal_prefix_range(prefix, std::strlen(prefix));
    }
     
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<const_prefix_iterator, const_prefix_iterator> equal_prefix_range(const CharT* prefix) const {
        return m_ht.equal_prefix_range(prefix, std::strlen(prefix));
    }
     
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<prefix_iterator, prefix_iterator> equal_prefix_range(const std::basic_string<CharT>& prefix) {
        return m_ht.equal_prefix_range(prefix.data(), prefix.size());
    }
     
    /**
     * @copydoc equal_prefix_range_ks(const CharT* prefix, size_type prefix_size)
     */
    std::pair<const_prefix_iterator, const_prefix_iterator> equal_prefix_range(const std::basic_string<CharT>& prefix) const {
        return m_ht.equal_prefix_range(prefix.data(), prefix.size());
    }
#endif
    
    
    
    /**
     * Return the element in the trie which is the longest prefix of `key`. If no
     * element in the trie is a prefix of `key`, the end iterator is returned.
     * 
     * Example:
     * 
     *     tsl::htrie_set<char> set = {"/foo", "/foo/bar"};
     * 
     *     set.longest_prefix("/foo"); // returns "/foo"
     *     set.longest_prefix("/foo/baz"); // returns "/foo"
     *     set.longest_prefix("/foo/bar/baz"); // returns "/foo/bar"
     *     set.longest_prefix("/foo/bar/"); // returns "/foo/bar"
     *     set.longest_prefix("/bar"); // returns end()
     *     set.longest_prefix(""); // returns end()
     */
    iterator longest_prefix_ks(const CharT* key, size_type key_size) {
        return m_ht.longest_prefix(key, key_size);
    }
    
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    const_iterator longest_prefix_ks(const CharT* key, size_type key_size) const {
        return m_ht.longest_prefix(key, key_size);
    }
#ifdef TSL_HT_HAS_STRING_VIEW 
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    iterator longest_prefix(const std::basic_string_view<CharT>& key) {
        return m_ht.longest_prefix(key.data(), key.size());
    }
    
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    const_iterator longest_prefix(const std::basic_string_view<CharT>& key) const {
        return m_ht.longest_prefix(key.data(), key.size());
    }
#else
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    iterator longest_prefix(const CharT* key) {
        return m_ht.longest_prefix(key, std::strlen(key));
    }
    
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    const_iterator longest_prefix(const CharT* key) const {
        return m_ht.longest_prefix(key, std::strlen(key));
    }
    
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    iterator longest_prefix(const std::basic_string<CharT>& key) {
        return m_ht.longest_prefix(key.data(), key.size());
    }
    
    /**
     * @copydoc longest_prefix_ks(const CharT* key, size_type key_size)
     */
    const_iterator longest_prefix(const std::basic_string<CharT>& key) const {
        return m_ht.longest_prefix(key.data(), key.size());
    }
#endif    
    
    
    
    /*
     *  Hash policy 
     */
    float max_load_factor() const { return m_ht.max_load_factor(); }
    void max_load_factor(float ml) { m_ht.max_load_factor(ml); }
    
    
    /*
     * Burst policy
     */
    size_type burst_threshold() const { return m_ht.burst_threshold(); }
    void burst_threshold(size_type threshold) { m_ht.burst_threshold(threshold); }
    
    
    /*
     * Observers
     */
    hasher hash_function() const { return m_ht.hash_function(); }
    
    
    
    /*
     * Other
     */
    
    /**
     * Serialize the set through the `serializer` parameter.
     * 
     * The `serializer` parameter must be a function object that supports the following calls:
     *  - `void operator()(const U& value);` where the types `std::uint64_t` and `float` must be supported for U.
     *  - `void operator()(const CharT* value, std::size_t value_size);`
     * 
     * The implementation leaves binary compatibilty (endianness, IEEE 754 for floats, ...) of the types it serializes
     * in the hands of the `Serializer` function object if compatibilty is required.
     */
    template<class Serializer>
    void serialize(Serializer& serializer) const {
        m_ht.serialize(serializer);
    }
    

    /**
     * Deserialize a previouly serialized set through the `deserializer` parameter.
     * 
     * The `deserializer` parameter must be a function object that supports the following calls:
     *  - `template<typename U> U operator()();` where the types `std::uint64_t` and `float` must be supported for U.
     *  - `void operator()(CharT* value_out, std::size_t value_size);`
     * 
     * If the deserialized hash set part of the hat-trie is hash compatible with the serialized set, the deserialization process 
     * can be sped up by setting `hash_compatible` to true. To be hash compatible, the Hash (take care of the 32-bits vs 64 bits), 
     * and KeySizeT must behave the same than the ones used in the serialized set. Otherwise the behaviour is undefined 
     * with `hash_compatible` sets to true.
     * 
     * The behaviour is undefined if the type `CharT` of the `htrie_set` is not the same as the
     * type used during serialization.
     * 
     * The implementation leaves binary compatibilty (endianness, IEEE 754 for floats, size of int, ...) of the types it 
     * deserializes in the hands of the `Deserializer` function object if compatibilty is required.
     */
    template<class Deserializer>
    static htrie_set deserialize(Deserializer& deserializer, bool hash_compatible = false) {
        htrie_set set;
        set.m_ht.deserialize(deserializer, hash_compatible);

        return set;
    }
    
    friend bool operator==(const htrie_set& lhs, const htrie_set& rhs) {
        if(lhs.size() != rhs.size()) {
            return false;
        }
        
        std::string key_buffer;
        for(auto it = lhs.cbegin(); it != lhs.cend(); ++it) {
            it.key(key_buffer);
            
            const auto it_element_rhs = rhs.find(key_buffer);
            if(it_element_rhs == rhs.cend()) {
                return false;
            }
        }
        
        return true;
    }

    friend bool operator!=(const htrie_set& lhs, const htrie_set& rhs) {
        return !operator==(lhs, rhs);
    }

    friend void swap(htrie_set& lhs, htrie_set& rhs) {
        lhs.swap(rhs);
    }
    
private:
    ht m_ht;
};

} // end namespace tsl

#endif