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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
use std::cmp::Ordering;

use scalable_cuckoo_filter::ScalableCuckooFilter;

use crate::cmp::Compare;
use crate::data::{SeaDHashMap, SeaDHashSet, new_hashset};
use crate::foundation::*;
use crate::utils::{get_codepoint_at, slice_concat_bytes};
use crate::vec::sorted::SortedVecU32;
use super::core::{SeaDawgCore, SeaEdge};

#[derive(Clone)]
pub enum TraversalMode {
  Traversal,
  Collection,
  Sink,
}

#[derive(Clone, Debug)]
pub struct TraversalResult {
  pub traversed_word: Box<str>,
  pub sink_id: NodeId,
}

impl Ord for TraversalResult {
  fn cmp(&self, other: &Self) -> Ordering {
    return self.sink_id.cmp(&other.sink_id);
  }
}

impl PartialOrd for TraversalResult {
  fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
    return self.sink_id.partial_cmp(&other.sink_id);
  }
}

impl PartialEq for TraversalResult {
  fn eq(&self, other: &Self) -> bool {
    return self.sink_id.eq(&other.sink_id);
  }
}

impl Eq for TraversalResult {
}

pub (in crate) struct TraversalExecutor {}

impl TraversalExecutor {

  pub fn new() -> Self {

    return Self {};
  }

  pub fn execute_traversal<Context: TraversalContext, Value>(
    &self,
    seadawg: &SeaDawgCore<Value>,
    mut traverser: &mut impl Traverser<Context, Value>,
    mut base_context: Context,
  ) -> Vec<TraversalResult> {

    let mut result: SortedVecU32<TraversalResult> = SortedVecU32::new();
    let mut traversal_contexts = vec![];
    let mut collected_traversal_contexts = vec![];
    traverser.setup(&mut base_context, &mut collected_traversal_contexts, seadawg);

    Self::finish_traversal_iteration(base_context, &mut traversal_contexts, &mut collected_traversal_contexts);

    while !traversal_contexts.is_empty() {
      let mut context = traversal_contexts.pop().unwrap();

      let should_traverse = !context.get_mut_edges_to_scan().is_empty();
      if !should_traverse {
        continue;
      }

      let edge_id = context.get_mut_edges_to_scan().pop().unwrap();
      let edge = seadawg.edges.get(&edge_id).unwrap();

      match context.mode() {
        TraversalMode::Traversal => {

          traverser.traverse(
            &edge_id,
            edge,
            &mut context,
            &mut collected_traversal_contexts,
            seadawg,
          );
        },
        TraversalMode::Collection => {

          traverser.collect(
            &edge_id,
            edge,
            &mut context,
            &mut collected_traversal_contexts,
            seadawg
          );
        },
        TraversalMode::Sink => {

          let traversed_word = std::str::from_utf8(context.traversed_word()).unwrap();

          if traverser.should_accept_sink_node(&context.sink_node(), context.word_idx(), traversed_word, seadawg) {
            let traversed_word = Box::from(traversed_word);
            result.insert_unique(TraversalResult {
              traversed_word,
              sink_id: context.sink_node(),
            });
          }
        },
      }

      Self::finish_traversal_iteration(context, &mut traversal_contexts, &mut collected_traversal_contexts);
    }

    return result.into_vec();
  }

  fn finish_traversal_iteration<Context: TraversalContext>(
    context: Context,
    traversal_contexts: &mut Vec<Context>,
    next_traversal_contexts: &mut Vec<Context>,
  ) {

    traversal_contexts.push(context);

    next_traversal_contexts.reverse();
    while let Some(context) = next_traversal_contexts.pop() {
      traversal_contexts.push(context);
    }
  }
}

pub trait Traverser<Context: TraversalContext, Value> {

  /// Initial selection of edges
  fn setup(&mut self, context: &mut Context, traversal_contexts: &mut Vec<Context>, seadawg: &SeaDawgCore<Value>);

  /// Moves down the graph and initiates further traversals or collections
  fn traverse(&mut self, edge_id: &EdgeId, edge: &SeaEdge, context: &mut Context, traversal_contexts: &mut Vec<Context>, seadawg: &SeaDawgCore<Value>);

  /// After pruning select sink edges that will be considered
  fn collect(&mut self, edge_id: &EdgeId, edge: &SeaEdge, context: &Context, traversal_contexts: &mut Vec<Context>, seadawg: &SeaDawgCore<Value>);

  /// Should sink node be added to the result set
  fn should_accept_sink_node(&mut self, sink_node_id: &NodeId, current_word_idx: StrLength, word: &str, seadawg: &SeaDawgCore<Value>) -> bool;
}

pub trait TraversalContext {
  fn mode(&self) -> TraversalMode;

  fn node(&self) -> NodeId;

  fn get_edges_to_scan(&self) -> &Vec<u32>;

  fn get_mut_edges_to_scan(&mut self) -> &mut Vec<EdgeId>;

  fn word_idx(&self) -> StrLength;

  fn traversed_word(&self) -> &[u8];

  fn sink_node(&self) -> NodeId;
}

pub struct TraversalContextData {
  mode: TraversalMode,
  node: Option<NodeId>,
  edges_to_scan: Vec<u32>,
  traversed_word: Vec<u8>,
  word_idx: StrLength,
  sink_node: Option<NodeId>,
}

impl TraversalContextData {

  pub fn new(
    mode: TraversalMode,
    node: Option<NodeId>,
    edges_to_scan: Vec<u32>,
    traversed_word: Vec<u8>,
    word_idx: StrLength,
    sink_node: Option<NodeId>,
  ) -> Self {

    return Self {
      mode,
      node,
      edges_to_scan,
      traversed_word,
      word_idx,
      sink_node,
    };
  }
}

pub struct FindPrefixContext {
  inner_data: TraversalContextData,
}

impl FindPrefixContext {
  pub fn new(inner_data: TraversalContextData) -> Self {
    return Self {
      inner_data,
    };
  }
}

impl TraversalContext for FindPrefixContext {
  fn mode(&self) -> TraversalMode {
    return self.inner_data.mode.clone();
  }

  fn node(&self) -> NodeId {
    return self.inner_data.node.unwrap();
  }

  fn get_edges_to_scan(&self) -> &Vec<u32> {
    return & self.inner_data.edges_to_scan;
  }

  fn get_mut_edges_to_scan(&mut self) -> &mut Vec<u32> {
    return &mut self.inner_data.edges_to_scan;
  }

  fn word_idx(&self) -> StrLength {
    return self.inner_data.word_idx;
  }

  fn traversed_word(&self) -> &[u8] {
    return self.inner_data.traversed_word.as_slice();
  }

  fn sink_node(&self) -> u32 {
    return self.inner_data.sink_node.unwrap();
  }
}

pub (in crate) struct FindPrefixTraverser<'a> {
  prefix_word: &'a str,
}

impl <'a> FindPrefixTraverser<'a> {
  pub fn new(prefix_word: &'a str) -> Self {

    return Self {
      prefix_word,
    };
  }
}

impl <'a, Value> Traverser<FindPrefixContext, Value> for FindPrefixTraverser<'a> {

  fn setup(&mut self, context: &mut FindPrefixContext, traversal_contexts: &mut Vec<FindPrefixContext>, seadawg: &SeaDawgCore<Value>) {

    let word_idx = &context.word_idx();

    let word_first_char = get_codepoint_at(self.prefix_word, *word_idx as usize);
    let matching_edge_id_option = seadawg.nodes.get_to(&context.node(), &word_first_char);

    if matching_edge_id_option.is_none() {
      return;
    }

    let matching_edge_id = matching_edge_id_option.unwrap();

    let proposed_context_inner = TraversalContextData {
      mode: TraversalMode::Traversal,
      node: Some(context.node()),
      word_idx: word_idx.clone(),
      traversed_word: context.traversed_word().to_vec(),
      edges_to_scan: vec![matching_edge_id.clone()],
      sink_node: None,
    };

    let proposed_context = FindPrefixContext::new(proposed_context_inner);
    traversal_contexts.push(proposed_context);
  }

  fn traverse(
    &mut self,
    edge_id: &EdgeId,
    edge: &SeaEdge,
    context: &mut FindPrefixContext,
    traversal_contexts: &mut Vec<FindPrefixContext>,
    seadawg: &SeaDawgCore<Value>,
  ) {
    let word_idx = context.word_idx() as usize;
    let word = self.prefix_word.as_bytes();
    let partial_len = seadawg.get_edge_idx_diff(edge) as usize + 1;
    let word_len_remaining = word.len() - word_idx;
    let sink = seadawg.get_sink(&edge.sink_id);
    let edge_start_idx = edge.start_idx as usize;
    let edge_end_len = edge.end_idx as usize + 1;
    let edge_partial = sink.unwrap().word[edge_start_idx..edge_end_len].as_bytes();

    if partial_len > word_len_remaining {

      if edge_partial[0..word_len_remaining].feq(&word[word_idx..(word_idx + word_len_remaining)]) {
        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Collection,
          node: None,
          word_idx: word_idx as u32,
          traversed_word: context.traversed_word().to_vec(),
          edges_to_scan: vec![edge_id.clone()],
          sink_node: None,
        };

        let proposed_context = FindPrefixContext::new(proposed_context_inner);
        traversal_contexts.push(proposed_context);
      }
    } else if edge_partial.feq(&word[word_idx..(word_idx + partial_len)]) {

      if partial_len == word_len_remaining {
        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Collection,
          node: None,
          word_idx: word_idx as u32,
          traversed_word: context.traversed_word().to_vec(),
          edges_to_scan: vec![edge_id.clone()],
          sink_node: None,
        };

        let proposed_context = FindPrefixContext::new(proposed_context_inner);
        traversal_contexts.push(proposed_context);

      } else if partial_len < word_len_remaining {

        let word_substring = &word[word_idx..(word_idx + partial_len)];
        let traversed_word = slice_concat_bytes(context.traversed_word(), word_substring);

        let edges_to_scan = seadawg.nodes.get_to_edges(&edge.dest);

        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Traversal,
          node: Some(edge.dest),
          word_idx: (word_idx + partial_len) as u32,
          traversed_word,
          edges_to_scan,
          sink_node: None,
        };

        let proposed_context = FindPrefixContext::new(proposed_context_inner);
        traversal_contexts.push(proposed_context);

      }
    }
  }

  fn collect(&mut self, edge_id: &EdgeId, edge: &SeaEdge, context: &FindPrefixContext, traversal_contexts: &mut Vec<FindPrefixContext>, seadawg: &SeaDawgCore<Value>) {

    let sink = seadawg.get_sink(&edge.sink_id);
    let edge_start_idx = edge.start_idx as usize;
    let edge_end_len = edge.end_idx as usize + 1;
    let edge_partial = sink.unwrap().word[edge_start_idx..edge_end_len].as_bytes();
    let traversed_word = slice_concat_bytes(context.traversed_word(), edge_partial);

    let node_id = &edge.dest;
    let node = seadawg.nodes.get_internal(node_id).unwrap();
    for sink_node_id in node.sink_nodes.iter() {
      let proposed_context_inner = TraversalContextData {
        mode: TraversalMode::Sink,
        node: None,
        word_idx: context.word_idx(), // This does not advance
        traversed_word: traversed_word.clone(),
        edges_to_scan: vec![*edge_id],
        sink_node: Some(*sink_node_id),
      };

      let proposed_context = FindPrefixContext::new(proposed_context_inner);
      traversal_contexts.push(proposed_context);
    }

    let proposed_context_inner = TraversalContextData {
      mode: TraversalMode::Collection,
      node: None,
      word_idx: context.word_idx() + edge_partial.len() as u32,
      traversed_word,
      edges_to_scan: seadawg.nodes.get_to_edges(node_id),
      sink_node: None,
    };

    let proposed_context = FindPrefixContext::new(proposed_context_inner);
    traversal_contexts.push(proposed_context);
  }

  fn should_accept_sink_node(&mut self, sink_node_id: &NodeId, current_word_idx: u32, word: &str, seadawg: &SeaDawgCore<Value>) -> bool {

    let sink_node = seadawg.nodes.get_sink(sink_node_id).unwrap();

    return word.len() == sink_node.length() as usize;
  }
}

pub struct FindSuperStringContext {
  inner_data: TraversalContextData,
  fall_through: bool,
}

impl FindSuperStringContext {
  pub fn new(inner_data: TraversalContextData, fall_through: bool) -> Self {
    return Self {
      inner_data,
      fall_through,
    };
  }
}

impl TraversalContext for FindSuperStringContext {
  fn mode(&self) -> TraversalMode {
    return self.inner_data.mode.clone();
  }

  fn node(&self) -> NodeId {
    return self.inner_data.node.unwrap();
  }

  fn get_edges_to_scan(&self) -> &Vec<u32> {
    return &self.inner_data.edges_to_scan;
  }

  fn get_mut_edges_to_scan(&mut self) -> &mut Vec<u32> {
    return &mut self.inner_data.edges_to_scan;
  }

  fn word_idx(&self) -> StrLength {
    return self.inner_data.word_idx;
  }

  fn traversed_word(&self) -> &[u8] {
    return self.inner_data.traversed_word.as_slice();
  }

  fn sink_node(&self) -> u32 {
    return self.inner_data.sink_node.unwrap();
  }
}

///
/// Super strings are strings that contain a substring.
/// In order for this to work, we need to traverse until getting to a sink node.
/// Once we have a sink node associated with the substring, we can backtrack using
/// the source node to reconstruct the original string.
pub (in crate) struct FindSuperStringTraverser<'a> {
  dup_filter: SeaDHashSet<u32>,
  needle: &'a str,
}

impl <'a> FindSuperStringTraverser<'a> {
  pub fn new(needle: &'a str) -> Self {
    return Self {
      dup_filter: new_hashset(),
      needle,
    };
  }
}

impl <'a, Value> Traverser<FindSuperStringContext, Value> for FindSuperStringTraverser<'a> {
  fn setup(&mut self, context: &mut FindSuperStringContext, traversal_contexts: &mut Vec<FindSuperStringContext>, seadawg: &SeaDawgCore<Value>) {

    let word_idx = &context.word_idx();
    let node_id = &context.node();

    let word_first_char = get_codepoint_at(self.needle, *word_idx as usize);
    let matching_edge_id_option = seadawg.nodes.get_to(node_id, &word_first_char);

    if matching_edge_id_option.is_none() {
      return;
    }

    let matching_edge_id = matching_edge_id_option.unwrap();

    let proposed_context_inner = TraversalContextData {
      mode: TraversalMode::Traversal,
      node: Some(context.node()),
      word_idx: word_idx.clone(),
      traversed_word: context.traversed_word().to_vec(),
      edges_to_scan: vec![matching_edge_id.clone()],
      sink_node: None,
    };

    let proposed_context = FindSuperStringContext::new(proposed_context_inner, false);
    traversal_contexts.push(proposed_context);
  }

  /// The idea is to then traverse to the sink.
  /// Once we have a sink, then initiate collection.
  fn traverse(&mut self, edge_id: &u32, edge: &SeaEdge, context: &mut FindSuperStringContext, traversal_contexts: &mut Vec<FindSuperStringContext>, seadawg: &SeaDawgCore<Value>) {

    let dest_node_id = &edge.dest;
    let dest_node = seadawg.nodes.get_internal(dest_node_id).unwrap();
    if context.fall_through {
      if !dest_node.sink_nodes.is_empty() {

        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Collection,
          node: Some(edge.dest),
          word_idx: 0,
          traversed_word: vec![],
          edges_to_scan: vec![*edge_id], // Ignored
          sink_node: None,
        };

        let mut proposed_context = FindSuperStringContext::new(proposed_context_inner, context.fall_through);
        traversal_contexts.push(proposed_context);
      }

      if !seadawg.nodes.has_no_to_edges(dest_node_id) {
        let sink = seadawg.get_sink(&edge.sink_id);
        let edge_start_idx = edge.start_idx as usize;
        let edge_end_len = edge.end_idx as usize + 1;
        let edge_partial = sink.unwrap().word[edge_start_idx..edge_end_len].as_bytes();
        let word_idx = context.word_idx();

        let traversed_word = slice_concat_bytes(context.traversed_word(), edge_partial);
        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Traversal,
          node: Some(*dest_node_id),
          word_idx,
          traversed_word,
          edges_to_scan: seadawg.nodes.get_to_edges(dest_node_id),
          sink_node: None,
        };

        let proposed_context = FindSuperStringContext::new(proposed_context_inner, context.fall_through);
        traversal_contexts.push(proposed_context);
      }

      return;
    }

    let needle = self.needle.as_bytes();
    let sink = seadawg.get_sink(&edge.sink_id);
    let edge_start_idx = edge.start_idx as usize;
    let edge_end_len = edge.end_idx as usize + 1;
    let edge_partial = sink.unwrap().word[edge_start_idx..edge_end_len].as_bytes();
    let word_idx = context.word_idx() as usize;
    let partial_len = edge_partial.len();
    let word_len_remaining = needle.len() - word_idx;

    if partial_len > word_len_remaining {

      if edge_partial[0..word_len_remaining].feq(&needle[word_idx..(word_idx + word_len_remaining)]) {

        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Traversal,
          node: Some(context.node()),
          word_idx: context.word_idx(),
          traversed_word: context.traversed_word().to_vec(),
          edges_to_scan:  vec![*edge_id],
          sink_node: None,
        };

        let proposed_context = FindSuperStringContext::new(proposed_context_inner, true);
        traversal_contexts.push(proposed_context);

      }
    } else if partial_len == word_len_remaining {

      if edge_partial.feq(&needle[word_idx..(word_idx + partial_len)]) {
        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Traversal,
          node: Some(context.node()),
          word_idx: context.word_idx(),
          traversed_word: context.traversed_word().to_vec(),
          edges_to_scan: vec![*edge_id],
          sink_node: None,
        };

        let proposed_context = FindSuperStringContext::new(proposed_context_inner, true);
        traversal_contexts.push(proposed_context);
      }
    } else {

      let word_idx = context.word_idx() + edge_partial.len() as u32;
      let next_letter = &get_codepoint_at(self.needle, word_idx as usize);
      let to_edge_opt = seadawg.nodes.get_to(dest_node_id, next_letter);

      if to_edge_opt.is_none() {
        return;
      }

      let traversed_word = slice_concat_bytes(context.traversed_word(), edge_partial);
      let proposed_context_inner = TraversalContextData {
        mode: TraversalMode::Traversal,
        node: Some(edge.dest),
        word_idx,
        traversed_word,
        edges_to_scan: vec![*to_edge_opt.unwrap()],
        sink_node: None,
      };

      let proposed_context = FindSuperStringContext::new(proposed_context_inner, false);
      traversal_contexts.push(proposed_context);
    }
  }

  fn collect(&mut self, edge_id: &u32, edge: &SeaEdge, context: &FindSuperStringContext, traversal_contexts: &mut Vec<FindSuperStringContext>, seadawg: &SeaDawgCore<Value>) {

    let node_id = &edge.dest;
    let node = seadawg.nodes.get_internal(node_id).unwrap();

    for sink_id in node.sink_nodes.iter() {

      if self.dup_filter.contains(sink_id) {
        continue;
      }

      self.dup_filter.insert(*sink_id);

      let edges_to_scan = vec![*edge_id];

      let sink = seadawg.nodes.get_sink(sink_id).unwrap();
      let proposed_context_inner = TraversalContextData {
        mode: TraversalMode::Sink,
        node: None,
        word_idx: 0,
        traversed_word: sink.word.as_bytes().to_vec(),
        edges_to_scan,
        sink_node: Some(*sink_id),
      };

      let mut proposed_context = FindSuperStringContext::new(proposed_context_inner, false);
      traversal_contexts.push(proposed_context);
    }
  }

  fn should_accept_sink_node(&mut self, sink_node_id: &NodeId, current_word_idx: u32, word: &str, seadawg: &SeaDawgCore<Value>) -> bool {

    return true;
    //return word.contains(self.needle);
  }
}

pub struct FindSuffixContext {
  inner_data: TraversalContextData,
}

impl FindSuffixContext {
  pub fn new(inner_data: TraversalContextData) -> Self {
    return Self {
      inner_data,
    };
  }
}

impl TraversalContext for FindSuffixContext {
  fn mode(&self) -> TraversalMode {
    return self.inner_data.mode.clone();
  }

  fn node(&self) -> NodeId {
    return self.inner_data.node.unwrap();
  }

  fn get_edges_to_scan(&self) -> &Vec<u32> {
    return & self.inner_data.edges_to_scan;
  }

  fn get_mut_edges_to_scan(&mut self) -> &mut Vec<u32> {
    return &mut self.inner_data.edges_to_scan;
  }

  fn word_idx(&self) -> StrLength {
    return self.inner_data.word_idx;
  }

  fn traversed_word(&self) -> &[u8] {
    return self.inner_data.traversed_word.as_slice();
  }

  fn sink_node(&self) -> u32 {
    return self.inner_data.sink_node.unwrap();
  }
}

///
/// Super strings are strings that contain a substring.
/// In order for this to work, we need to traverse until getting to a sink node.
/// Once we have a sink node associated with the substring, we can backtrack using
/// the source node to reconstruct the original string.
pub (in crate) struct FindSuffixTraverser<'a> {
  dup_filter: ScalableCuckooFilter<str>,
  needle: &'a str,
}

impl <'a> FindSuffixTraverser<'a> {
  pub fn new(needle: &'a str) -> Self {
    return Self {
      dup_filter: ScalableCuckooFilter::new(10, 0.0001),
      needle,
    };
  }
}

impl <'a, Value> Traverser<FindSuffixContext, Value> for FindSuffixTraverser<'a> {
  fn setup(&mut self, context: &mut FindSuffixContext, traversal_contexts: &mut Vec<FindSuffixContext>, seadawg: &SeaDawgCore<Value>) {

    let word_idx = &context.word_idx();
    let node_id = &context.node();

    let word_first_char = get_codepoint_at(self.needle, *word_idx as usize);
    let matching_edge_id_option = seadawg.nodes.get_to(node_id, &word_first_char);

    if matching_edge_id_option.is_none() {
      return;
    }

    let matching_edge_id = matching_edge_id_option.unwrap();

    let proposed_context_inner = TraversalContextData {
      mode: TraversalMode::Traversal,
      node: Some(context.node()),
      word_idx: word_idx.clone(),
      traversed_word: context.traversed_word().to_vec(),
      edges_to_scan: vec![matching_edge_id.clone()],
      sink_node: None,
    };

    let proposed_context = FindSuffixContext::new(proposed_context_inner);
    traversal_contexts.push(proposed_context);
  }

  /// This function never returns true because the initial forward edge selection process is done once
  /// since we will have a sufficient suffix. that prunes the search space.
  /// The idea is to then traverse to the sink.
  /// Once we have a sink, then initiate collection.
  fn traverse(&mut self, edge_id: &u32, edge: &SeaEdge, context: &mut FindSuffixContext, traversal_contexts: &mut Vec<FindSuffixContext>, seadawg: &SeaDawgCore<Value>) {

    let word_idx = context.word_idx() as usize;
    let word = self.needle.as_bytes();
    let partial_len = seadawg.get_edge_idx_diff(edge) as usize + 1;
    let word_len_remaining = word.len() - word_idx;
    let sink = seadawg.get_sink(&edge.sink_id);
    let edge_start_idx = edge.start_idx as usize;
    let edge_end_len = edge.end_idx as usize + 1;
    let edge_partial = &sink.unwrap().word[edge_start_idx..edge_end_len].as_bytes();

    if partial_len > word_len_remaining {

    } else if edge_partial.feq(&word[word_idx..(word_idx + partial_len)]) {

      if partial_len == word_len_remaining {
        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Collection,
          node: Some(context.node()),
          word_idx: word_idx as u32,
          traversed_word: context.traversed_word().to_vec(),
          edges_to_scan: vec![edge_id.clone()],
          sink_node: None,
        };

        let proposed_context = FindSuffixContext::new(proposed_context_inner);
        traversal_contexts.push(proposed_context);

      } else if partial_len < word_len_remaining {

        let word_substring = &word[word_idx..(word_idx + partial_len)];
        let traversed_word = slice_concat_bytes(context.traversed_word(), word_substring);

        let edges_to_scan = seadawg.nodes.get_to_edges(&edge.dest);

        let proposed_context_inner = TraversalContextData {
          mode: TraversalMode::Traversal,
          node: Some(edge.dest),
          word_idx: (word_idx + partial_len) as u32,
          traversed_word,
          edges_to_scan,
          sink_node: None,
        };

        let proposed_context = FindSuffixContext::new(proposed_context_inner);
        traversal_contexts.push(proposed_context);
      }
    }
  }

  fn collect(&mut self, edge_id: &u32, edge: &SeaEdge, context: &FindSuffixContext, traversal_contexts: &mut Vec<FindSuffixContext>, seadawg: &SeaDawgCore<Value>) {

    let node_id = &edge.dest;
    let node = seadawg.nodes.get_internal(node_id).unwrap();

    for sink_id in node.sink_nodes.iter() {
      let edges_to_scan = vec![*edge_id];

      let sink = seadawg.nodes.get_sink(sink_id).unwrap();
      let proposed_context_inner = TraversalContextData {
        mode: TraversalMode::Sink,
        node: None,
        word_idx: 0,
        traversed_word: sink.word.as_bytes().to_vec(),
        edges_to_scan,
        sink_node: Some(*sink_id),
      };

      let mut proposed_context = FindSuffixContext::new(proposed_context_inner);
      traversal_contexts.push(proposed_context);
    }
  }

  fn should_accept_sink_node(&mut self, sink_node_id: &NodeId, current_word_idx: u32, word: &str, seadawg: &SeaDawgCore<Value>) -> bool {

    if !self.dup_filter.contains(&word) {

      self.dup_filter.insert(&word);
    }

    return word.ends_with(self.needle);
  }
}