sz-orm-graph 5.1.0

Graph database support for sz-orm: Neo4j Cypher query, typed mapping, declarative modeling
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
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
//! 图算法(Graph Algorithms)
//!
//! 提供常用图算法:BFS/DFS 遍历、Dijkstra 最短路径、拓扑排序、
//! 环检测、连通分量等。基于邻接表表示的图。

use std::collections::{HashMap, HashSet, VecDeque};

/// 图节点 ID 类型
pub type NodeId = u64;

/// 边权重类型
pub type Weight = f64;

/// 有向图
///
/// 使用邻接表表示,支持带权边。
#[derive(Debug, Clone, Default)]
pub struct DirectedGraph {
    /// 邻接表:节点 -> [(邻居, 权重)]
    adjacency: HashMap<NodeId, Vec<(NodeId, Weight)>>,
    /// 节点数(含孤立节点)
    node_count: usize,
}

impl DirectedGraph {
    /// 创建空图
    pub fn new() -> Self {
        Self::default()
    }

    /// 添加节点
    pub fn add_node(&mut self, node: NodeId) {
        if let std::collections::hash_map::Entry::Vacant(e) = self.adjacency.entry(node) {
            e.insert(Vec::new());
            self.node_count += 1;
        }
    }

    /// 添加带权有向边
    pub fn add_edge(&mut self, from: NodeId, to: NodeId, weight: Weight) {
        self.add_node(from);
        self.add_node(to);
        self.adjacency.get_mut(&from).unwrap().push((to, weight));
    }

    /// 添加无权有向边(权重=1.0)
    pub fn add_edge_unweighted(&mut self, from: NodeId, to: NodeId) {
        self.add_edge(from, to, 1.0);
    }

    /// 获取节点的邻居
    pub fn neighbors(&self, node: NodeId) -> Option<&Vec<(NodeId, Weight)>> {
        self.adjacency.get(&node)
    }

    /// 所有节点
    pub fn nodes(&self) -> impl Iterator<Item = NodeId> + '_ {
        self.adjacency.keys().copied()
    }

    /// 节点数
    pub fn node_count(&self) -> usize {
        self.node_count
    }

    /// 边数
    pub fn edge_count(&self) -> usize {
        self.adjacency.values().map(|v| v.len()).sum()
    }

    /// 是否包含节点
    pub fn has_node(&self, node: NodeId) -> bool {
        self.adjacency.contains_key(&node)
    }

    /// 是否包含边
    pub fn has_edge(&self, from: NodeId, to: NodeId) -> bool {
        self.adjacency
            .get(&from)
            .map(|v| v.iter().any(|(n, _)| *n == to))
            .unwrap_or(false)
    }

    /// 获取边权重
    pub fn edge_weight(&self, from: NodeId, to: NodeId) -> Option<Weight> {
        self.adjacency
            .get(&from)
            .and_then(|v| v.iter().find(|(n, _)| *n == to).map(|(_, w)| *w))
    }

    /// 广度优先搜索(BFS)
    ///
    /// 从 `start` 出发,返回按 BFS 顺序访问的节点列表。
    pub fn bfs(&self, start: NodeId) -> Vec<NodeId> {
        if !self.has_node(start) {
            return Vec::new();
        }
        let mut visited = HashSet::new();
        let mut queue = VecDeque::new();
        let mut result = Vec::new();
        visited.insert(start);
        queue.push_back(start);
        while let Some(node) = queue.pop_front() {
            result.push(node);
            if let Some(neighbors) = self.neighbors(node) {
                for &(neighbor, _) in neighbors {
                    if visited.insert(neighbor) {
                        queue.push_back(neighbor);
                    }
                }
            }
        }
        result
    }

    /// 深度优先搜索(DFS)
    ///
    /// 从 `start` 出发,返回按 DFS 顺序访问的节点列表。
    pub fn dfs(&self, start: NodeId) -> Vec<NodeId> {
        if !self.has_node(start) {
            return Vec::new();
        }
        let mut visited = HashSet::new();
        let mut result = Vec::new();
        self.dfs_visit(start, &mut visited, &mut result);
        result
    }

    fn dfs_visit(&self, node: NodeId, visited: &mut HashSet<NodeId>, result: &mut Vec<NodeId>) {
        if !visited.insert(node) {
            return;
        }
        result.push(node);
        if let Some(neighbors) = self.neighbors(node) {
            for &(neighbor, _) in neighbors {
                self.dfs_visit(neighbor, visited, result);
            }
        }
    }

    /// Dijkstra 最短路径算法
    ///
    /// 返回从 `start` 到 `end` 的最短路径和总距离。
    /// 如果不可达返回 None。
    pub fn dijkstra(&self, start: NodeId, end: NodeId) -> Option<(Vec<NodeId>, Weight)> {
        if !self.has_node(start) || !self.has_node(end) {
            return None;
        }
        let mut dist: HashMap<NodeId, Weight> = HashMap::new();
        let mut prev: HashMap<NodeId, NodeId> = HashMap::new();
        let mut visited = HashSet::new();
        for &node in self.adjacency.keys() {
            dist.insert(node, Weight::INFINITY);
        }
        dist.insert(start, 0.0);
        while visited.len() < self.node_count {
            let current = {
                let mut best: Option<(NodeId, Weight)> = None;
                for (&node, &d) in dist.iter() {
                    if !visited.contains(&node) && (best.is_none() || d < best.unwrap().1) {
                        best = Some((node, d));
                    }
                }
                best
            };
            match current {
                None => break,
                Some((node, d)) => {
                    if d == Weight::INFINITY {
                        break;
                    }
                    if node == end {
                        let mut path = vec![end];
                        let mut current = end;
                        while let Some(&p) = prev.get(&current) {
                            path.push(p);
                            current = p;
                        }
                        path.reverse();
                        return Some((path, d));
                    }
                    visited.insert(node);
                    if let Some(neighbors) = self.neighbors(node) {
                        for &(neighbor, weight) in neighbors {
                            if visited.contains(&neighbor) {
                                continue;
                            }
                            let alt = d + weight;
                            if alt < dist[&neighbor] {
                                dist.insert(neighbor, alt);
                                prev.insert(neighbor, node);
                            }
                        }
                    }
                }
            }
        }
        None
    }

    /// 拓扑排序(Kahn 算法)
    ///
    /// 返回拓扑排序结果。如果图有环返回 None。
    pub fn topological_sort(&self) -> Option<Vec<NodeId>> {
        let mut in_degree: HashMap<NodeId, usize> = HashMap::new();
        for &node in self.adjacency.keys() {
            in_degree.entry(node).or_insert(0);
        }
        for neighbors in self.adjacency.values() {
            for &(neighbor, _) in neighbors {
                *in_degree.entry(neighbor).or_insert(0) += 1;
            }
        }
        let mut queue: VecDeque<NodeId> = in_degree
            .iter()
            .filter(|(_, &deg)| deg == 0)
            .map(|(&n, _)| n)
            .collect();
        let mut result = Vec::new();
        while let Some(node) = queue.pop_front() {
            result.push(node);
            if let Some(neighbors) = self.neighbors(node) {
                for &(neighbor, _) in neighbors {
                    if let Some(deg) = in_degree.get_mut(&neighbor) {
                        *deg -= 1;
                        if *deg == 0 {
                            queue.push_back(neighbor);
                        }
                    }
                }
            }
        }
        if result.len() == self.node_count {
            Some(result)
        } else {
            None
        }
    }

    /// 环检测(DFS)
    ///
    /// 检测图中是否存在环。
    pub fn has_cycle(&self) -> bool {
        let mut visited = HashSet::new();
        let mut rec_stack = HashSet::new();
        for &node in self.adjacency.keys() {
            if !visited.contains(&node) && self.has_cycle_dfs(node, &mut visited, &mut rec_stack) {
                return true;
            }
        }
        false
    }

    fn has_cycle_dfs(
        &self,
        node: NodeId,
        visited: &mut HashSet<NodeId>,
        rec_stack: &mut HashSet<NodeId>,
    ) -> bool {
        visited.insert(node);
        rec_stack.insert(node);
        if let Some(neighbors) = self.neighbors(node) {
            for &(neighbor, _) in neighbors {
                if !visited.contains(&neighbor) {
                    if self.has_cycle_dfs(neighbor, visited, rec_stack) {
                        return true;
                    }
                } else if rec_stack.contains(&neighbor) {
                    return true;
                }
            }
        }
        rec_stack.remove(&node);
        false
    }

    /// 连通分量(弱连通)
    ///
    /// 返回每个连通分量的节点列表。
    pub fn connected_components(&self) -> Vec<Vec<NodeId>> {
        let undirected = self.to_undirected();
        let mut visited = HashSet::new();
        let mut components = Vec::new();
        for &node in undirected.adjacency.keys() {
            if !visited.contains(&node) {
                let component = undirected.bfs(node);
                visited.extend(component.iter().copied());
                components.push(component);
            }
        }
        components
    }

    /// 转为无向图(忽略方向)
    fn to_undirected(&self) -> DirectedGraph {
        let mut undirected = DirectedGraph::new();
        for (&node, neighbors) in &self.adjacency {
            undirected.add_node(node);
            for &(neighbor, weight) in neighbors {
                undirected.add_edge(node, neighbor, weight);
                undirected.add_edge(neighbor, node, weight);
            }
        }
        undirected
    }

    /// 反转图(所有边方向取反)
    pub fn reverse(&self) -> DirectedGraph {
        let mut reversed = DirectedGraph::new();
        for (&node, neighbors) in &self.adjacency {
            reversed.add_node(node);
            for &(neighbor, weight) in neighbors {
                reversed.add_edge(neighbor, node, weight);
            }
        }
        reversed
    }

    /// 节点的入度
    pub fn in_degree(&self, node: NodeId) -> usize {
        self.adjacency
            .values()
            .map(|v| v.iter().filter(|(n, _)| *n == node).count())
            .sum()
    }

    /// 节点的出度
    pub fn out_degree(&self, node: NodeId) -> usize {
        self.adjacency.get(&node).map(|v| v.len()).unwrap_or(0)
    }
}

/// 无向图
#[derive(Debug, Clone, Default)]
pub struct UndirectedGraph {
    inner: DirectedGraph,
}

impl UndirectedGraph {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add_node(&mut self, node: NodeId) {
        self.inner.add_node(node);
    }

    pub fn add_edge(&mut self, from: NodeId, to: NodeId, weight: Weight) {
        self.inner.add_edge(from, to, weight);
        self.inner.add_edge(to, from, weight);
    }

    pub fn add_edge_unweighted(&mut self, from: NodeId, to: NodeId) {
        self.add_edge(from, to, 1.0);
    }

    pub fn node_count(&self) -> usize {
        self.inner.node_count()
    }

    pub fn edge_count(&self) -> usize {
        self.inner.edge_count() / 2
    }

    pub fn bfs(&self, start: NodeId) -> Vec<NodeId> {
        self.inner.bfs(start)
    }

    pub fn dfs(&self, start: NodeId) -> Vec<NodeId> {
        self.inner.dfs(start)
    }

    pub fn connected_components(&self) -> Vec<Vec<NodeId>> {
        self.inner.connected_components()
    }

    pub fn has_node(&self, node: NodeId) -> bool {
        self.inner.has_node(node)
    }

    pub fn has_edge(&self, from: NodeId, to: NodeId) -> bool {
        self.inner.has_edge(from, to)
    }

    pub fn degree(&self, node: NodeId) -> usize {
        self.inner.out_degree(node)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_directed_graph_new() {
        let g = DirectedGraph::new();
        assert_eq!(g.node_count(), 0);
        assert_eq!(g.edge_count(), 0);
    }

    #[test]
    fn test_add_node() {
        let mut g = DirectedGraph::new();
        g.add_node(1);
        assert_eq!(g.node_count(), 1);
        assert!(g.has_node(1));
    }

    #[test]
    fn test_add_edge() {
        let mut g = DirectedGraph::new();
        g.add_edge(1, 2, 3.15);
        assert_eq!(g.node_count(), 2);
        assert_eq!(g.edge_count(), 1);
        assert!(g.has_edge(1, 2));
        assert!(!g.has_edge(2, 1));
        assert_eq!(g.edge_weight(1, 2), Some(3.15));
    }

    #[test]
    fn test_add_edge_unweighted() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        assert_eq!(g.edge_weight(1, 2), Some(1.0));
    }

    #[test]
    fn test_bfs_simple() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(1, 3);
        g.add_edge_unweighted(2, 4);
        g.add_edge_unweighted(3, 4);
        let bfs = g.bfs(1);
        assert_eq!(bfs[0], 1);
        assert_eq!(bfs.len(), 4);
        assert!(bfs.contains(&4));
    }

    #[test]
    fn test_bfs_disconnected() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_node(3);
        let bfs = g.bfs(1);
        assert_eq!(bfs.len(), 2);
        assert!(!bfs.contains(&3));
    }

    #[test]
    fn test_bfs_nonexistent_start() {
        let g = DirectedGraph::new();
        assert!(g.bfs(1).is_empty());
    }

    #[test]
    fn test_dfs_simple() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        g.add_edge_unweighted(3, 4);
        let dfs = g.dfs(1);
        assert_eq!(dfs.len(), 4);
        assert_eq!(dfs[0], 1);
    }

    #[test]
    fn test_dfs_nonexistent_start() {
        let g = DirectedGraph::new();
        assert!(g.dfs(1).is_empty());
    }

    #[test]
    fn test_dijkstra_shortest_path() {
        let mut g = DirectedGraph::new();
        g.add_edge(1, 2, 1.0);
        g.add_edge(2, 3, 2.0);
        g.add_edge(1, 3, 5.0);
        let (path, dist) = g.dijkstra(1, 3).unwrap();
        assert_eq!(path, vec![1, 2, 3]);
        assert!((dist - 3.0).abs() < 0.001);
    }

    #[test]
    fn test_dijkstra_direct_edge() {
        let mut g = DirectedGraph::new();
        g.add_edge(1, 2, 5.0);
        let (path, dist) = g.dijkstra(1, 2).unwrap();
        assert_eq!(path, vec![1, 2]);
        assert!((dist - 5.0).abs() < 0.001);
    }

    #[test]
    fn test_dijkstra_unreachable() {
        let mut g = DirectedGraph::new();
        g.add_edge(1, 2, 1.0);
        g.add_node(3);
        assert!(g.dijkstra(1, 3).is_none());
    }

    #[test]
    fn test_dijkstra_same_node() {
        let mut g = DirectedGraph::new();
        g.add_node(1);
        let (path, dist) = g.dijkstra(1, 1).unwrap();
        assert_eq!(path, vec![1]);
        assert!((dist - 0.0).abs() < 0.001);
    }

    #[test]
    fn test_topological_sort_dag() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(1, 3);
        g.add_edge_unweighted(2, 4);
        g.add_edge_unweighted(3, 4);
        let topo = g.topological_sort().unwrap();
        assert_eq!(topo.len(), 4);
        let pos: HashMap<NodeId, usize> = topo.iter().enumerate().map(|(i, &n)| (n, i)).collect();
        assert!(pos[&1] < pos[&2]);
        assert!(pos[&1] < pos[&3]);
        assert!(pos[&2] < pos[&4]);
        assert!(pos[&3] < pos[&4]);
    }

    #[test]
    fn test_topological_sort_with_cycle() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        g.add_edge_unweighted(3, 1);
        assert!(g.topological_sort().is_none());
    }

    #[test]
    fn test_has_cycle_no_cycle() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        assert!(!g.has_cycle());
    }

    #[test]
    fn test_has_cycle_with_cycle() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        g.add_edge_unweighted(3, 1);
        assert!(g.has_cycle());
    }

    #[test]
    fn test_has_cycle_self_loop() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 1);
        assert!(g.has_cycle());
    }

    #[test]
    fn test_connected_components() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(3, 4);
        g.add_node(5);
        let components = g.connected_components();
        assert_eq!(components.len(), 3);
    }

    #[test]
    fn test_connected_components_single() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        let components = g.connected_components();
        assert_eq!(components.len(), 1);
    }

    #[test]
    fn test_reverse() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        let reversed = g.reverse();
        assert!(reversed.has_edge(2, 1));
        assert!(reversed.has_edge(3, 2));
        assert!(!reversed.has_edge(1, 2));
    }

    #[test]
    fn test_in_degree() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 3);
        g.add_edge_unweighted(2, 3);
        assert_eq!(g.in_degree(3), 2);
        assert_eq!(g.in_degree(1), 0);
    }

    #[test]
    fn test_out_degree() {
        let mut g = DirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(1, 3);
        assert_eq!(g.out_degree(1), 2);
        assert_eq!(g.out_degree(2), 0);
    }

    #[test]
    fn test_undirected_graph() {
        let mut g = UndirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        assert_eq!(g.node_count(), 3);
        assert_eq!(g.edge_count(), 2);
        assert!(g.has_edge(1, 2));
        assert!(g.has_edge(2, 1));
    }

    #[test]
    fn test_undirected_connected_components() {
        let mut g = UndirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(3, 4);
        let components = g.connected_components();
        assert_eq!(components.len(), 2);
    }

    #[test]
    fn test_undirected_degree() {
        let mut g = UndirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(1, 3);
        assert_eq!(g.degree(1), 2);
    }

    #[test]
    fn test_undirected_bfs() {
        let mut g = UndirectedGraph::new();
        g.add_edge_unweighted(1, 2);
        g.add_edge_unweighted(2, 3);
        let bfs = g.bfs(1);
        assert_eq!(bfs.len(), 3);
    }
}