File: GraphAlgorithms.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (103 lines) | stat: -rw-r--r-- 3,700 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
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

/// Compute the minimum distance from a source node to a destination in a graph.
///
/// This implementation is suitable for individual queries between two (close) nodes in a graph, but is sub-optimal for repeated numbers of queries in large graph.
///
/// - Returns: The distance (in number of edges) of the shortest path from the source to the destination, or nil if there is no such path.
public func minimumDistance<T: Hashable>(
    from source: T, to destination: T, successors: (T) throws -> [T]
) rethrows -> Int? {
    var queue = Queue([(distance: 0, source)])
    var visited = Set([source])

    while let (distance, node) = queue.popFirst() {
        // If this is the destination, we are done.
        if node == destination {
            return distance
        }

        // Otherwise, visit all of the successors in BFS order.
        let succs = try successors(node)
        for succ in succs {
            // If we have already seen this node, we don't need to traverse it.
            if !visited.insert(succ).inserted {
                continue
            }

            queue.append((distance: distance + 1, succ))
        }
    }

    return nil
}

/// Compute the shortest path from a source node to a destination in a graph.
///
/// This implementation is suitable for individual queries between two (close) nodes in a graph, but is sub-optimal for repeated numbers of queries in large graph.
///
/// - Returns: The shortest path (starting with the source and ending with the destination), or nil if there is no such path.
public func shortestPath<T: Hashable>(
    from source: T, to destination: T, successors: (T) throws -> [T]
) rethrows -> [T]? {
    var queue = Queue([[source]])
    var visited = Set([source])

    while let path = queue.popFirst() {
        // If the path ends at the destination, we are done.
        let node = path.last!
        if node == destination {
            return path
        }

        // Otherwise, visit all of the successors in BFS order.
        for succ in try successors(node) {
            // If we have already seen this node, we don't need to traverse it.
            if !visited.insert(succ).inserted {
                continue
            }

            queue.append(path + [succ])
        }
    }

    return nil
}

/// Compute the transitive closure of an input node set.
///
/// - Note: The relation is *not* assumed to be reflexive; i.e. the result will
///         not automatically include `nodes` unless present in the relation defined by
///         `successors`.
public func transitiveClosure<T>(
    _ nodes: [T], successors: (T) throws -> [T]
    ) rethrows -> (result: OrderedSet<T>, dupes: OrderedSet<T>) {
    var dupes = OrderedSet<T>()
    var result = OrderedSet<T>()

    // The queue of items to recursively visit.
    //
    // We add items post-collation to avoid unnecessary queue operations.
    var queue = nodes
    while let node = queue.popLast() {
        for succ in try successors(node) {
            if result.append(succ).inserted {
                queue.append(succ)
            } else {
                dupes.append(succ)
            }
        }
    }

    return (result, dupes)
}