Data.GraphViz

Defines the parameters used to convert a Graph into a DotRepr.

A value of type GraphvizParams n nl el cl l indicates that the Graph has a node type of n, node labels of type nl, edge labels of type el, corresponding clusters of type cl and after clustering the nodes have a label of type l (which may or may not be the same as nl).

The tuples in the function types represent labelled nodes (for (n,nl) and (n,l)) and labelled edges ((n,n,el); the value (f,t,ftl) is an edge from f to l with a label of ftl). These correspond to LNode and LEdge in FGL graphs.

The clustering in clusterBy can be to arbitrary depth.

Note that the term "cluster" is slightly conflated here: in terms of GraphvizParams values, a cluster is a grouping of nodes; the isDotCluster function lets you specify whether it is a cluster in the Dot sense or just a sub-graph.

Especially useful for quick explorations in ghci, this is a "do what I mean" set of parameters that prints the specified labels of a non-clustered graph.

A default GraphvizParams value which assumes the graph is directed, contains no clusters and has no Attributes set.

If you wish to have the labels of the nodes to have a different type after applying clusterBy from before clustering, then you will have to specify your own GraphvizParams value from scratch (or use blankParams).

If you use a custom clusterBy function (which if you actually want clusters you should) then you should also override the (nonsensical) default clusterID.

A variant of defaultParams that enforces that the clustering type is () (i.e.: no clustering); this avoids problems when using defaultParams internally within a function without any constraint on what the clustering type is.

A GraphvizParams value where every field is set to undefined. This is useful when you have a function that will set some of the values for you (e.g. setDirectedness) but you don't want to bother thinking of default values to set in the meantime. This is especially useful when you are programmatically setting the clustering function (and as such do not know what the types might be).

Determine if the provided Graph is directed or not and set the value of isDirected appropriately.

Define into which cluster a particular node belongs. Clusters can be nested to arbitrary depth.

An alias for NodeCluster when dealing with FGL graphs.

Convert a graph to Dot format, using the specified parameters to cluster the graph, etc.

As with graphToDot, but this allows you to easily convert other graph-like formats to a Dot graph as long as you can get a list of nodes and edges from it.

A pseudo-inverse to graphToDot; "pseudo" in the sense that the original node and edge labels aren't able to be reconstructed.

Run the appropriate Graphviz command on the graph to get positional information and then combine that information back into the original graph.

This is a "quick-and-dirty" graph augmentation function that sets no Attributes and thus should be referentially transparent and is wrapped in unsafePerformIO.

Note that the provided GraphvizParams is only used for isDirected, clusterBy and clusterID.

Used to augment an edge label with a unique identifier.

Add unique edge identifiers to each label. This is useful for when multiple edges between two nodes need to be distinguished.

Add a custom attribute to the list of attributes containing the value of the unique edge identifier.

Pass the DotRepr through the relevant command and then augment the Graph that it came from.

Use the Attributes in the provided DotGraph to augment the node and edge labels in the provided Graph. The unique identifiers on the edges are also stripped off.

Please note that the behaviour for this function is undefined if the DotGraph does not come from the original Graph (either by using a conversion function or by passing the result of a conversion function through a GraphvizCommand via the DotOutput or similar).