| Copyright | (c) Andrey Mokhov 2016-2022 |
|---|---|
| License | MIT (see the file LICENSE) |
| Maintainer | [email protected] |
| Stability | unstable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Algebra.Graph.AdjacencyIntMap.Algorithm
Description
Alga is a library for algebraic construction and manipulation of graphs in Haskell. See this paper for the motivation behind the library, the underlying theory, and implementation details.
This module provides basic graph algorithms, such as depth-first search, implemented for the Algebra.Graph.AdjacencyIntMap data type.
Some of the worst-case complexities include the term min(n,W).
Following IntSet and IntMap, the W stands for
word size (usually 32 or 64 bits).
Synopsis
- bfsForest :: AdjacencyIntMap -> [Int] -> Forest Int
- bfs :: AdjacencyIntMap -> [Int] -> [[Int]]
- dfsForest :: AdjacencyIntMap -> Forest Int
- dfsForestFrom :: AdjacencyIntMap -> [Int] -> Forest Int
- dfs :: AdjacencyIntMap -> [Int] -> [Int]
- reachable :: AdjacencyIntMap -> Int -> [Int]
- topSort :: AdjacencyIntMap -> Either (Cycle Int) [Int]
- isAcyclic :: AdjacencyIntMap -> Bool
- isDfsForestOf :: Forest Int -> AdjacencyIntMap -> Bool
- isTopSortOf :: [Int] -> AdjacencyIntMap -> Bool
- type Cycle = NonEmpty
Algorithms
bfsForest :: AdjacencyIntMap -> [Int] -> Forest Int Source #
Compute the breadth-first search forest of a graph, such that adjacent vertices are explored in the increasing order. The search is seeded by a list of vertices that will become the roots of the resulting forest. Duplicates in the list will have their first occurrence explored and subsequent ones ignored. The seed vertices that do not belong to the graph are also ignored.
Complexity: O((L + m) * log n) time and O(n) space, where L is the number of seed vertices.
forest$ bfsForest (edge1 2) [0] ==emptyforest$ bfsForest (edge1 2) [1] ==edge1 2forest$ bfsForest (edge1 2) [2] ==vertex2forest$ bfsForest (edge1 2) [0,1,2] ==vertices[1,2]forest$ bfsForest (edge1 2) [2,1,0] ==vertices[1,2]forest$ bfsForest (edge1 1) [1] ==vertex1isSubgraphOf(forest$ bfsForest x vs) x == True bfsForest x (vertexListx) ==map(\v -> Node v []) (nub$vertexListx) bfsForest x [] == [] bfsForestemptyvs == [] bfsForest (3 * (1 + 4) * (1 + 5)) [1,4] == [ Node { rootLabel = 1 , subForest = [ Node { rootLabel = 5 , subForest = [] }]} , Node { rootLabel = 4 , subForest = [] }]forest$ bfsForest (circuit[1..5] +circuit[5,4..1]) [3] ==path[3,2,1] +path[3,4,5]
bfs :: AdjacencyIntMap -> [Int] -> [[Int]] Source #
A version of bfsForest where the resulting forest is converted to a level
structure. Adjacent vertices are explored in the increasing order. Flattening
the result via concat. bfsx gives an enumeration of reachable
vertices in the breadth-first search order.
Complexity: O((L + m) * min(n,W)) time and O(n) space, where L is the number of seed vertices.
bfs (edge1 2) [0] == [] bfs (edge1 2) [1] == [[1], [2]] bfs (edge1 2) [2] == [[2]] bfs (edge1 2) [1,2] == [[1,2]] bfs (edge1 2) [2,1] == [[2,1]] bfs (edge1 1) [1] == [[1]] bfsemptyvs == [] bfs x [] == [] bfs (1 * 2 + 3 * 4 + 5 * 6) [1,2] == [[1,2]] bfs (1 * 2 + 3 * 4 + 5 * 6) [1,3] == [[1,3], [2,4]] bfs (3 * (1 + 4) * (1 + 5)) [3] == [[3], [1,4,5]] bfs (circuit[1..5] +circuit[5,4..1]) [3] == [[2], [1,3], [5,4]]concat$ bfs (circuit[1..5] +circuit[5,4..1]) [3] == [3,2,4,1,5]mapconcat.transpose.maplevels.bfsForestx == bfs x
dfsForest :: AdjacencyIntMap -> Forest Int Source #
Compute the depth-first search forest of a graph, where adjacent vertices are explored in the increasing order.
Complexity: O((n + m) * min(n,W)) time and O(n) space.
forest$ dfsForestempty==emptyforest$ dfsForest (edge1 1) ==vertex1forest$ dfsForest (edge1 2) ==edge1 2forest$ dfsForest (edge2 1) ==vertices[1,2]isSubgraphOf(forest$ dfsForest x) x == TrueisDfsForestOf(dfsForest x) x == True dfsForest .forest. dfsForest == dfsForest dfsForest (verticesvs) ==map(\v -> Node v []) (nub$sortvs) dfsForest $ 3 * (1 + 4) * (1 + 5) == [ Node { rootLabel = 1 , subForest = [ Node { rootLabel = 5 , subForest = [] }]} , Node { rootLabel = 3 , subForest = [ Node { rootLabel = 4 , subForest = [] }]}]forest(dfsForest $circuit[1..5] +circuit[5,4..1]) ==path[1,2,3,4,5]
dfsForestFrom :: AdjacencyIntMap -> [Int] -> Forest Int Source #
Compute the depth-first search forest of a graph starting from the given seed vertices, where adjacent vertices are explored in the increasing order. Note that the resulting forest does not necessarily span the whole graph, as some vertices may be unreachable. The seed vertices which do not belong to the graph are ignored.
Complexity: O((L + m) * log n) time and O(n) space, where L is the number of seed vertices.
forest$ dfsForestFromemptyvs ==emptyforest$ dfsForestFrom (edge1 1) [1] ==vertex1forest$ dfsForestFrom (edge1 2) [0] ==emptyforest$ dfsForestFrom (edge1 2) [1] ==edge1 2forest$ dfsForestFrom (edge1 2) [2] ==vertex2forest$ dfsForestFrom (edge1 2) [1,2] ==edge1 2forest$ dfsForestFrom (edge1 2) [2,1] ==vertices[1,2]isSubgraphOf(forest$ dfsForestFrom x vs) x == TrueisDfsForestOf(dfsForestFrom x (vertexListx)) x == True dfsForestFrom x (vertexListx) ==dfsForestx dfsForestFrom x [] == [] dfsForestFrom (3 * (1 + 4) * (1 + 5)) [1,4] == [ Node { rootLabel = 1 , subForest = [ Node { rootLabel = 5 , subForest = [] } , Node { rootLabel = 4 , subForest = [] }]forest$ dfsForestFrom (circuit[1..5] +circuit[5,4..1]) [3] ==path[3,2,1,5,4]
dfs :: AdjacencyIntMap -> [Int] -> [Int] Source #
Return the list vertices visited by the depth-first search in a graph, starting from the given seed vertices. Adjacent vertices are explored in the increasing order.
Complexity: O((L + m) * log n) time and O(n) space, where L is the number of seed vertices.
dfsemptyvs == [] dfs (edge1 1) [1] == [1] dfs (edge1 2) [0] == [] dfs (edge1 2) [1] == [1,2] dfs (edge1 2) [2] == [2] dfs (edge1 2) [1,2] == [1,2] dfs (edge1 2) [2,1] == [2,1] dfs x [] == []and[hasVertexv x | v <- dfs x vs ] == True dfs (3 * (1 + 4) * (1 + 5)) [1,4] == [1,5,4] dfs (circuit[1..5] +circuit[5,4..1]) [3] == [3,2,1,5,4]
reachable :: AdjacencyIntMap -> Int -> [Int] Source #
Return the list of vertices reachable from a source vertex in a graph. The vertices in the resulting list appear in the depth-first search order.
Complexity: O(m * log n) time and O(n) space.
reachableemptyx == [] reachable (vertex1) 1 == [1] reachable (edge1 1) 1 == [1] reachable (edge1 2) 0 == [] reachable (edge1 2) 1 == [1,2] reachable (edge1 2) 2 == [2] reachable (path[1..8] ) 4 == [4..8] reachable (circuit[1..8] ) 4 == [4..8] ++ [1..3] reachable (clique[8,7..1]) 8 == [8] ++ [1..7]and[hasVertexv x | v <- reachable x y ] == True
topSort :: AdjacencyIntMap -> Either (Cycle Int) [Int] Source #
Compute a topological sort of a graph or discover a cycle.
Vertices are explored in the decreasing order according to their Ord
instance. This gives the lexicographically smallest topological ordering in
the case of success. In the case of failure, the cycle is characterized by
being the lexicographically smallest up to rotation with respect to
Ord (Dual Int) in the first connected component of the graph containing
a cycle, where the connected components are ordered by their largest vertex
with respect to Ord a.
Complexity: O((n + m) * min(n,W)) time and O(n) space.
topSort (1 * 2 + 3 * 1) == Right [3,1,2] topSort (path[1..5]) == Right [1..5] topSort (3 * (1 * 4 + 2 * 5)) == Right [3,1,2,4,5] topSort (1 * 2 + 2 * 1) == Left (2:|[1]) topSort (path[5,4..1] +edge2 4) == Left (4:|[3,2]) topSort (circuit[1..3]) == Left (3:|[1,2]) topSort (circuit[1..3] +circuit[3,2,1]) == Left (3:|[2]) topSort (1 * 2 + (5 + 2) * 1 + 3 * 4 * 3) == Left (1:|[2]) fmap (flipisTopSortOfx) (topSort x) /= Right False topSort .vertices== Right .nub.sort
isAcyclic :: AdjacencyIntMap -> Bool Source #
Correctness properties
isDfsForestOf :: Forest Int -> AdjacencyIntMap -> Bool Source #
Check if a given forest is a correct depth-first search forest of a graph. The implementation is based on the paper "Depth-First Search and Strong Connectivity in Coq" by François Pottier.
isDfsForestOf []empty== True isDfsForestOf [] (vertex1) == False isDfsForestOf [Node 1 []] (vertex1) == True isDfsForestOf [Node 1 []] (vertex2) == False isDfsForestOf [Node 1 [], Node 1 []] (vertex1) == False isDfsForestOf [Node 1 []] (edge1 1) == True isDfsForestOf [Node 1 []] (edge1 2) == False isDfsForestOf [Node 1 [], Node 2 []] (edge1 2) == False isDfsForestOf [Node 2 [], Node 1 []] (edge1 2) == True isDfsForestOf [Node 1 [Node 2 []]] (edge1 2) == True isDfsForestOf [Node 1 [], Node 2 []] (vertices[1,2]) == True isDfsForestOf [Node 2 [], Node 1 []] (vertices[1,2]) == True isDfsForestOf [Node 1 [Node 2 []]] (vertices[1,2]) == False isDfsForestOf [Node 1 [Node 2 [Node 3 []]]] (path[1,2,3]) == True isDfsForestOf [Node 1 [Node 3 [Node 2 []]]] (path[1,2,3]) == False isDfsForestOf [Node 3 [], Node 1 [Node 2 []]] (path[1,2,3]) == True isDfsForestOf [Node 2 [Node 3 []], Node 1 []] (path[1,2,3]) == True isDfsForestOf [Node 1 [], Node 2 [Node 3 []]] (path[1,2,3]) == False
isTopSortOf :: [Int] -> AdjacencyIntMap -> Bool Source #
Check if a given list of vertices is a correct topological sort of a graph.
isTopSortOf [3,1,2] (1 * 2 + 3 * 1) == True isTopSortOf [1,2,3] (1 * 2 + 3 * 1) == False isTopSortOf [] (1 * 2 + 3 * 1) == False isTopSortOf []empty== True isTopSortOf [x] (vertexx) == True isTopSortOf [x] (edgex x) == False