Algebra.Graph.NonEmpty

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 data type NonEmptyGraph for graphs that are known to be non-empty at compile time. The naming convention generally follows that of Data.List.NonEmpty: we use suffix 1 to indicate the functions whose interface must be changed compared to Algebra.Graph, e.g. vertices1.

Algebraic data type for non-empty graphs

data NonEmptyGraph a

The NonEmptyGraph data type is a deep embedding of the core graph construction primitives vertex, overlay and connect. As one can guess from the name, the empty graph cannot be represented using this data type. See module Algebra.Graph for a graph data type that allows for the construction of the empty graph.

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))

Note that the signum method of the Num type class cannot be implemented.

The Eq instance is currently implemented using the AdjacencyMap as the canonical graph representation and satisfies the following laws of algebraic graphs:

• overlay is commutative, associative and idempotent:

        x + y == y + x
  x + (y + z) == (x + y) + z
        x + x == x

• connect is associative:

  x * (y * z) == (x * y) * z

• connect distributes over overlay:

  x * (y + z) == x * y + x * z
  (x + y) * z == x * z + y * z

• connect can be decomposed:

  x * y * z == x * y + x * z + y * z

• connect satisfies absorption and saturation:

  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 NonEmptyGraph expression, defined as the number of vertex leaves. For example, if g is a NonEmptyGraph then n, m and s can be computed as follows:

n == vertexCount g
m == edgeCount g
s == size g

The size of any graph is positive and coincides with the result of length method of the Foldable type class. We define size only for the consistency with the API of other graph representations, such as Algebra.Graph.

Converting a NonEmptyGraph 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.

Constructors

Vertex a

Overlay (NonEmptyGraph a) (NonEmptyGraph a)

Connect (NonEmptyGraph a) (NonEmptyGraph a)

Instances

Monad NonEmptyGraph

Defined in Algebra.Graph.NonEmpty

Methods

(>>=) :: NonEmptyGraph a -> (a -> NonEmptyGraph b) -> NonEmptyGraph b

(>>) :: NonEmptyGraph a -> NonEmptyGraph b -> NonEmptyGraph b

return :: a -> NonEmptyGraph a

fail :: String -> NonEmptyGraph a

Functor NonEmptyGraph

Defined in Algebra.Graph.NonEmpty

Methods

fmap :: (a -> b) -> NonEmptyGraph a -> NonEmptyGraph b

(<$) :: a -> NonEmptyGraph b -> NonEmptyGraph a

Applicative NonEmptyGraph

Defined in Algebra.Graph.NonEmpty

Methods

pure :: a -> NonEmptyGraph a

(<*>) :: NonEmptyGraph (a -> b) -> NonEmptyGraph a -> NonEmptyGraph b

liftA2 :: (a -> b -> c) -> NonEmptyGraph a -> NonEmptyGraph b -> NonEmptyGraph c

(*>) :: NonEmptyGraph a -> NonEmptyGraph b -> NonEmptyGraph b

(<*) :: NonEmptyGraph a -> NonEmptyGraph b -> NonEmptyGraph a

Foldable NonEmptyGraph

Defined in Algebra.Graph.NonEmpty

Methods

fold :: Monoid m => NonEmptyGraph m -> m

foldMap :: Monoid m => (a -> m) -> NonEmptyGraph a -> m

foldr :: (a -> b -> b) -> b -> NonEmptyGraph a -> b

foldr' :: (a -> b -> b) -> b -> NonEmptyGraph a -> b

foldl :: (b -> a -> b) -> b -> NonEmptyGraph a -> b

foldl' :: (b -> a -> b) -> b -> NonEmptyGraph a -> b

foldr1 :: (a -> a -> a) -> NonEmptyGraph a -> a

foldl1 :: (a -> a -> a) -> NonEmptyGraph a -> a

toList :: NonEmptyGraph a -> [a]

null :: NonEmptyGraph a -> Bool

length :: NonEmptyGraph a -> Int

elem :: Eq a => a -> NonEmptyGraph a -> Bool

maximum :: Ord a => NonEmptyGraph a -> a

minimum :: Ord a => NonEmptyGraph a -> a

sum :: Num a => NonEmptyGraph a -> a

product :: Num a => NonEmptyGraph a -> a

Traversable NonEmptyGraph

Defined in Algebra.Graph.NonEmpty

Methods

traverse :: Applicative f => (a -> f b) -> NonEmptyGraph a -> f (NonEmptyGraph b)

sequenceA :: Applicative f => NonEmptyGraph (f a) -> f (NonEmptyGraph a)

mapM :: Monad m => (a -> m b) -> NonEmptyGraph a -> m (NonEmptyGraph b)

sequence :: Monad m => NonEmptyGraph (m a) -> m (NonEmptyGraph a)

Ord a => Eq (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

Methods

(==) :: NonEmptyGraph a -> NonEmptyGraph a -> Bool

(/=) :: NonEmptyGraph a -> NonEmptyGraph a -> Bool

Num a => Num (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

Methods

(+) :: NonEmptyGraph a -> NonEmptyGraph a -> NonEmptyGraph a

(-) :: NonEmptyGraph a -> NonEmptyGraph a -> NonEmptyGraph a

(*) :: NonEmptyGraph a -> NonEmptyGraph a -> NonEmptyGraph a

negate :: NonEmptyGraph a -> NonEmptyGraph a

abs :: NonEmptyGraph a -> NonEmptyGraph a

signum :: NonEmptyGraph a -> NonEmptyGraph a

fromInteger :: Integer -> NonEmptyGraph a

Show a => Show (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

Methods

showsPrec :: Int -> NonEmptyGraph a -> ShowS

show :: NonEmptyGraph a -> String

showList :: [NonEmptyGraph a] -> ShowS

NFData a => NFData (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

Methods

rnf :: NonEmptyGraph a -> ()

ToGraph (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

Associated Types

type ToVertex (NonEmptyGraph a) :: *

Methods

toGraph :: NonEmptyGraph a -> Graph (ToVertex (NonEmptyGraph a))

foldg :: r -> (ToVertex (NonEmptyGraph a) -> r) -> (r -> r -> r) -> (r -> r -> r) -> NonEmptyGraph a -> r

isEmpty :: NonEmptyGraph a -> Bool

size :: NonEmptyGraph a -> Int

hasVertex :: ToVertex (NonEmptyGraph a) -> NonEmptyGraph a -> Bool

hasEdge :: ToVertex (NonEmptyGraph a) -> ToVertex (NonEmptyGraph a) -> NonEmptyGraph a -> Bool

vertexCount :: NonEmptyGraph a -> Int

edgeCount :: NonEmptyGraph a -> Int

vertexList :: NonEmptyGraph a -> [ToVertex (NonEmptyGraph a)]

edgeList :: NonEmptyGraph a -> [(ToVertex (NonEmptyGraph a), ToVertex (NonEmptyGraph a))]

vertexSet :: NonEmptyGraph a -> Set (ToVertex (NonEmptyGraph a))

vertexIntSet :: NonEmptyGraph a -> IntSet

edgeSet :: NonEmptyGraph a -> Set (ToVertex (NonEmptyGraph a), ToVertex (NonEmptyGraph a))

preSet :: ToVertex (NonEmptyGraph a) -> NonEmptyGraph a -> Set (ToVertex (NonEmptyGraph a))

preIntSet :: Int -> NonEmptyGraph a -> IntSet

postSet :: ToVertex (NonEmptyGraph a) -> NonEmptyGraph a -> Set (ToVertex (NonEmptyGraph a))

postIntSet :: Int -> NonEmptyGraph a -> IntSet

adjacencyList :: NonEmptyGraph a -> [(ToVertex (NonEmptyGraph a), [ToVertex (NonEmptyGraph a)])]

adjacencyMap :: NonEmptyGraph a -> Map (ToVertex (NonEmptyGraph a)) (Set (ToVertex (NonEmptyGraph a)))

adjacencyIntMap :: NonEmptyGraph a -> IntMap IntSet

adjacencyMapTranspose :: NonEmptyGraph a -> Map (ToVertex (NonEmptyGraph a)) (Set (ToVertex (NonEmptyGraph a)))

adjacencyIntMapTranspose :: NonEmptyGraph a -> IntMap IntSet

dfsForest :: NonEmptyGraph a -> Forest (ToVertex (NonEmptyGraph a))

dfsForestFrom :: [ToVertex (NonEmptyGraph a)] -> NonEmptyGraph a -> Forest (ToVertex (NonEmptyGraph a))

dfs :: [ToVertex (NonEmptyGraph a)] -> NonEmptyGraph a -> [ToVertex (NonEmptyGraph a)]

reachable :: ToVertex (NonEmptyGraph a) -> NonEmptyGraph a -> [ToVertex (NonEmptyGraph a)]

topSort :: NonEmptyGraph a -> Maybe [ToVertex (NonEmptyGraph a)]

isAcyclic :: NonEmptyGraph a -> Bool

toAdjacencyMap :: NonEmptyGraph a -> AdjacencyMap (ToVertex (NonEmptyGraph a))

toAdjacencyMapTranspose :: NonEmptyGraph a -> AdjacencyMap (ToVertex (NonEmptyGraph a))

toAdjacencyIntMap :: NonEmptyGraph a -> AdjacencyIntMap

toAdjacencyIntMapTranspose :: NonEmptyGraph a -> AdjacencyIntMap

isDfsForestOf :: Forest (ToVertex (NonEmptyGraph a)) -> NonEmptyGraph a -> Bool

isTopSortOf :: [ToVertex (NonEmptyGraph a)] -> NonEmptyGraph a -> Bool

type ToVertex (NonEmptyGraph a)

Defined in Algebra.Graph.NonEmpty

type ToVertex (NonEmptyGraph a) = a

toNonEmptyGraph :: Graph a -> Maybe (NonEmptyGraph a)

Convert a Graph into NonEmptyGraph. Returns Nothing if the argument is empty. Complexity: O(s) time, memory and size.

toNonEmptyGraph empty       == Nothing
toNonEmptyGraph (toGraph x) == Just (x :: NonEmptyGraph a)

Basic graph construction primitives

vertex :: a -> NonEmptyGraph a

Construct the graph comprising a single isolated vertex. An alias for the constructor Vertex. Complexity: O(1) time, memory and size.

hasVertex x (vertex x) == True
vertexCount (vertex x) == 1
edgeCount   (vertex x) == 0
size        (vertex x) == 1

edge :: a -> a -> NonEmptyGraph a

Construct the graph comprising a single edge. Complexity: O(1) time, memory and size.

edge x y               == connect (vertex x) (vertex y)
hasEdge x y (edge x y) == True
edgeCount   (edge x y) == 1
vertexCount (edge 1 1) == 1
vertexCount (edge 1 2) == 2

overlay :: NonEmptyGraph a -> NonEmptyGraph a -> NonEmptyGraph a

Overlay two graphs. An alias for the constructor Overlay. This is a commutative, associative and idempotent operation. Complexity: O(1) time and memory, O(s1 + s2) size.

hasVertex z (overlay x y) == hasVertex z x || hasVertex z y
vertexCount (overlay x y) >= vertexCount x
vertexCount (overlay x y) <= vertexCount x + vertexCount y
edgeCount   (overlay x y) >= edgeCount x
edgeCount   (overlay x y) <= edgeCount x   + edgeCount y
size        (overlay x y) == size x        + size y
vertexCount (overlay 1 2) == 2
edgeCount   (overlay 1 2) == 0

overlay1 :: Graph a -> NonEmptyGraph a -> NonEmptyGraph a

Overlay a possibly empty graph with a non-empty graph. If the first argument is empty, the function returns the second argument; otherwise it is semantically the same as overlay. Complexity: O(s1) time and memory, and O(s1 + s2) size.

               overlay1 empty x == x
x /= empty ==> overlay1 x     y == overlay (fromJust $ toNonEmptyGraph x) y

connect :: NonEmptyGraph a -> NonEmptyGraph a -> NonEmptyGraph a

Connect two graphs. An alias for the constructor Connect. This is an associative operation, 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).

hasVertex z (connect x y) == hasVertex z x || hasVertex z y
vertexCount (connect x y) >= vertexCount x
vertexCount (connect x y) <= vertexCount x + vertexCount y
edgeCount   (connect x y) >= edgeCount x
edgeCount   (connect x y) >= edgeCount y
edgeCount   (connect x y) >= vertexCount x * vertexCount y
edgeCount   (connect x y) <= vertexCount x * vertexCount y + edgeCount x + edgeCount y
size        (connect x y) == size x        + size y
vertexCount (connect 1 2) == 2
edgeCount   (connect 1 2) == 1

vertices1 :: NonEmpty a -> NonEmptyGraph a

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.

vertices1 (x :| [])     == vertex x
hasVertex x . vertices1 == elem x
vertexCount . vertices1 == length . nub
vertexSet   . vertices1 == Set.fromList . toList

edges1 :: NonEmpty (a, a) -> NonEmptyGraph a

Construct the graph from a list of edges. Complexity: O(L) time, memory and size, where L is the length of the given list.

edges1 ((x,y) :| []) == edge x y
edgeCount . edges1   == length . nub

overlays1 :: NonEmpty (NonEmptyGraph a) -> NonEmptyGraph a

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.

overlays1 (x :| [] ) == x
overlays1 (x :| [y]) == overlay x y

connects1 :: NonEmpty (NonEmptyGraph a) -> NonEmptyGraph a

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.

connects1 (x :| [] ) == x
connects1 (x :| [y]) == connect x y

Graph folding

foldg1 :: (a -> b) -> (b -> b -> b) -> (b -> b -> b) -> NonEmptyGraph a -> b

Generalised graph folding: recursively collapse a NonEmptyGraph by applying the provided functions to the leaves and internal nodes of the expression. The order of arguments is: 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).

foldg1 (const 1) (+)  (+)  == size
foldg1 (==x)     (||) (||) == hasVertex x

Relations on graphs

isSubgraphOf :: Ord a => NonEmptyGraph a -> NonEmptyGraph a -> Bool

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.

isSubgraphOf x             (overlay x y) == True
isSubgraphOf (overlay x y) (connect x y) == True
isSubgraphOf (path1 xs)    (circuit1 xs) == True

(===) :: Eq a => NonEmptyGraph a -> NonEmptyGraph a -> Bool infix 4

Structural equality on graph expressions. Complexity: O(s) time.

    x === x     == True
x + y === x + y == True
1 + 2 === 2 + 1 == False
x + y === x * y == False

Graph properties

size :: NonEmptyGraph a -> Int

The size of a graph, i.e. the number of leaves of the expression. Complexity: O(s) time.

size (vertex x)    == 1
size (overlay x y) == size x + size y
size (connect x y) == size x + size y
size x             >= 1
size x             >= vertexCount x

hasVertex :: Eq a => a -> NonEmptyGraph a -> Bool

Check if a graph contains a given vertex. A convenient alias for elem. Complexity: O(s) time.

hasVertex x (vertex x) == True
hasVertex 1 (vertex 2) == False

hasEdge :: Eq a => a -> a -> NonEmptyGraph a -> Bool

Check if a graph contains a given edge. Complexity: O(s) time.

hasEdge x y (vertex z)       == False
hasEdge x y (edge x y)       == True
hasEdge x y . removeEdge x y == const False
hasEdge x y                  == elem (x,y) . edgeList

vertexCount :: Ord a => NonEmptyGraph a -> Int

The number of vertices in a graph. Complexity: O(s * log(n)) time.

vertexCount (vertex x) == 1
vertexCount x          >= 1
vertexCount            == length . vertexList1

edgeCount :: Ord a => NonEmptyGraph a -> Int

The number of edges in a graph. 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.

edgeCount (vertex x) == 0
edgeCount (edge x y) == 1
edgeCount            == length . edgeList

vertexList1 :: Ord a => NonEmptyGraph a -> NonEmpty a

The sorted list of vertices of a given graph. Complexity: O(s * log(n)) time and O(n) memory.

vertexList1 (vertex x)  == x :| []
vertexList1 . vertices1 == nub . sort

edgeList :: Ord a => NonEmptyGraph a -> [(a, a)]

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.

edgeList (vertex x)     == []
edgeList (edge x y)     == [(x,y)]
edgeList (star 2 [3,1]) == [(2,1), (2,3)]
edgeList . edges1       == nub . sort . toList
edgeList . transpose    == sort . map swap . edgeList

vertexSet :: Ord a => NonEmptyGraph a -> Set a

The set of vertices of a given graph. Complexity: O(s * log(n)) time and O(n) memory.

vertexSet . vertex    == Set.singleton
vertexSet . vertices1 == Set.fromList . toList
vertexSet . clique1   == Set.fromList . toList

vertexIntSet :: NonEmptyGraph Int -> IntSet

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.

vertexIntSet . vertex    == IntSet.singleton
vertexIntSet . vertices1 == IntSet.fromList . toList
vertexIntSet . clique1   == IntSet.fromList . toList

edgeSet :: Ord a => NonEmptyGraph a -> Set (a, a)

The set of edges of a given graph. Complexity: O(s * log(m)) time and O(m) memory.

edgeSet (vertex x) == Set.empty
edgeSet (edge x y) == Set.singleton (x,y)
edgeSet . edges1   == Set.fromList . toList

Standard families of graphs

path1 :: NonEmpty a -> NonEmptyGraph a

The path on a list of vertices. Complexity: O(L) time, memory and size, where L is the length of the given list.

path1 (x :| [] ) == vertex x
path1 (x :| [y]) == edge x y
path1 . reverse  == transpose . path1

circuit1 :: NonEmpty a -> NonEmptyGraph a

The circuit on a list of vertices. Complexity: O(L) time, memory and size, where L is the length of the given list.

circuit1 (x :| [] ) == edge x x
circuit1 (x :| [y]) == edges1 ((x,y) :| [(y,x)])
circuit1 . reverse  == transpose . circuit1

clique1 :: NonEmpty a -> NonEmptyGraph a

The clique on a list of vertices. Complexity: O(L) time, memory and size, where L is the length of the given list.

clique1 (x :| []   ) == vertex x
clique1 (x :| [y]  ) == edge x y
clique1 (x :| [y,z]) == edges1 ((x,y) :| [(x,z), (y,z)])
clique1 (xs <> ys)   == connect (clique1 xs) (clique1 ys)
clique1 . reverse    == transpose . clique1

biclique1 :: NonEmpty a -> NonEmpty a -> NonEmptyGraph a

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.

biclique1 (x1 :| [x2]) (y1 :| [y2]) == edges1 ((x1,y1) :| [(x1,y2), (x2,y1), (x2,y2)])
biclique1 xs            ys          == connect (vertices1 xs) (vertices1 ys)

star :: a -> [a] -> NonEmptyGraph a

The star formed by a centre vertex connected to a list of leaves. Complexity: O(L) time, memory and size, where L is the length of the given list.

star x []    == vertex x
star x [y]   == edge x y
star x [y,z] == edges1 ((x,y) :| [(x,z)])

stars1 :: NonEmpty (a, [a]) -> NonEmptyGraph a

The stars formed by overlaying a non-empty list of stars. Complexity: O(L) time, memory and size, where L is the total size of the input.

stars1 ((x, [])  :| [])         == vertex x
stars1 ((x, [y]) :| [])         == edge x y
stars1 ((x, ys)  :| [])         == star x ys
stars1                          == overlays1 . fmap (uncurry star)
overlay (stars1 xs) (stars1 ys) == stars1 (xs <> ys)

tree :: Tree a -> NonEmptyGraph a

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 [])                                         == vertex x
tree (Node x [Node y [Node z []]])                       == path1 (x :| [y,z])
tree (Node x [Node y [], Node z []])                     == star x [y,z]
tree (Node 1 [Node 2 [], Node 3 [Node 4 [], Node 5 []]]) == edges1 ((1,2) :| [(1,3), (3,4), (3,5)])

mesh1 :: NonEmpty a -> NonEmpty b -> NonEmptyGraph (a, b)

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.

mesh1 (x :| [])    (y :| [])    == vertex (x, y)
mesh1 xs           ys           == box (path1 xs) (path1 ys)
mesh1 (1 :| [2,3]) ('a' :| "b") == edges1 (fromList [ ((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')) ])

torus1 :: NonEmpty a -> NonEmpty b -> NonEmptyGraph (a, b)

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.

torus1 (x :| [])  (y :| [])    == edge (x,y) (x,y)
torus1 xs         ys           == box (circuit1 xs) (circuit1 ys)
torus1 (1 :| [2]) ('a' :| "b") == edges1 (fromList [ ((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')) ])

Graph transformation

removeVertex1 :: Eq a => a -> NonEmptyGraph a -> Maybe (NonEmptyGraph a)

Remove a vertex from a given graph. Returns Nothing if the resulting graph is empty. Complexity: O(s) time, memory and size.

removeVertex1 x (vertex x)          == Nothing
removeVertex1 1 (vertex 2)          == Just (vertex 2)
removeVertex1 x (edge x x)          == Nothing
removeVertex1 1 (edge 1 2)          == Just (vertex 2)
removeVertex1 x >=> removeVertex1 x == removeVertex1 x

removeEdge :: Eq a => a -> a -> NonEmptyGraph a -> NonEmptyGraph a

Remove an edge from a given graph. Complexity: O(s) time, memory and size.

removeEdge x y (edge x y)       == vertices1 (x :| [y])
removeEdge x y . removeEdge x y == removeEdge x y
removeEdge 1 1 (1 * 1 * 2 * 2)  == 1 * 2 * 2
removeEdge 1 2 (1 * 1 * 2 * 2)  == 1 * 1 + 2 * 2
size (removeEdge x y z)         <= 3 * size z

replaceVertex :: Eq a => a -> a -> NonEmptyGraph a -> NonEmptyGraph a

The function replaceVertex x y replaces vertex x with vertex y in a given NonEmptyGraph. If y already exists, x and y will be merged. Complexity: O(s) time, memory and size.

replaceVertex x x            == id
replaceVertex x y (vertex x) == vertex y
replaceVertex x y            == mergeVertices (== x) y

mergeVertices :: (a -> Bool) -> a -> NonEmptyGraph a -> NonEmptyGraph a

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

splitVertex1 :: Eq a => a -> NonEmpty a -> NonEmptyGraph a -> NonEmptyGraph a

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.

splitVertex1 x (x :| [] )               == id
splitVertex1 x (y :| [] )               == replaceVertex x y
splitVertex1 1 (0 :| [1]) $ 1 * (2 + 3) == (0 + 1) * (2 + 3)

transpose :: NonEmptyGraph a -> NonEmptyGraph a

Transpose a given graph. Complexity: O(s) time, memory and size.

transpose (vertex x)  == vertex x
transpose (edge x y)  == edge y x
transpose . transpose == id
transpose (box x y)   == box (transpose x) (transpose y)
edgeList . transpose  == sort . map swap . edgeList

induce1 :: (a -> Bool) -> NonEmptyGraph a -> Maybe (NonEmptyGraph a)

Construct the induced subgraph of a given graph by removing the vertices that do not satisfy a given predicate. Returns Nothing if the resulting graph is empty. Complexity: O(s) time, memory and size, assuming that the predicate takes O(1) to be evaluated.

induce1 (const True ) x == Just x
induce1 (const False) x == Nothing
induce1 (/= x)          == removeVertex1 x
induce1 p >=> induce1 q == induce1 (\x -> p x && q x)

simplify :: Ord a => NonEmptyGraph a -> NonEmptyGraph a

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              == id
size (simplify x)     <= size x
simplify 1           === 1
simplify (1 + 1)     === 1
simplify (1 + 2 + 1) === 1 + 2
simplify (1 * 1 * 1) === 1 * 1

sparsify :: NonEmptyGraph a -> NonEmptyGraph (Either Int a)

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 . reachable x       == sort . rights . reachable (Right x) . sparsify
vertexCount (sparsify x) <= vertexCount x + size x + 1
edgeCount   (sparsify x) <= 3 * size x
size        (sparsify x) <= 3 * size x

Graph composition

box :: NonEmptyGraph a -> NonEmptyGraph b -> NonEmptyGraph (a, b)

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 (path1 $ fromList [0,1]) (path1 $ fromList "ab") == edges1 (fromList [ ((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, and has singleton graphs as identities. 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 (overlay y z)   == overlay (box x y) (box x z)
box x (vertex ())     ~~ x
transpose   (box x y) == box (transpose x) (transpose y)
vertexCount (box x y) == vertexCount x * vertexCount y
edgeCount   (box x y) <= vertexCount x * edgeCount y + edgeCount x * vertexCount y