dawgdic 0.1.2

Port of DAFSA in safe Rust (original implementation courtesy to Susumu Yata)
Documentation
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
use crate::pool::Pool;
use crate::unit::BaseType;

pub struct Dawg {
    base_pool: Pool<BaseUnit>,
    label_pool: Pool<u8>,
    flag_pool: Pool<bool>, // TODO: BitPool tool
    num_states: BaseType,
    num_merged_transitions: BaseType,
    num_merged_states: BaseType,
    num_merging_states: BaseType,
}

impl Dawg {
    pub fn child(&self, index: BaseType) -> BaseType {
        self.base_pool[index].child()
    }

    pub fn sibling(&self, index: BaseType) -> BaseType {
        if self.base_pool[index].has_sibling() {
            index + 1
        } else {
            0
        }
    }

    pub fn value(&self, index: BaseType) -> BaseType {
        self.base_pool[index].value()
    }

    pub fn is_leaf(&self, index: BaseType) -> bool {
        self.label(index) == 0
    }

    pub fn label(&self, index: BaseType) -> u8 {
        self.label_pool[index]
    }

    pub fn is_merging(&self, index: BaseType) -> bool {
        self.flag_pool[index]
    }

    pub fn states_count(&self) -> BaseType {
        self.num_states
    }

    pub fn merged_states_count(&self) -> BaseType {
        self.num_merged_states
    }

    pub fn transition_count(&self) -> BaseType {
        self.base_pool.len() - 1
    }

    pub fn merged_transitions_count(&self) -> BaseType {
        self.num_merged_transitions
    }

    pub fn merging_states_count(&self) -> BaseType {
        self.num_merging_states
    }

    pub fn print(&self) {
        for item in self.base_pool.iter() {
            println!("{}", item.base())
        }
    }
}

#[repr(transparent)]
#[derive(Copy, Clone)]
struct BaseUnit(BaseType);

impl BaseUnit {
    fn child(&self) -> BaseType {
        self.0 >> 2
    }

    fn has_sibling(&self) -> bool {
        self.0 & 1 != 0
    }

    fn value(&self) -> BaseType {
        self.0 >> 1
    }

    fn is_state(&self) -> bool {
        self.0 & 2 != 0
    }

    fn set_base(&mut self, base: BaseType) {
        self.0 = base
    }

    fn base(&self) -> BaseType {
        self.0
    }
}

// BUILDER

#[derive(Default)]
pub struct DawgBuilder {
    base_pool: Pool<BaseUnit>,
    label_pool: Pool<u8>,
    flag_pool: Pool<bool>,
    unit_pool: Pool<DawgUnit>,
    hash_table: Pool<BaseType>,
    unfixed_units: Vec<BaseType>,
    unused_units: Vec<BaseType>,
    num_states: BaseType,
    num_merged_transitions: BaseType,
    num_merging_states: BaseType,
}

impl DawgBuilder {
    pub fn new() -> DawgBuilder {
        let mut builder: DawgBuilder = Default::default();
        builder.hash_table = {
            let mut hash_table = Vec::new();
            let initial_size = 1 << 8;
            hash_table.resize(initial_size, 0);
            Pool::from_vec(hash_table)
        };
        builder.num_states = 1;
        builder.reuse_or_create_unit();
        builder.allocate_transition();
        builder.unit_pool[0].set_label(0xFF);
        builder.unfixed_units.push(0);
        builder
    }

    pub fn insert_key(&mut self, key: &str, value: BaseType) -> Result<(), ()> {
        let mut bytes: Vec<u8> = key.bytes().collect();
        bytes.push(0);
        self.insert_key_bytes(&bytes, value)
    }

    fn insert_key_bytes(&mut self, key: &[u8], value: BaseType) -> Result<(), ()> {
        let mut index: BaseType = 0;
        let mut key_pos: usize = 0;

        // Find existing chain of units
        for (pos, byte) in key[0..].iter().enumerate() {
            key_pos = pos;
            let child_index = self.unit_pool[index].child;
            if child_index == 0 {
                break;
            }

            let key_label = byte;
            let unit_label = self.unit_pool[child_index].label;

            match key_label.cmp(&unit_label) {
                std::cmp::Ordering::Less => return Err(()),
                std::cmp::Ordering::Greater => {
                    self.unit_pool[child_index].set_has_sibling(true);
                    self.fix_units(child_index);
                    break;
                }
                std::cmp::Ordering::Equal => (),
            }

            index = child_index;
        }

        for byte in key[key_pos..].iter() {
            let child_index = self.reuse_or_create_unit();

            if self.unit_pool[index].child == 0 {
                self.unit_pool[child_index].set_is_state(true);
            }
            let child = self.unit_pool[index].child;
            self.unit_pool[child_index].set_sibling(child);
            self.unit_pool[child_index].set_label(*byte);
            self.unit_pool[index].set_child(child_index);
            self.unfixed_units.push(child_index);

            index = child_index;
        }

        self.unit_pool[index].set_value(value);

        Ok(())
    }

    pub fn build(mut self) -> Dawg {
        self.fix_units(0);
        self.base_pool[0].set_base(self.unit_pool[0].base());
        self.label_pool[0] = self.unit_pool[0].label;

        let num_transitions = self.base_pool.len() - 1;
        let num_merged_states = num_transitions + self.num_merged_transitions + 1 - self.num_states;
        Dawg {
            num_states: self.num_states,
            num_merged_transitions: self.num_merged_transitions,
            num_merged_states,
            num_merging_states: self.num_merging_states,
            base_pool: self.base_pool,
            label_pool: self.label_pool,
            flag_pool: self.flag_pool,
        }
    }

    fn fix_units(&mut self, index: BaseType) {
        while let Some(unfixed_index) = self.unfixed_units.pop() {
            if unfixed_index == index {
                break;
            }

            let hash_table_expansion_treshold =
                self.hash_table.len() - (self.hash_table.len() >> 2);
            if self.num_states >= hash_table_expansion_treshold {
                self.expand_hash_table();
            }

            let num_of_siblings: BaseType = {
                let mut count = 0;
                let mut i = unfixed_index;
                loop {
                    if i == 0 {
                        break;
                    }
                    count += 1;
                    i = self.unit_pool[i].sibling;
                }
                count
            };

            let unfixed_unit = self.find_unit(unfixed_index);
            let hash_id = unfixed_unit.hash_id;
            let mut matched_index: BaseType = unfixed_unit.transition_id;

            if matched_index != 0 {
                // TODO: avoid mutating lots of disparate fields
                self.num_merged_transitions += num_of_siblings;

                if !self.flag_pool[matched_index] {
                    self.num_merging_states += 1;
                    self.flag_pool[matched_index] = true;
                }
            } else {
                let mut transition_index = 0;
                for _ in 0..num_of_siblings {
                    transition_index = self.allocate_transition();
                }
                let mut i = unfixed_index;
                loop {
                    if i == 0 {
                        break;
                    }
                    self.base_pool[transition_index].set_base(self.unit_pool[i].base());
                    self.label_pool[transition_index] = self.unit_pool[i].label;
                    transition_index -= 1;
                    i = self.unit_pool[i].sibling;
                }
                matched_index = transition_index + 1;
                self.hash_table[hash_id] = matched_index;
                self.num_states += 1;
            }

            // Marking all fixed units for reuse
            let mut current = unfixed_index;
            let mut next = 0;
            loop {
                if current == 0 {
                    break;
                }
                next = self.unit_pool[current].sibling;
                self.mark_unit_as_unused(current);
                current = next;
            }

            let next_unfixed = self.unfixed_units.last().unwrap();
            self.unit_pool[*next_unfixed].set_child(matched_index);
        }
    }

    fn hash_transition(&self, index: BaseType) -> BaseType {
        let mut hash_value = 0;
        let mut index = index;
        loop {
            if index == 0 {
                break;
            }
            let base = self.base_pool[index].base();
            let label = self.label_pool[index];
            hash_value ^= Self::hash_from_base(base, label);
            if !self.base_pool[index].has_sibling() {
                break;
            }
            index += 1
        }
        hash_value
    }

    fn hash_unit(&self, index: BaseType) -> BaseType {
        let mut hash_value = 0;
        let mut index = index;
        loop {
            if index == 0 {
                break;
            }
            let base = self.unit_pool[index].base();
            let label = self.unit_pool[index].label;
            hash_value ^= Self::hash_from_base(base, label);
            index = self.unit_pool[index].sibling;
        }
        hash_value
    }

    fn find_unit(&self, unit_index: BaseType) -> FindUnitResult {
        let hash_table_size = self.hash_table.len();
        let mut hash_id = self.hash_unit(unit_index) % hash_table_size;
        loop {
            let transition_id = self.hash_table[hash_id];
            if transition_id == 0 {
                break;
            }
            if self.are_equal(unit_index, transition_id) {
                return FindUnitResult {
                    hash_id,
                    transition_id,
                };
            }
            hash_id = (hash_id + 1) % hash_table_size;
        }

        FindUnitResult {
            hash_id,
            transition_id: 0,
        }
    }

    fn are_equal(&self, unit_index: BaseType, transition_index: BaseType) -> bool {
        let mut i = self.unit_pool[unit_index].sibling;
        let mut transition_index = transition_index;
        loop {
            if i == 0 {
                break;
            }
            if !self.base_pool[transition_index].has_sibling() {
                return false;
            }
            transition_index += 1;
            i = self.unit_pool[i].sibling;
        }

        if self.base_pool[transition_index].has_sibling() {
            return false;
        }

        let mut i = unit_index;
        loop {
            if i == 0 {
                break;
            }
            if self.unit_pool[i].base() != self.base_pool[transition_index].base() {
                return false;
            }
            if self.unit_pool[i].label != self.label_pool[transition_index] {
                return false;
            }
            transition_index -= 1;
            i = self.unit_pool[i].sibling;
        }

        true
    }

    fn reuse_or_create_unit(&mut self) -> BaseType {
        let index = self.unused_units.pop().unwrap_or_else(|| {
            self.unit_pool.push(Default::default());
            self.unit_pool.len() - 1
        });
        self.unit_pool[index] = Default::default();
        index
    }

    #[inline]
    fn mark_unit_as_unused(&mut self, index: BaseType) {
        self.unused_units.push(index);
    }

    fn expand_hash_table(&mut self) {
        let hash_table_size = self.hash_table.len() << 1;
        self.hash_table.clear();
        self.hash_table.resize(hash_table_size, 0);

        // build new hash table
        for index in 1..self.base_pool.len() {
            if self.label_pool[index] == 0 || self.base_pool[index].is_state() {
                let transition = self.find_transition(index);
                self.hash_table[transition.hash_id] = index;
            }
        }
    }

    fn find_transition(&self, index: BaseType) -> FindUnitResult {
        let mut hash_id = self.hash_transition(index) % self.hash_table.len();
        loop {
            let transition_id = self.hash_table[hash_id];
            if transition_id == 0 {
                break;
            }
            hash_id = (hash_id + 1) % self.hash_table.len();
            // There must not be the same base value
        }
        FindUnitResult {
            hash_id,
            transition_id: 0,
        }
    }

    fn allocate_transition(&mut self) -> BaseType {
        self.flag_pool.push(false);
        self.base_pool.push(BaseUnit(0));
        let size = self.label_pool.len();
        self.label_pool.push(0);
        size
    }

    fn hash_from_base(value: BaseType, label: u8) -> BaseType {
        let value = value ^ (BaseType::from(label) << 24);
        let value = !value.overflowing_add(value << 15).0;
        let value = value ^ (value >> 12);
        let value = value.overflowing_add(value << 2).0;
        let value = value ^ (value >> 4);
        let value = value.overflowing_mul(2057).0;

        value ^ (value >> 16)
    }
}

#[derive(Default, Copy, Clone)]
struct DawgUnit {
    child: BaseType,
    sibling: BaseType,
    label: u8,
    is_state: bool,
    has_sibling: bool,
}

impl DawgUnit {
    fn base(&self) -> BaseType {
        if self.label == 0 {
            return (self.child << 1) | (if self.has_sibling { 1 } else { 0 });
        }
        (self.child << 2)
            | (if self.is_state { 2 } else { 0 })
            | (if self.has_sibling { 1 } else { 0 })
    }

    fn set_value(&mut self, value: BaseType) {
        self.child = value
    }

    fn set_child(&mut self, child: BaseType) {
        self.child = child;
    }

    fn set_sibling(&mut self, sibling: BaseType) {
        self.sibling = sibling;
    }

    fn set_label(&mut self, label: u8) {
        self.label = label
    }

    fn set_is_state(&mut self, is_state: bool) {
        self.is_state = is_state
    }

    fn set_has_sibling(&mut self, has_sibling: bool) {
        self.has_sibling = has_sibling
    }
}

#[derive(Copy, Clone)]
struct FindUnitResult {
    transition_id: BaseType,
    hash_id: BaseType,
}