| Copyright | (c) Andrey Mokhov 2016-2022 | 
|---|---|
| License | MIT (see the file LICENSE) | 
| Maintainer | andrey.mokhov@gmail.com | 
| Stability | experimental | 
| Safe Haskell | None | 
| Language | Haskell2010 | 
Algebra.Graph.Relation
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 Relation data type, as well as associated
 operations and algorithms. Relation is an instance of the Graph type
 class, which can be used for polymorphic graph construction and manipulation.
Synopsis
- data Relation a
- domain :: Relation a -> Set a
- relation :: Relation a -> Set (a, a)
- empty :: Relation a
- vertex :: a -> Relation a
- edge :: Ord a => a -> a -> Relation a
- overlay :: Ord a => Relation a -> Relation a -> Relation a
- connect :: Ord a => Relation a -> Relation a -> Relation a
- vertices :: Ord a => [a] -> Relation a
- edges :: Ord a => [(a, a)] -> Relation a
- overlays :: Ord a => [Relation a] -> Relation a
- connects :: Ord a => [Relation a] -> Relation a
- isSubgraphOf :: Ord a => Relation a -> Relation a -> Bool
- isEmpty :: Relation a -> Bool
- hasVertex :: Ord a => a -> Relation a -> Bool
- hasEdge :: Ord a => a -> a -> Relation a -> Bool
- vertexCount :: Relation a -> Int
- edgeCount :: Relation a -> Int
- vertexList :: Relation a -> [a]
- edgeList :: Relation a -> [(a, a)]
- adjacencyList :: Eq a => Relation a -> [(a, [a])]
- vertexSet :: Relation a -> Set a
- edgeSet :: Relation a -> Set (a, a)
- preSet :: Ord a => a -> Relation a -> Set a
- postSet :: Ord a => a -> Relation a -> Set a
- path :: Ord a => [a] -> Relation a
- circuit :: Ord a => [a] -> Relation a
- clique :: Ord a => [a] -> Relation a
- biclique :: Ord a => [a] -> [a] -> Relation a
- star :: Ord a => a -> [a] -> Relation a
- stars :: Ord a => [(a, [a])] -> Relation a
- tree :: Ord a => Tree a -> Relation a
- forest :: Ord a => Forest a -> Relation a
- removeVertex :: Ord a => a -> Relation a -> Relation a
- removeEdge :: Ord a => a -> a -> Relation a -> Relation a
- replaceVertex :: Ord a => a -> a -> Relation a -> Relation a
- mergeVertices :: Ord a => (a -> Bool) -> a -> Relation a -> Relation a
- transpose :: Ord a => Relation a -> Relation a
- gmap :: Ord b => (a -> b) -> Relation a -> Relation b
- induce :: (a -> Bool) -> Relation a -> Relation a
- induceJust :: Ord a => Relation (Maybe a) -> Relation a
- compose :: Ord a => Relation a -> Relation a -> Relation a
- closure :: Ord a => Relation a -> Relation a
- reflexiveClosure :: Ord a => Relation a -> Relation a
- symmetricClosure :: Ord a => Relation a -> Relation a
- transitiveClosure :: Ord a => Relation a -> Relation a
- consistent :: Ord a => Relation a -> Bool
Data structure
The Relation data type represents a graph as a binary relation. We
define a Num instance as a convenient notation for working with graphs:
0 ==vertex0 1 + 2 ==overlay(vertex1) (vertex2) 1 * 2 ==connect(vertex1) (vertex2) 1 + 2 * 3 ==overlay(vertex1) (connect(vertex2) (vertex3)) 1 * (2 + 3) ==connect(vertex1) (overlay(vertex2) (vertex3))
Note: the Num instance does not satisfy several "customary laws" of Num,
which dictate that fromInteger 0 and fromInteger 1 should act as
additive and multiplicative identities, and negate as additive inverse.
Nevertheless, overloading fromInteger, + and * is very convenient when
working with algebraic graphs; we hope that in future Haskell's Prelude will
provide a more fine-grained class hierarchy for algebraic structures, which we
would be able to utilise without violating any laws.
The Show instance is defined using basic graph construction primitives:
show (empty :: Relation Int) == "empty" show (1 :: Relation Int) == "vertex 1" show (1 + 2 :: Relation Int) == "vertices [1,2]" show (1 * 2 :: Relation Int) == "edge 1 2" show (1 * 2 * 3 :: Relation Int) == "edges [(1,2),(1,3),(2,3)]" show (1 * 2 + 3 :: Relation Int) == "overlay (vertex 3) (edge 1 2)"
The Eq instance satisfies all axioms of algebraic graphs:
- overlayis commutative and associative:- x + y == y + x x + (y + z) == (x + y) + z 
- connectis associative and has- emptyas the identity:- x * empty == x empty * x == x x * (y * z) == (x * y) * z 
- connectdistributes over- overlay:- 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.
- overlayhas- emptyas the identity and is idempotent:- x + empty == x empty + x == x x + x == x
- Absorption 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 and m will denote the number of vertices and edges in the graph, respectively.
The total order on graphs is defined using size-lexicographic comparison:
- Compare the number of vertices. In case of a tie, continue.
- Compare the sets of vertices. In case of a tie, continue.
- Compare the number of edges. In case of a tie, continue.
- Compare the sets of edges.
Here are a few examples:
vertex1 <vertex2vertex3 <edge1 2vertex1 <edge1 1edge1 1 <edge1 2edge1 2 <edge1 1 +edge2 2edge1 2 <edge1 3
Note that the resulting order refines the
isSubgraphOf relation and is compatible with
overlay and connect operations:
isSubgraphOf x y ==> x <= yempty <= x
x     <= x + y
x + y <= x * yInstances
relation :: Relation a -> Set (a, a) Source #
The set of pairs of elements that are related. It is guaranteed that each element belongs to the domain. Complexity: O(1) time and memory.
Basic graph construction primitives
Construct the empty graph.
isEmptyempty == TruehasVertexx empty == FalsevertexCountempty == 0edgeCountempty == 0
vertex :: a -> Relation a Source #
Construct the graph comprising a single isolated vertex.
isEmpty(vertex x) == FalsehasVertexx (vertex y) == (x == y)vertexCount(vertex x) == 1edgeCount(vertex x) == 0
edge :: Ord a => a -> a -> Relation a Source #
Construct the graph comprising a single edge.
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 :: Ord a => Relation a -> Relation a -> Relation a Source #
Overlay two graphs. This is a commutative, associative and idempotent
 operation with the identity empty.
 Complexity: O((n + m) * log(n)) time and O(n + m) memory.
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 +edgeCountyvertexCount(overlay 1 2) == 2edgeCount(overlay 1 2) == 0
connect :: Ord a => Relation a -> Relation a -> Relation a Source #
Connect two graphs. This is an associative operation with the identity
 empty, which distributes over overlay and obeys the decomposition axiom.
 Complexity: O((n + m) * log(n)) time and O(n + m) memory. 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 +edgeCountyvertexCount(connect 1 2) == 2edgeCount(connect 1 2) == 1
vertices :: Ord a => [a] -> Relation a Source #
Construct the graph comprising a given list of isolated vertices. Complexity: O(L * log(L)) time and O(L) memory, where L is the length of the given list.
vertices [] ==emptyvertices [x] ==vertexx vertices ==overlays. mapvertexhasVertexx . vertices ==elemxvertexCount. vertices ==length.nubvertexSet. vertices == Set.fromList
Relations on graphs
isSubgraphOf :: Ord a => Relation a -> Relation a -> Bool Source #
The isSubgraphOf function takes two graphs and returns True if the
 first graph is a subgraph of the second.
 Complexity: O((n + m) * log(n)) time.
isSubgraphOfemptyx == True isSubgraphOf (vertexx)empty== False isSubgraphOf x (overlayx y) == True isSubgraphOf (overlayx y) (connectx y) == True isSubgraphOf (pathxs) (circuitxs) == True isSubgraphOf x y ==> x <= y
Graph properties
isEmpty :: Relation a -> Bool Source #
Check if a relation is empty. Complexity: O(1) time.
isEmptyempty== True isEmpty (overlayemptyempty) == True isEmpty (vertexx) == False isEmpty (removeVertexx $vertexx) == True isEmpty (removeEdgex y $edgex y) == False
hasVertex :: Ord a => a -> Relation a -> Bool Source #
Check if a graph contains a given vertex. Complexity: O(log(n)) time.
hasVertex xempty== False hasVertex x (vertexy) == (x == y) hasVertex x .removeVertexx ==constFalse
vertexCount :: Relation a -> Int Source #
The number of vertices in a graph. Complexity: O(1) time.
vertexCountempty== 0 vertexCount (vertexx) == 1 vertexCount ==length.vertexListvertexCount x < vertexCount y ==> x < y
vertexList :: Relation a -> [a] Source #
adjacencyList :: Eq a => Relation a -> [(a, [a])] Source #
preSet :: Ord a => a -> Relation a -> Set a Source #
The preset of an element x is the set of elements that are related to
 it on the left, i.e. preSet x == { a | aRx }. In the context of directed
 graphs, this corresponds to the set of direct predecessors of vertex x.
 Complexity: O(n + m) time and O(n) memory.
preSet xempty== Set.emptypreSet x (vertexx) == Set.emptypreSet 1 (edge1 2) == Set.emptypreSet y (edgex y) == Set.fromList[x]
postSet :: Ord a => a -> Relation a -> Set a Source #
The postset of an element x is the set of elements that are related to
 it on the right, i.e. postSet x == { a | xRa }. In the context of directed
 graphs, this corresponds to the set of direct successors of vertex x.
 Complexity: O(n + m) time and O(n) memory.
postSet xempty== Set.emptypostSet x (vertexx) == Set.emptypostSet x (edgex y) == Set.fromList[y] postSet 2 (edge1 2) == Set.empty
Standard families of graphs
stars :: Ord a => [(a, [a])] -> Relation a Source #
The stars formed by overlaying a list of stars. An inverse of
 adjacencyList.
 Complexity: O(L * log(n)) 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 :: Ord a => Tree a -> Relation a Source #
The tree graph constructed from a given Tree data structure.
 Complexity: O((n + m) * log(n)) time and O(n + m) memory.
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)]
Graph transformation
removeEdge :: Ord a => a -> a -> Relation a -> Relation a Source #
Remove an edge from a given graph. Complexity: O(log(m)) time.
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 * 2
replaceVertex :: Ord a => a -> a -> Relation a -> Relation a Source #
The function replaceVertex x yx with vertex y in a
 given AdjacencyMap. If y already exists, x and y will be merged.
 Complexity: O((n + m) * log(n)) time.
replaceVertex x x == id replaceVertex x y (vertexx) ==vertexy replaceVertex x y ==mergeVertices(== x) y
mergeVertices :: Ord a => (a -> Bool) -> a -> Relation a -> Relation a Source #
Merge vertices satisfying a given predicate into a given vertex. Complexity: O((n + m) * log(n)) time, assuming that the predicate takes constant time.
mergeVertices (constFalse) x == id mergeVertices (== x) y ==replaceVertexx y mergeVerticeseven1 (0 * 2) == 1 * 1 mergeVerticesodd1 (3 + 4 * 5) == 4 * 1
gmap :: Ord b => (a -> b) -> Relation a -> Relation b Source #
Transform a graph by applying a function to each of its vertices. This is
 similar to Functor's fmap but can be used with non-fully-parametric
 Relation.
 Complexity: O((n + m) * log(n)) time.
gmap fempty==emptygmap f (vertexx) ==vertex(f x) gmap f (edgex y) ==edge(f x) (f y) gmap id == id gmap f . gmap g == gmap (f . g)
induce :: (a -> Bool) -> Relation a -> Relation a Source #
Construct the induced subgraph of a given graph by removing the vertices that do not satisfy a given predicate. Complexity: O(n + m) time, assuming that the predicate takes constant time.
induce (constTrue ) x == x induce (constFalse) x ==emptyinduce (/= x) ==removeVertexx induce p . induce q == induce (\x -> p x && q x)isSubgraphOf(induce p x) x == True
Relational operations
compose :: Ord a => Relation a -> Relation a -> Relation a Source #
Left-to-right relational composition of graphs: vertices x and z are
 connected in the resulting graph if there is a vertex y, such that x is
 connected to y in the first graph, and y is connected to z in the
 second graph. There are no isolated vertices in the result. This operation is
 associative, has empty and single-vertex graphs as annihilating zeroes,
 and distributes over overlay.
 Complexity: O(n * m * log(m)) time and O(n + m) memory.
composeemptyx ==emptycompose xempty==emptycompose (vertexx) y ==emptycompose x (vertexy) ==emptycompose x (compose y z) == compose (compose x y) z compose x (overlayy z) ==overlay(compose x y) (compose x z) compose (overlayx y) z ==overlay(compose x z) (compose y z) compose (edgex y) (edgey z) ==edgex z compose (path[1..5]) (path[1..5]) ==edges[(1,3), (2,4), (3,5)] compose (circuit[1..5]) (circuit[1..5]) ==circuit[1,3,5,2,4]
closure :: Ord a => Relation a -> Relation a Source #
Compute the reflexive and transitive closure of a graph. Complexity: O(n * m * log(n) * log(m)) time.
closureempty==emptyclosure (vertexx) ==edgex x closure (edgex x) ==edgex x closure (edgex y) ==edges[(x,x), (x,y), (y,y)] closure (path$nubxs) ==reflexiveClosure(clique$nubxs) closure ==reflexiveClosure.transitiveClosureclosure ==transitiveClosure.reflexiveClosureclosure . closure == closurepostSetx (closure y) == Set.fromList(reachabley x)
transitiveClosure :: Ord a => Relation a -> Relation a Source #
Compute the transitive closure of a graph. Complexity: O(n * m * log(n) * log(m)) time.
transitiveClosureempty==emptytransitiveClosure (vertexx) ==vertexx transitiveClosure (edgex y) ==edgex y transitiveClosure (path$nubxs) ==clique(nubxs) transitiveClosure . transitiveClosure == transitiveClosure
Miscellaneous
consistent :: Ord a => Relation a -> Bool Source #
Check that the internal representation of a relation is consistent, i.e. if all
 pairs of elements in the relation refer to existing elements in the domain.
 It should be impossible to create an inconsistent Relation, and we use this
 function in testing.
consistentempty== True consistent (vertexx) == True consistent (overlayx y) == True consistent (connectx y) == True consistent (edgex y) == True consistent (edgesxs) == True consistent (starsxs) == True