Zora-1.1.23: Graphing library wrapper + assorted useful functions

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

Zora.Graphing.TreeGraphing

Description

Deprecated: Use Zora.Graphing.DAGGraphing instead

DEPRECATED; use Zora.Graphing.DAGGraphing instead
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 three very simple functions (example implementations below).

Synopsis

Documentation

class TreeGraphable g where Source

A typeclass for 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

value :: g a -> a Source

Gets the value contained in a node. For example,

value (Empty) = error "Empty nodes don't contain values."
value (Leaf x) = x
value (Node x _ _) = x

get_children :: g a -> [g a] Source

Gets the children of the current node. For example,

get_children (Empty) = error "Empty nodes don't have children."
get_children (Leaf _) = []
get_children (Node _ l r) = [l, r]

is_empty :: g a -> Bool Source

Returns whether a node is empty. Sometimes, when declaring algebraic data types, it is desirable to have an "Empty" value constructor. If your data type does not have an "Empty" value constructor, just always return False.

is_empty Empty = True
is_empty _ = False

graph :: (Show a, Ord a, TreeGraphable g) => g a -> IO String Source

Graphs the given TreeGraphable data type. Creates and writes to a file named "graph.png", overwriting any existing files with that name. You won't need to override this implementation.