graph

Documentation

Index

• type CyclicError
  • func (c *CyclicError) Error() string
• type Graph
  • func NewGraph(root *Node) *Graph
  • func NewGraphOf(root *Node, item string) *Graph
  • func (g *Graph) AddEdge(fromID string, toID string) error
  • func (g *Graph) Clone() *Graph
  • func (g *Graph) GetNextLeaf(start *Node) *Node
  • func (g *Graph) InsertNodeAt(parentID string, id string, data interface{}) (*Node, error)
  • func (g *Graph) RemoveNode(id string) error
• type Node
  • func NewNode(id string, data interface{}) *Node

Types

type CyclicError

type CyclicError struct {
	What string
	// contains filtered or unexported fields
}

CyclicError is the type that is returned if a cyclic edge would be inserted

func (*CyclicError) Error

func (c *CyclicError) Error() string

Error implements error interface

type Graph

type Graph struct {
	Nodes map[string]*Node

	Root *Node
	// contains filtered or unexported fields
}

func NewGraph

func NewGraph(root *Node) *Graph

func NewGraphOf

func NewGraphOf(root *Node, item string) *Graph

func (*Graph) AddEdge

func (g *Graph) AddEdge(fromID string, toID string) error

AddEdge adds a new edge from a node to a node and returns an error if it would result in a cyclic graph

func (*Graph) Clone

func (g *Graph) Clone() *Graph

Clone returns a cloned graph

func (*Graph) GetNextLeaf

func (g *Graph) GetNextLeaf(start *Node) *Node

GetNextLeaf returns the next leaf in the graph from node start

func (*Graph) InsertNodeAt

func (g *Graph) InsertNodeAt(parentID string, id string, data interface{}) (*Node, error)

InsertNodeAt inserts a new node at the given parent position

func (*Graph) RemoveNode

func (g *Graph) RemoveNode(id string) error

RemoveNode removes a node with no children in the graph

type Node

type Node struct {
	ID   string
	Data interface{}

	Parents []*Node
	Childs  []*Node
}

Node is a node in a graph

func NewNode

func NewNode(id string, data interface{}) *Node