Zora-1.1.17: Graphing library wrapper + assorted useful functions

Copyright(c) Brett Wines 2014
LicenseBSD-style
Maintainerbgwines@cs.stanford.edu
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell98

Zora.Graphing.DAGGraphing

Description

A typeclass with default implementation for graphing trees with Haskell GraphViz. It is intended to be extremely straightforward to graph your data type; you only need to define one simple function (example implementation below).

Synopsis

Documentation

class DAGGraphable g where Source

A typeclass for tree-like algebraic data types that are able to be graphed.

For these descriptions, assume the following example data type:

data Tree a = Empty | Leaf a | Node a (Tree a) (Tree a)

Methods

expand :: g -> Maybe (Maybe String, [(Maybe String, g)]) Source

Expands a node into its show_node and children. For example,

expand (Empty) = Nothing
expand (Leaf x) = Just (Just $ show x, [])
expand (Node x l r) = Just (Just $ show x, [("L child", l), ("R child", r)])

graph :: (Eq g, Show g, DAGGraphable g) => g -> IO String Source

Graphs the given DAGGraphable data type. Output is written to a file named "graph-i.dot", where i is the successor of the highest i-show_node of all existing "graph-i.dot" files in the current directory.You won't need to override this implementation.