dual-tree

Rose trees with cached and accumulating monoidal annotations

Version on this page:0.2.3.1
LTS Haskell 22.39:0.2.3.1@rev:3
Stackage Nightly 2024-10-31:0.2.3.1@rev:3
Latest on Hackage:0.2.3.1@rev:3

See all snapshots dual-tree appears in

BSD-3-Clause licensed by Brent Yorgey
Maintained by [email protected]
This version can be pinned in stack with:dual-tree-0.2.3.1@sha256:fdae62646fb4383a49b2d30862bb0824a06114b81fc74b65f3246c6ceb096006,2758

Module documentation for 0.2.3.1

Used by 2 packages in nightly-2022-12-12(full list with versions):
diagrams-core, diagrams-lib

Rose (n-ary) trees with both upwards- (i.e. cached) and downwards-traveling (i.e. accumulating) monoidal annotations. This is used as the core data structure underlying the diagrams framework (https://diagrams.github.io), but potentially has other applications as well.

Abstractly, a DUALTree is a rose (n-ary) tree with data (of type l) at leaves, data (of type a) at internal nodes, and two types of monoidal annotations, one (of type u) travelling "up" the tree and one (of type d) traveling "down".

See Data.Tree.DUAL for full documentation. Data.Tree.DUAL provides a public API which should suffice for most purposes. Data.Tree.DUAL.Internal exports more of the internal implementation---use it at your own risk.