| Copyright | (c) Andrey Mokhov 2016-2018 |
|---|---|
| License | MIT (see the file LICENSE) |
| Maintainer | andrey.mokhov@gmail.com |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
Algebra.Graph
Contents
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 defines the core data type Graph and associated algorithms.
For graphs that are known to be non-empty at compile time, see
Algebra.Graph.NonEmpty. Graph is an instance of type classes defined in
modules Algebra.Graph.Class and Algebra.Graph.HigherKinded.Class, which
can be used for polymorphic graph construction and manipulation.
Synopsis
- data Graph a
- empty :: Graph a
- vertex :: a -> Graph a
- edge :: a -> a -> Graph a
- overlay :: Graph a -> Graph a -> Graph a
- connect :: Graph a -> Graph a -> Graph a
- vertices :: [a] -> Graph a
- edges :: [(a, a)] -> Graph a
- overlays :: [Graph a] -> Graph a
- connects :: [Graph a] -> Graph a
- foldg :: b -> (a -> b) -> (b -> b -> b) -> (b -> b -> b) -> Graph a -> b
- isSubgraphOf :: Ord a => Graph a -> Graph a -> Bool
- (===) :: Eq a => Graph a -> Graph a -> Bool
- isEmpty :: Graph a -> Bool
- size :: Graph a -> Int
- hasVertex :: Eq a => a -> Graph a -> Bool
- hasEdge :: Eq a => a -> a -> Graph a -> Bool
- vertexCount :: Ord a => Graph a -> Int
- edgeCount :: Ord a => Graph a -> Int
- vertexList :: Ord a => Graph a -> [a]
- edgeList :: Ord a => Graph a -> [(a, a)]
- vertexSet :: Ord a => Graph a -> Set a
- vertexIntSet :: Graph Int -> IntSet
- edgeSet :: Ord a => Graph a -> Set (a, a)
- adjacencyList :: Ord a => Graph a -> [(a, [a])]
- adjacencyMap :: Ord a => Graph a -> Map a (Set a)
- adjacencyIntMap :: Graph Int -> IntMap IntSet
- path :: [a] -> Graph a
- circuit :: [a] -> Graph a
- clique :: [a] -> Graph a
- biclique :: [a] -> [a] -> Graph a
- star :: a -> [a] -> Graph a
- stars :: [(a, [a])] -> Graph a
- tree :: Tree a -> Graph a
- forest :: Forest a -> Graph a
- mesh :: [a] -> [b] -> Graph (a, b)
- torus :: [a] -> [b] -> Graph (a, b)
- deBruijn :: Int -> [a] -> Graph [a]
- removeVertex :: Eq a => a -> Graph a -> Graph a
- removeEdge :: Eq a => a -> a -> Graph a -> Graph a
- replaceVertex :: Eq a => a -> a -> Graph a -> Graph a
- mergeVertices :: (a -> Bool) -> a -> Graph a -> Graph a
- splitVertex :: Eq a => a -> [a] -> Graph a -> Graph a
- transpose :: Graph a -> Graph a
- induce :: (a -> Bool) -> Graph a -> Graph a
- simplify :: Ord a => Graph a -> Graph a
- sparsify :: Graph a -> Graph (Either Int a)
- box :: Graph a -> Graph b -> Graph (a, b)
- data Context a = Context {}
- context :: (a -> Bool) -> Graph a -> Maybe (Context a)
Algebraic data type for graphs
The Graph data type is a deep embedding of the core graph construction
primitives empty, vertex, overlay and connect. We define a Num
instance as a convenient notation for working with graphs:
0 == Vertex 0 1 + 2 == Overlay (Vertex 1) (Vertex 2) 1 * 2 == Connect (Vertex 1) (Vertex 2) 1 + 2 * 3 == Overlay (Vertex 1) (Connect (Vertex 2) (Vertex 3)) 1 * (2 + 3) == Connect (Vertex 1) (Overlay (Vertex 2) (Vertex 3))
The Eq instance is currently implemented using the AdjacencyMap as the
canonical graph representation and satisfies all axioms of algebraic graphs:
overlayis commutative and associative:x + y == y + x x + (y + z) == (x + y) + z
connectis associative and hasemptyas the identity:x * empty == x empty * x == x x * (y * z) == (x * y) * z
connectdistributes overoverlay:x * (y + z) == x * y + x * z (x + y) * z == x * z + y * z
connectcan be decomposed:x * y * z == x * y + x * z + y * z
The following useful theorems can be proved from the above set of axioms.
overlayhasemptyas the identity and is idempotent:x + empty == x empty + x == x x + x == xAbsorption and saturation of
connect:x * y + x + y == x * y x * x * x == x * x
When specifying the time and memory complexity of graph algorithms, n will
denote the number of vertices in the graph, m will denote the number of
edges in the graph, and s will denote the size of the corresponding
Graph expression. For example, if g is a Graph then n, m and s can
be computed as follows:
n ==vertexCountg m ==edgeCountg s ==sizeg
Note that size is slightly different from the length method of the
Foldable type class, as the latter does not count empty leaves of the
expression:
lengthempty== 0sizeempty== 1length(vertexx) == 1size(vertexx) == 1length(empty+empty) == 0size(empty+empty) == 2
The size of any graph is positive, and the difference (
corresponds to the number of occurrences of size g - length g)empty in an expression g.
Converting a Graph to the corresponding AdjacencyMap takes O(s + m * log(m))
time and O(s + m) memory. This is also the complexity of the graph equality test,
because it is currently implemented by converting graph expressions to canonical
representations based on adjacency maps.
Instances
Basic graph construction primitives
edge :: a -> a -> Graph a Source #
Construct the graph comprising a single edge. Complexity: O(1) time, memory and size.
edge x y ==connect(vertexx) (vertexy)hasEdgex y (edge x y) == TrueedgeCount(edge x y) == 1vertexCount(edge 1 1) == 1vertexCount(edge 1 2) == 2
overlay :: Graph a -> Graph a -> Graph a Source #
Overlay two graphs. An alias for the constructor Overlay. This is a
commutative, associative and idempotent operation with the identity empty.
Complexity: O(1) time and memory, O(s1 + s2) size.
isEmpty(overlay x y) ==isEmptyx &&isEmptyyhasVertexz (overlay x y) ==hasVertexz x ||hasVertexz yvertexCount(overlay x y) >=vertexCountxvertexCount(overlay x y) <=vertexCountx +vertexCountyedgeCount(overlay x y) >=edgeCountxedgeCount(overlay x y) <=edgeCountx +edgeCountysize(overlay x y) ==sizex +sizeyvertexCount(overlay 1 2) == 2edgeCount(overlay 1 2) == 0
connect :: Graph a -> Graph a -> Graph a Source #
Connect two graphs. An alias for the constructor Connect. This is an
associative operation with the identity empty, which distributes over
overlay and obeys the decomposition axiom.
Complexity: O(1) time and memory, O(s1 + s2) size. Note that the number
of edges in the resulting graph is quadratic with respect to the number of
vertices of the arguments: m = O(m1 + m2 + n1 * n2).
isEmpty(connect x y) ==isEmptyx &&isEmptyyhasVertexz (connect x y) ==hasVertexz x ||hasVertexz yvertexCount(connect x y) >=vertexCountxvertexCount(connect x y) <=vertexCountx +vertexCountyedgeCount(connect x y) >=edgeCountxedgeCount(connect x y) >=edgeCountyedgeCount(connect x y) >=vertexCountx *vertexCountyedgeCount(connect x y) <=vertexCountx *vertexCounty +edgeCountx +edgeCountysize(connect x y) ==sizex +sizeyvertexCount(connect 1 2) == 2edgeCount(connect 1 2) == 1
vertices :: [a] -> Graph a Source #
Construct the graph comprising a given list of isolated vertices. Complexity: O(L) time, memory and size, where L is the length of the given list.
vertices [] ==emptyvertices [x] ==vertexxhasVertexx . vertices ==elemxvertexCount. vertices ==length.nubvertexSet. vertices == Set.fromList
overlays :: [Graph a] -> Graph a Source #
Overlay a given list of graphs. Complexity: O(L) time and memory, and O(S) size, where L is the length of the given list, and S is the sum of sizes of the graphs in the list.
overlays [] ==emptyoverlays [x] == x overlays [x,y] ==overlayx y overlays ==foldroverlayemptyisEmpty. overlays ==allisEmpty
connects :: [Graph a] -> Graph a Source #
Connect a given list of graphs. Complexity: O(L) time and memory, and O(S) size, where L is the length of the given list, and S is the sum of sizes of the graphs in the list.
connects [] ==emptyconnects [x] == x connects [x,y] ==connectx y connects ==foldrconnectemptyisEmpty. connects ==allisEmpty
Graph folding
foldg :: b -> (a -> b) -> (b -> b -> b) -> (b -> b -> b) -> Graph a -> b Source #
Generalised Graph folding: recursively collapse a Graph by applying
the provided functions to the leaves and internal nodes of the expression.
The order of arguments is: empty, vertex, overlay and connect.
Complexity: O(s) applications of given functions. As an example, the
complexity of size is O(s), since all functions have cost O(1).
foldgemptyvertexoverlayconnect== id foldgemptyvertexoverlay(flipconnect) ==transposefoldg [] return (++) (++) ==toListfoldg 0 (const 1) (+) (+) ==lengthfoldg 1 (const 1) (+) (+) ==sizefoldg True (const False) (&&) (&&) ==isEmpty
Relations on graphs
isSubgraphOf :: Ord a => Graph a -> Graph a -> Bool Source #
The isSubgraphOf function takes two graphs and returns True if the
first graph is a subgraph of the second.
Complexity: O(s + m * log(m)) time. Note that the number of edges m of a
graph can be quadratic with respect to the expression size s.
isSubgraphOfemptyx == True isSubgraphOf (vertexx)empty== False isSubgraphOf x (overlayx y) == True isSubgraphOf (overlayx y) (connectx y) == True isSubgraphOf (pathxs) (circuitxs) == True
(===) :: Eq a => Graph a -> Graph a -> Bool infix 4 Source #
Structural equality on graph expressions. Complexity: O(s) time.
x === x == True
x === x + empty == False
x + y === x + y == True
1 + 2 === 2 + 1 == False
x + y === x * y == False
Graph properties
isEmpty :: Graph a -> Bool Source #
Check if a graph is empty. A convenient alias for null.
Complexity: O(s) time.
isEmptyempty== True isEmpty (overlayemptyempty) == True isEmpty (vertexx) == False isEmpty (removeVertexx $vertexx) == True isEmpty (removeEdgex y $edgex y) == False
hasVertex :: Eq a => a -> Graph a -> Bool Source #
Check if a graph contains a given vertex. A convenient alias for elem.
Complexity: O(s) time.
hasVertex xempty== False hasVertex x (vertexx) == True hasVertex 1 (vertex2) == False hasVertex x .removeVertexx == const False
vertexCount :: Ord a => Graph a -> Int Source #
The number of vertices in a graph. Complexity: O(s * log(n)) time.
vertexCountempty== 0 vertexCount (vertexx) == 1 vertexCount ==length.vertexList
vertexList :: Ord a => Graph a -> [a] Source #
edgeList :: Ord a => Graph a -> [(a, a)] Source #
The sorted list of edges of a graph. Complexity: O(s + m * log(m)) time and O(m) memory. Note that the number of edges m of a graph can be quadratic with respect to the expression size s.
edgeListempty== [] edgeList (vertexx) == [] edgeList (edgex y) == [(x,y)] edgeList (star2 [3,1]) == [(2,1), (2,3)] edgeList .edges==nub.sortedgeList .transpose==sort. mapswap. edgeList
vertexIntSet :: Graph Int -> IntSet Source #
The set of vertices of a given graph. Like vertexSet but specialised for
graphs with vertices of type Int.
Complexity: O(s * log(n)) time and O(n) memory.
vertexIntSetempty== IntSet.emptyvertexIntSet .vertex== IntSet.singletonvertexIntSet .vertices== IntSet.fromListvertexIntSet .clique== IntSet.fromList
adjacencyList :: Ord a => Graph a -> [(a, [a])] Source #
adjacencyMap :: Ord a => Graph a -> Map a (Set a) Source #
The adjacency map of a graph: each vertex is associated with a set of its direct successors. Complexity: O(s + m * log(m)) time. Note that the number of edges m of a graph can be quadratic with respect to the expression size s.
adjacencyIntMap :: Graph Int -> IntMap IntSet Source #
Like adjacencyMap but specialised for graphs with vertices of type Int.
Standard families of graphs
clique :: [a] -> Graph a Source #
The clique on a list of vertices. Complexity: O(L) time, memory and size, where L is the length of the given list.
clique [] ==emptyclique [x] ==vertexx clique [x,y] ==edgex y clique [x,y,z] ==edges[(x,y), (x,z), (y,z)] clique (xs ++ ys) ==connect(clique xs) (clique ys) clique .reverse==transpose. clique
biclique :: [a] -> [a] -> Graph a Source #
The biclique on two lists of vertices. Complexity: O(L1 + L2) time, memory and size, where L1 and L2 are the lengths of the given lists.
biclique [] [] ==emptybiclique [x] [] ==vertexx biclique [] [y] ==vertexy biclique [x1,x2] [y1,y2] ==edges[(x1,y1), (x1,y2), (x2,y1), (x2,y2)] biclique xs ys ==connect(verticesxs) (verticesys)
stars :: [(a, [a])] -> Graph a Source #
The stars formed by overlaying a list of stars. An inverse of
adjacencyList.
Complexity: O(L) time, memory and size, where L is the total size of the
input.
stars [] ==emptystars [(x, [])] ==vertexx stars [(x, [y])] ==edgex y stars [(x, ys)] ==starx ys stars ==overlays. map (uncurrystar) stars .adjacencyList== idoverlay(stars xs) (stars ys) == stars (xs ++ ys)
tree :: Tree a -> Graph a Source #
The tree graph constructed from a given Tree data structure.
Complexity: O(T) time, memory and size, where T is the size of the
given tree (i.e. the number of vertices in the tree).
tree (Node x []) ==vertexx tree (Node x [Node y [Node z []]]) ==path[x,y,z] tree (Node x [Node y [], Node z []]) ==starx [y,z] tree (Node 1 [Node 2 [], Node 3 [Node 4 [], Node 5 []]]) ==edges[(1,2), (1,3), (3,4), (3,5)]
forest :: Forest a -> Graph a Source #
The forest graph constructed from a given Forest data structure.
Complexity: O(F) time, memory and size, where F is the size of the
given forest (i.e. the number of vertices in the forest).
forest [] ==emptyforest [x] ==treex forest [Node 1 [Node 2 [], Node 3 []], Node 4 [Node 5 []]] ==edges[(1,2), (1,3), (4,5)] forest ==overlays. maptree
mesh :: [a] -> [b] -> Graph (a, b) Source #
Construct a mesh graph from two lists of vertices. Complexity: O(L1 * L2) time, memory and size, where L1 and L2 are the lengths of the given lists.
mesh xs [] ==emptymesh [] ys ==emptymesh [x] [y] ==vertex(x, y) mesh xs ys ==box(pathxs) (pathys) mesh [1..3] "ab" ==edges[ ((1,'a'),(1,'b')), ((1,'a'),(2,'a')), ((1,'b'),(2,'b')), ((2,'a'),(2,'b')) , ((2,'a'),(3,'a')), ((2,'b'),(3,'b')), ((3,'a'),(3,'b')) ]
torus :: [a] -> [b] -> Graph (a, b) Source #
Construct a torus graph from two lists of vertices. Complexity: O(L1 * L2) time, memory and size, where L1 and L2 are the lengths of the given lists.
torus xs [] ==emptytorus [] ys ==emptytorus [x] [y] ==edge(x,y) (x,y) torus xs ys ==box(circuitxs) (circuitys) torus [1,2] "ab" ==edges[ ((1,'a'),(1,'b')), ((1,'a'),(2,'a')), ((1,'b'),(1,'a')), ((1,'b'),(2,'b')) , ((2,'a'),(1,'a')), ((2,'a'),(2,'b')), ((2,'b'),(1,'b')), ((2,'b'),(2,'a')) ]
deBruijn :: Int -> [a] -> Graph [a] Source #
Construct a De Bruijn graph of a given non-negative dimension using symbols from a given alphabet. Complexity: O(A^(D + 1)) time, memory and size, where A is the size of the alphabet and D is the dimension of the graph.
deBruijn 0 xs ==edge[] [] n > 0 ==> deBruijn n [] ==emptydeBruijn 1 [0,1] ==edges[ ([0],[0]), ([0],[1]), ([1],[0]), ([1],[1]) ] deBruijn 2 "0" ==edge"00" "00" deBruijn 2 "01" ==edges[ ("00","00"), ("00","01"), ("01","10"), ("01","11") , ("10","00"), ("10","01"), ("11","10"), ("11","11") ]transpose(deBruijn n xs) ==fmapreverse$ deBruijn n xsvertexCount(deBruijn n xs) == (length$nubxs)^n n > 0 ==>edgeCount(deBruijn n xs) == (length$nubxs)^(n + 1)
Graph transformation
removeEdge :: Eq a => a -> a -> Graph a -> Graph a Source #
Remove an edge from a given graph. Complexity: O(s) time, memory and size.
removeEdge x y (edgex y) ==vertices[x,y] removeEdge x y . removeEdge x y == removeEdge x y removeEdge x y .removeVertexx ==removeVertexx removeEdge 1 1 (1 * 1 * 2 * 2) == 1 * 2 * 2 removeEdge 1 2 (1 * 1 * 2 * 2) == 1 * 1 + 2 * 2size(removeEdge x y z) <= 3 *sizez
replaceVertex :: Eq a => a -> a -> Graph a -> Graph a Source #
The function replaces vertex replaceVertex x yx with vertex y in a
given Graph. If y already exists, x and y will be merged.
Complexity: O(s) time, memory and size.
replaceVertex x x == id replaceVertex x y (vertexx) ==vertexy replaceVertex x y ==mergeVertices(== x) y
mergeVertices :: (a -> Bool) -> a -> Graph a -> Graph a Source #
Merge vertices satisfying a given predicate into a given vertex. Complexity: O(s) time, memory and size, assuming that the predicate takes O(1) to be evaluated.
mergeVertices (const False) x == id
mergeVertices (== x) y == replaceVertex x y
mergeVertices even 1 (0 * 2) == 1 * 1
mergeVertices odd 1 (3 + 4 * 5) == 4 * 1
splitVertex :: Eq a => a -> [a] -> Graph a -> Graph a Source #
Split a vertex into a list of vertices with the same connectivity. Complexity: O(s + k * L) time, memory and size, where k is the number of occurrences of the vertex in the expression and L is the length of the given list.
splitVertex x [] ==removeVertexx splitVertex x [x] == id splitVertex x [y] ==replaceVertexx y splitVertex 1 [0,1] $ 1 * (2 + 3) == (0 + 1) * (2 + 3)
induce :: (a -> Bool) -> Graph a -> Graph a Source #
Construct the induced subgraph of a given graph by removing the vertices that do not satisfy a given predicate. Complexity: O(s) time, memory and size, assuming that the predicate takes O(1) to be evaluated.
induce (const True ) x == x induce (const False) x ==emptyinduce (/= x) ==removeVertexx induce p . induce q == induce (\x -> p x && q x)isSubgraphOf(induce p x) x == True
simplify :: Ord a => Graph a -> Graph a Source #
Simplify a graph expression. Semantically, this is the identity function, but it simplifies a given expression according to the laws of the algebra. The function does not compute the simplest possible expression, but uses heuristics to obtain useful simplifications in reasonable time. Complexity: the function performs O(s) graph comparisons. It is guaranteed that the size of the result does not exceed the size of the given expression.
simplify == idsize(simplify x) <=sizex simplifyempty===emptysimplify 1===1 simplify (1 + 1)===1 simplify (1 + 2 + 1)===1 + 2 simplify (1 * 1 * 1)===1 * 1
sparsify :: Graph a -> Graph (Either Int a) Source #
Sparsify a graph by adding intermediate Left Int vertices between the
original vertices (wrapping the latter in Right) such that the resulting
graph is sparse, i.e. contains only O(s) edges, but preserves the
reachability relation between the original vertices. Sparsification is useful
when working with dense graphs, as it can reduce the number of edges from
O(n^2) down to O(n) by replacing cliques, bicliques and similar densely
connected structures by sparse subgraphs built out of intermediate vertices.
Complexity: O(s) time, memory and size.
sort.reachablex ==sort.rights.reachable(Rightx) . sparsifyvertexCount(sparsify x) <=vertexCountx +sizex + 1edgeCount(sparsify x) <= 3 *sizexsize(sparsify x) <= 3 *sizex
Graph composition
box :: Graph a -> Graph b -> Graph (a, b) Source #
Compute the Cartesian product of graphs. Complexity: O(s1 * s2) time, memory and size, where s1 and s2 are the sizes of the given graphs.
box (path[0,1]) (path"ab") ==edges[ ((0,'a'), (0,'b')) , ((0,'a'), (1,'a')) , ((0,'b'), (1,'b')) , ((1,'a'), (1,'b')) ]
Up to an isomorphism between the resulting vertex types, this operation
is commutative, associative, distributes over overlay, has singleton
graphs as identities and empty as the annihilating zero. Below ~~
stands for the equality up to an isomorphism, e.g. (x, ()) ~~ x.
box x y ~~ box y x box x (box y z) ~~ box (box x y) z box x (overlayy z) ==overlay(box x y) (box x z) box x (vertex()) ~~ x box xempty~~emptytranspose(box x y) == box (transposex) (transposey)vertexCount(box x y) ==vertexCountx *vertexCountyedgeCount(box x y) <=vertexCountx *edgeCounty +edgeCountx *vertexCounty
Context
The context of a subgraph comprises the input and output vertices outside the subgraph that are connected to the vertices inside the subgraph.