Debug.Trace.Tree.Edged

Edge-labelled rose trees

Intended to be double imported:

import Debug.Trace.Tree.Edged
import qualified Debug.Trace.Tree.Edged as Edged

Documentation

data ETree k v

Tree with nodes labelled with v and arrows labelled with k

Constructors

Node v (Assoc k (ETree k v))

Instances

Bifunctor ETree

Functor (ETree k)

Foldable (ETree k)

Traversable (ETree k)

(Eq k, Eq v) => Eq (ETree k v)

(Show k, Show v) => Show (ETree k v)

Standard operations

elems :: ETree k v -> [v]

keys :: ETree k v -> [k]

mapEdges :: (v -> v -> k -> k') -> ETree k v -> ETree k' v

Change the edges of the tree, providing source and target

Hiding nodes

class MatchAgainst v m where

Abstract definition of something we can match against a value

Methods

matchAgainst :: v -> m -> Bool

data NodeSpec v

Various ways we can specify a node

Constructors

NodeCoords Coords

Node at the specified coordinates

forall m . (MatchAgainst v m, Show m) => NodeMatch m

Match the value of the node

Instances

Show (NodeSpec v)

data Hide v

Specification of nodes to hide

Constructors

HideNode (NodeSpec v)

Hide the specified node

HideMax (Int, Int) (NodeSpec v)

Limit the range of children of the specified node

Instances

Show (Hide v)

hideNodes :: forall k v. [Hide v] -> ETree k (v, Metadata) -> ETree k (Maybe v, Metadata)

Annotation

type Depth = Int

Depth of a node in the tree

type Offset = Int

Offset of a node in the tree

This is the horizontal offset of a node across all nodes at that depth.

For example, the offsets of

    A
   / \
  B   C
 / \   \
D   E   F

are given by

      (A,0)
       / \
   (B,0)  (C,1)
    / \      \
(D,0)  (E,1)  (F,2)

Similarly, the offsets of

  A
 / \
B   C
   / \
  D   E

are given by

   (A,0)
    / \
(B,0) (C,1)
      /   \
  (D,0)   (E,1)

Note that in this second example, D gets number 0 because it's the first node at this level; it's therefore not the case that the nodes with number 0 necessarily make up the _spine_ of the tree.

data Coords

Coordinates of a node in the tree

Constructors

Coords

Fields

depth :: Depth

The "y coordinate" (depth in the tree)

offset :: Offset

The "x coordinate" (across all nodes at this depth)

Instances

Eq Coords

Ord Coords

Show Coords

data Metadata

Metadata of a node in the tree

Constructors

Metadata

Fields

isSpine :: Bool

nthChild :: Int

coords :: Coords

Instances

Eq Metadata

Ord Metadata

Show Metadata

isFirstChild :: Metadata -> Bool

annotate :: ETree k v -> ETree k (v, Metadata)

Interaction between ETree and Tree

pushEdges :: k -> ETree k v -> Tree (k, v)

Push each edge label to a subtree into the node of that subtree

Since there is no edge to the root of the tree, the "edge" to that root must be passed in as an argument.

pullEdges :: Tree (k, v) -> (k, ETree k v)

Inverse of pushEdges

liftTree :: (Tree (k, v) -> Tree ((k, v), b)) -> k -> ETree k v -> ETree k (v, b)

Lift an labelling function on trees to edged trees

liftTree' :: (forall a. Tree a -> Tree (a, b)) -> ETree k v -> ETree k (v, b)

Variation on liftTree for functions which don't need the edges