tree

README

Tree

A dumb implementation of a general (and sort of generic) tree data structure.

Documentation

Index

• type Node
  • func (node *Node) Add(value interface{}) *Node
  • func (node *Node) ForEachDFS(callback func(*Node))
  • func (node *Node) HasChildren() bool
  • func (node *Node) Remove()
  • func (node *Node) String() string
• type Tree
  • func Create(value interface{}) *Tree
  • func (tree *Tree) ForEachBSF(callback func(*Node))
  • func (tree *Tree) Size() int
  • func (tree *Tree) String() string

Types

type Node

type Node struct {
	Value    interface{}
	Parent   *Node
	Children []*Node
}

Node is the data structure which the tree is consists of

func (*Node) Add

func (node *Node) Add(value interface{}) *Node

Add adds a new node under the receiving node with the specified value

func (*Node) ForEachDFS

func (node *Node) ForEachDFS(callback func(*Node))

ForEachDFS runs callback for each node using depth-first-search

func (*Node) HasChildren

func (node *Node) HasChildren() bool

HasChildren returns true if node has any child nodes

func (*Node) Remove

func (node *Node) Remove()

Remove this node from the tree and all its descdendants

func (*Node) String

func (node *Node) String() string

type Tree

type Tree struct {
	Root *Node
}

Tree represent a tree structure and holds a reference to the root

func Create

func Create(value interface{}) *Tree

Create returns a new empty tree

func (*Tree) ForEachBSF

func (tree *Tree) ForEachBSF(callback func(*Node))

ForEachBSF iterates over this tree using breadth first search and calls callback for each node

func (*Tree) Size

func (tree *Tree) Size() int

Size returns the number of nodes in the tree, the root excluded

func (*Tree) String

func (tree *Tree) String() string

Implement the fmt.Stringer interface