portmatching 0.3.3

Fast Graph Matching for Port Graphs
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
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
use std::{
    collections::{BTreeSet, VecDeque},
    hash::{BuildHasher, Hash},
};

use itertools::{Either, Itertools};

use crate::{
    automaton::{ScopeAutomaton, StateID},
    patterns::{IterationStatus, LinePattern, PredicatesIter},
    predicate::{are_compatible_predicates, EdgePredicate, PredicateCompatibility, Symbol},
    EdgeProperty, HashMap, HashSet, NodeProperty, Universe,
};

pub struct LineBuilder<U: Universe, PNode, PEdge> {
    patterns: Vec<LinePattern<U, PNode, PEdge>>,
    // Map from ({pattern_id} x line_nb) to automaton state
    det_states: HashMap<(BTreeSet<usize>, usize), StateID>,
}

impl<U: Universe, PNode, PEdge> LineBuilder<U, PNode, PEdge> {
    #[allow(unused)]
    pub fn new() -> Self {
        Self::default()
    }

    pub fn from_patterns(patterns: Vec<LinePattern<U, PNode, PEdge>>) -> Self {
        Self {
            patterns,
            det_states: HashMap::default(),
        }
    }

    #[allow(unused)]
    pub fn add_pattern(&mut self, pattern: LinePattern<U, PNode, PEdge>) {
        self.patterns.push(pattern);
    }

    pub fn build(mut self) -> ScopeAutomaton<PNode, PEdge>
    where
        PNode: NodeProperty,
        PEdge: EdgeProperty,
        PEdge::OffsetID: Eq + Hash,
    {
        let mut matcher = ScopeAutomaton::<PNode, PEdge>::new();

        // Convert patterns to pattern in construction
        let patterns = self
            .patterns
            .iter()
            .enumerate()
            .map(|(i, p)| PatternInConstruction::new(p.edge_predicates(), i))
            .collect::<Vec<_>>();

        let mut to_insert = VecDeque::new();
        to_insert.push_back((matcher.root(), patterns));
        while let Some((state, patterns)) = to_insert.pop_front() {
            // Filter out done patterns
            let (patterns_stages, done_ids): (Vec<_>, Vec<_>) =
                patterns.into_iter().partition_map(|mut p| {
                    let stage = p.edges.traversal_stage();
                    match stage {
                        IterationStatus::Finished => Either::Right(p.pattern_id),
                        _ => Either::Left((p, stage)),
                    }
                });
            // Insert flags for done patterns
            for p in done_ids {
                matcher.add_match(state, p.into());
            }
            let (patterns, stages): (Vec<_>, Vec<_>) = patterns_stages.into_iter().unzip();
            // The current stage of the iteration is the minimum of all stages
            let Some(&current_stage) = stages.iter().min() else {
                continue;
            };
            // Compute the next transitions
            let transitions = if matches!(current_stage, IterationStatus::LeftOver(_)) {
                // In the leftover stage, only use det transitions
                // Store predicates as a map (stage -> predicates)
                let stage_patterns = stages
                    .into_iter()
                    .map(|stage| match stage {
                        IterationStatus::LeftOver(i) => i,
                        _ => unreachable!("finished was filtered out and skeleton is smaller"),
                    })
                    .zip(patterns)
                    .into_grouping_map()
                    .collect();
                self.only_det_predicates(state, stage_patterns)
            } else {
                self.get_compatible_predicates(state, patterns)
            };
            let new_children = self.add_transitions(&mut matcher, &transitions);

            // Enqueue new states
            for (new_state, mut new_transition) in new_children.into_iter().zip(transitions) {
                if let Some(new_state) = new_state {
                    if let Some(stage) = leftover_stage(&mut new_transition.patterns) {
                        // Insert into our catalog of deterministic states
                        let pattern_ids = new_transition
                            .patterns
                            .iter()
                            .map(|p| p.pattern_id)
                            .collect();
                        self.det_states
                            .entry((pattern_ids, stage))
                            .or_insert(new_state);
                    }
                    to_insert.push_back((new_state, new_transition.patterns));
                }
            }
        }
        matcher
    }

    fn add_transitions(
        &self,
        matcher: &mut ScopeAutomaton<PNode, PEdge>,
        transitions: &[TransitionInConstruction<'_, U, PNode, PEdge>],
    ) -> Vec<Option<StateID>>
    where
        PNode: NodeProperty,
        PEdge: EdgeProperty,
        PEdge::OffsetID: Eq,
    {
        let mut new_states = vec![None; transitions.len()];
        // Enumerate them so that we can restore their ordering
        let transitions = transitions.iter().enumerate();

        for (source, transitions) in partition_by(transitions, |(_, t)| t.source) {
            let (inds, targets, preds, scopes): (Vec<_>, Vec<_>, Vec<_>, Vec<_>) = transitions
                .into_iter()
                .map(|(i, t)| (i, t.target, t.pred.clone(), t.scope()))
                .multiunzip();

            // make source non-deterministic if necessary
            match are_compatible_predicates(&preds) {
                PredicateCompatibility::Deterministic => {}
                PredicateCompatibility::NonDeterministic => matcher.make_non_det(source),
                PredicateCompatibility::Incompatible => {
                    panic!("trying to insert non-compatible transitions");
                }
            }

            let added_states = matcher.set_children(source, preds, &targets, scopes);

            for (i, new_state) in inds.into_iter().zip(added_states) {
                new_states[i] = new_state;
            }
        }

        new_states
    }

    /// The next predicate of each pattern
    ///
    /// Tries to consume the first predicate of each pattern. If there is a mix
    /// of deterministic and non-deterministic transitions, then prioritise
    /// non-deterministic ones and bundle all deterministc ones behind a single
    /// True transition.
    fn get_compatible_predicates<'a>(
        &self,
        source: StateID,
        patterns: Vec<PatternInConstruction<'a, U, PNode, PEdge>>,
    ) -> Vec<TransitionInConstruction<'a, U, PNode, PEdge>>
    where
        PNode: NodeProperty,
        PEdge: EdgeProperty,
        PEdge::OffsetID: Hash,
    {
        let mut patterns = patterns
            .into_iter()
            .map(|mut p| (p.edges.peek().expect("Not finished").transition_type(), p))
            .into_group_map();
        let nondet_patterns = patterns.remove(&PredicateCompatibility::NonDeterministic);
        let det_patterns = patterns.remove(&PredicateCompatibility::Deterministic);
        debug_assert!(patterns.is_empty());

        let mut transitions = Vec::new();
        if let Some(patterns) = nondet_patterns {
            transitions.append(&mut create_transitions(
                source,
                patterns
                    .into_iter()
                    .map(|mut p| (p.next_edge().expect("Not finished"), p)),
            ));
        }
        if let Some(patterns) = det_patterns {
            if transitions.is_empty() {
                // No non-det, so we can just add all deterministic transitions
                transitions.append(&mut create_transitions(
                    source,
                    patterns
                        .into_iter()
                        .map(|mut p| (p.next_edge().expect("Not finished"), p)),
                ));
            } else {
                // Add a single True transition, and put all det transitions there
                transitions.push(TransitionInConstruction {
                    source,
                    target: None,
                    pred: EdgePredicate::True,
                    patterns,
                })
            }
        }
        transitions
    }

    /// Force deterministic transitions
    ///
    /// Unlike other transition functions, this does the patterns in the children
    /// states do not necessary form a partition: patterns might be cloned up
    /// to `n` times, yielding an exponential overhead if this is called repeatedly.
    fn only_det_predicates<'a, H: BuildHasher>(
        &self,
        source: StateID,
        mut patterns: std::collections::HashMap<
            usize,
            Vec<PatternInConstruction<'a, U, PNode, PEdge>>,
            H,
        >,
    ) -> Vec<TransitionInConstruction<'a, U, PNode, PEdge>>
    where
        PNode: NodeProperty,
        PEdge: EdgeProperty,
        PEdge::OffsetID: Hash,
    {
        // Find the min stage
        let Some(&min_stage) = patterns.keys().min() else {
            return Vec::new();
        };
        // Split patterns between min stage and other stages
        let min_patterns = patterns.remove(&min_stage).unwrap();
        let mut other_patterns = patterns.into_values().flatten().collect_vec();

        // Introduce the transitions as normal for the minimal stage
        // We need to be careful about the "scope" of the patterns
        // If the scope is smaller than the total scope, then we need to add
        // a child node to handle the smaller scope.
        let min_scopes = min_patterns.iter().map(|p| p.scope.clone()).collect_vec();
        let scope = min_scopes.iter().max_by_key(|s| s.len()).unwrap();
        let (mut in_scope_patterns, mut out_scope_patterns): (Vec<_>, Vec<_>) = min_patterns
            .iter()
            .cloned()
            .partition(|p| scope.is_superset(&p.scope));
        if !out_scope_patterns.is_empty() {
            // we need to split the predicates into two halves, because
            // the scopes do not have a join
            in_scope_patterns.extend(other_patterns.iter().cloned());
            out_scope_patterns.extend(other_patterns.iter().cloned());
            return vec![
                TransitionInConstruction {
                    source,
                    target: None,
                    pred: EdgePredicate::True,
                    patterns: in_scope_patterns,
                },
                TransitionInConstruction {
                    source,
                    target: None,
                    pred: EdgePredicate::True,
                    patterns: out_scope_patterns,
                },
            ];
        }
        // We handle the predicates with maximal scope
        let min_predicates = in_scope_patterns
            .iter_mut()
            .map(|p| p.next_edge().expect("Not finished"))
            .collect_vec();
        let mut transitions =
            create_transitions(source, min_predicates.into_iter().zip(in_scope_patterns));
        // Then add all other patterns to each possible transition
        for t in &mut transitions {
            t.patterns.append(&mut other_patterns.clone());
        }

        // Finally, we add a Fail transition to all other stages together
        // Also add patterns with smaller scope
        other_patterns.extend(
            min_patterns
                .into_iter()
                // The scope is contained, so just check the size
                .filter(|p| p.scope.len() < scope.len()),
        );
        if !other_patterns.is_empty() {
            let next_state = self.try_reuse_det_state(&mut other_patterns);
            transitions.push(TransitionInConstruction {
                source,
                target: next_state,
                pred: EdgePredicate::Fail,
                patterns: other_patterns,
            });
        }
        transitions
    }

    /// Find out whether a state that we can reuse exists
    fn try_reuse_det_state(
        &self,
        patterns: &mut [PatternInConstruction<'_, U, PNode, PEdge>],
    ) -> Option<StateID>
    where
        PNode: NodeProperty,
        PEdge: EdgeProperty,
    {
        let Some(stage) = leftover_stage(patterns) else {
            panic!("Can only reuse states in the LeftOver stage")
        };
        let pattern_ids = patterns.iter().map(|p| p.pattern_id).collect();
        self.det_states.get(&(pattern_ids, stage)).copied()
    }
}

fn leftover_stage<U: Universe, PNode: NodeProperty, PEdge: EdgeProperty>(
    patterns: &mut [PatternInConstruction<'_, U, PNode, PEdge>],
) -> Option<usize> {
    patterns
        .iter_mut()
        .map(|p| {
            if let IterationStatus::LeftOver(i) = p.edges.traversal_stage() {
                Some(i)
            } else {
                None
            }
        })
        .min()
        .flatten()
}

fn create_transitions<'a, U, PNode, PEdge>(
    source: StateID,
    iter: impl IntoIterator<
        Item = (
            EdgePredicate<PNode, PEdge, PEdge::OffsetID>,
            PatternInConstruction<'a, U, PNode, PEdge>,
        ),
    >,
) -> Vec<TransitionInConstruction<'a, U, PNode, PEdge>>
where
    U: Universe,
    PNode: NodeProperty,
    PEdge: EdgeProperty,
    PEdge::OffsetID: Hash,
{
    iter.into_iter()
        .into_group_map()
        .into_iter()
        .map(|(pred, patterns)| TransitionInConstruction {
            source,
            target: None,
            pred,
            patterns,
        })
        .collect()
}

#[derive(Clone)]
struct PatternInConstruction<'a, U: Universe, PNode, PEdge: EdgeProperty> {
    /// Predicates of the pattern yet to be inserted
    edges: PredicatesIter<'a, U, PNode, PEdge>,
    /// Pattern ID
    pattern_id: usize,
    /// The scope required to interpret the predicates
    /// This is initially empty, but is updated as predicates are consumed
    scope: HashSet<Symbol>,
}

struct TransitionInConstruction<'a, U: Universe, PNode, PEdge: EdgeProperty> {
    source: StateID,
    target: Option<StateID>,
    pred: EdgePredicate<PNode, PEdge, PEdge::OffsetID>,
    patterns: Vec<PatternInConstruction<'a, U, PNode, PEdge>>,
}

impl<'a, U: Universe, PNode, PEdge: EdgeProperty> TransitionInConstruction<'a, U, PNode, PEdge> {
    fn scope(&self) -> HashSet<Symbol> {
        self.patterns
            .iter()
            .flat_map(|p| p.scope.iter().copied())
            .collect()
    }
}

impl<'a, U: Universe, PNode: Clone, PEdge: EdgeProperty>
    PatternInConstruction<'a, U, PNode, PEdge>
{
    fn new(edges: PredicatesIter<'a, U, PNode, PEdge>, pattern_id: usize) -> Self {
        Self {
            edges,
            pattern_id,
            scope: [Symbol::root()].into_iter().collect(),
        }
    }

    fn next_edge(&mut self) -> Option<EdgePredicate<PNode, PEdge, PEdge::OffsetID>>
    where
        PNode: NodeProperty,
    {
        let edge = self.edges.next()?;
        if let EdgePredicate::LinkNewNode { new_node, .. } = edge {
            self.scope.insert(new_node);
        }
        Some(edge)
    }
}

impl<U: Universe, PNode, PEdge> Default for LineBuilder<U, PNode, PEdge> {
    fn default() -> Self {
        Self {
            patterns: Vec::new(),
            det_states: HashMap::default(),
        }
    }
}

impl<U: Universe, PNode, PEdge> FromIterator<LinePattern<U, PNode, PEdge>>
    for LineBuilder<U, PNode, PEdge>
{
    fn from_iter<T: IntoIterator<Item = LinePattern<U, PNode, PEdge>>>(iter: T) -> Self {
        Self {
            patterns: iter.into_iter().collect(),
            det_states: HashMap::default(),
        }
    }
}

fn partition_by<V, U, F>(iter: impl IntoIterator<Item = V>, f: F) -> HashMap<U, Vec<V>>
where
    U: Eq + Hash,
    F: for<'a> Fn(&'a mut V) -> U,
{
    let mut partitions = HashMap::default();
    for mut v in iter {
        let u = f(&mut v);
        partitions.entry(u).or_insert_with(Vec::new).push(v);
    }
    partitions
}

#[cfg(test)]
mod tests {
    use crate::{patterns::LinePattern, EdgeProperty};

    use super::LineBuilder;

    impl EdgeProperty for usize {
        type OffsetID = usize;

        fn reverse(&self) -> Option<Self> {
            Some(*self)
        }

        fn offset_id(&self) -> Self::OffsetID {
            0
        }
    }

    #[test]
    fn test_simple_build() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0), (1, 2, 1)]);

        let builder: LineBuilder<_, _, _> = [p1, p2].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 7);
    }

    #[test]
    #[should_panic]
    fn test_incompatible_preds() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0), (0, 2, 1)]);

        let builder: LineBuilder<_, _, _> = [p1, p2].into_iter().collect();
        builder.build();
    }

    #[test]
    fn test_build_two_dir() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);
        p1.add_line(0, vec![(0, 3, 1), (3, 4, 0)]);
        p1.add_line(1, vec![(1, 5, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);
        p2.add_line(0, vec![(0, 3, 1), (3, 4, 0)]);
        p2.add_line(3, vec![(3, 5, 0)]);

        let builder: LineBuilder<_, _, _> = [p1, p2].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 18);
    }

    #[test]
    fn test_build_two_different_length() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);
        p1.add_line(0, vec![(0, 3, 0), (3, 4, 0)]);
        p1.add_line(1, vec![(1, 5, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0)]);
        p2.add_line(0, vec![(0, 3, 0), (3, 4, 0)]);

        let builder: LineBuilder<_, _, _> = [p1, p2].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 15);
    }

    #[test]
    fn test_build_full_det() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0), (2, 3, 0), (3, 4, 0)]);
        p1.add_line(0, vec![(0, 1, 1), (1, 5, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);
        p2.add_line(0, vec![(0, 1, 1)]);

        let builder: LineBuilder<_, _, _> = [p1, p2].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 13);
    }

    #[test]
    fn test_build_full_3_det() {
        let mut p1 = LinePattern::new();
        p1.require(0, 1);
        p1.add_line(0, vec![(0, 1, 0), (1, 2, 0), (2, 3, 0), (3, 4, 0)]);
        p1.add_line(0, vec![(0, 1, 1), (1, 5, 0)]);
        p1.add_line(0, vec![(0, 1, 2), (1, 6, 0)]);

        let mut p2 = LinePattern::new();
        p2.require(0, 1);
        p2.add_line(0, vec![(0, 1, 0), (1, 2, 0)]);
        p2.add_line(0, vec![(0, 1, 1)]);
        p2.add_line(0, vec![(0, 1, 2), (1, 6, 0)]);

        let mut p3 = LinePattern::new();
        p3.require(0, 1);
        p3.add_line(0, vec![(0, 1, 0)]);
        p3.add_line(0, vec![(0, 1, 1)]);
        p3.add_line(0, vec![(0, 1, 2)]);

        let builder: LineBuilder<_, _, _> = [p1, p2, p3].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 23);
    }

    #[test]
    fn test_build_empty() {
        let p1 = LinePattern::<usize, usize, usize>::new();

        let builder: LineBuilder<_, _, _> = [p1].into_iter().collect();
        let matcher = builder.build();
        assert_eq!(matcher.n_states(), 1);
    }
}