File: DirectedGraph%2BTraversal.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (65 lines) | stat: -rw-r--r-- 2,321 bytes parent folder | download
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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2024 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

extension DirectedGraph {
    /// Returns a sequence that traverses the graph in breadth first order from a given element, without visiting the same node more than once.
    func breadthFirstSearch(from startingPoint: Node) -> some Sequence<Node> {
        IteratorSequence(GraphNodeIterator(from: startingPoint, traversal: .breadthFirst, in: self))
    }
    
    /// Returns a sequence that traverses the graph in depth first order from a given element, without visiting the same node more than once.
    func depthFirstSearch(from startingPoint: Node) -> some Sequence<Node> {
        IteratorSequence(GraphNodeIterator(from: startingPoint, traversal: .depthFirst, in: self))
    }
}

// MARK: Iterator

/// An iterator that traverses a graph in either breadth first or depth first order depending on the buffer it uses to track nodes to traverse next.
private struct GraphNodeIterator<Node: Hashable>: IteratorProtocol {
    enum Traversal {
        case breadthFirst, depthFirst
    }
    var traversal: Traversal
    var graph: DirectedGraph<Node>
    
    private var nodesToTraverse: [Node]
    private var seen: Set<Node>
    
    init(from startingPoint: Node, traversal: Traversal, in graph: DirectedGraph<Node>) {
        self.traversal = traversal
        self.graph = graph
        self.nodesToTraverse = [startingPoint]
        self.seen = []
    }
    
    private mutating func pop() -> Node? {
        guard !nodesToTraverse.isEmpty else { return nil }
        
        switch traversal {
        case .breadthFirst:
            return nodesToTraverse.removeFirst()
        case .depthFirst:
            return nodesToTraverse.removeLast()
        }
    }
    
    mutating func next() -> Node? {
        while let node = pop() {
            guard !seen.contains(node) else { continue }
            seen.insert(node)
            
            nodesToTraverse.append(contentsOf: graph.neighbors(of: node))
            
            return node
        }
        return nil
    }
}