graph

Documentation

Index

• type CyclicError
  • func (c *CyclicError[T]) Error() string
• type Graph
  • func NewGraph[T comparable](root *Node[T]) *Graph[T]
  • func NewGraphOf[T comparable](root *Node[T], item string) *Graph[T]
  • func (g *Graph[T]) AddChild(parentID string, childID string) error
  • func (g *Graph[T]) AddEdge(fromID string, toID string) error
  • func (g *Graph[T]) Clone() *Graph[T]
  • func (g *Graph[T]) GetNextLeaf(start *Node[T]) *Node[T]
  • func (g *Graph[T]) InsertNodeAt(parentID string, id string, data T) (*Node[T], error)
  • func (g *Graph[T]) NextFromTop() *Node[T]
  • func (g *Graph[T]) RemoveNode(id string) error
  • func (g *Graph[T]) RemoveSubGraph(id string) error
• type Node
  • func NewNode[T comparable](id string, data T) *Node[T]

Types

type CyclicError

type CyclicError[T comparable] struct {
	What string
	// contains filtered or unexported fields
}

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

func (*CyclicError[T]) Error

func (c *CyclicError[T]) Error() string

Error implements error interface

type Graph

type Graph[T comparable] struct {
	Nodes map[string]*Node[T]
	Root  *Node[T]
	// contains filtered or unexported fields
}

func NewGraph

func NewGraph[T comparable](root *Node[T]) *Graph[T]

func NewGraphOf

func NewGraphOf[T comparable](root *Node[T], item string) *Graph[T]

func (*Graph[T]) AddChild

func (g *Graph[T]) AddChild(parentID string, childID string) error

func (*Graph[T]) AddEdge

func (g *Graph[T]) 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[T]) Clone

func (g *Graph[T]) Clone() *Graph[T]

Clone returns a cloned graph

func (*Graph[T]) GetNextLeaf

func (g *Graph[T]) GetNextLeaf(start *Node[T]) *Node[T]

GetNextLeaf returns the next leaf in the graph from node start

func (*Graph[T]) InsertNodeAt

func (g *Graph[T]) InsertNodeAt(parentID string, id string, data T) (*Node[T], error)

InsertNodeAt inserts a new node at the given parent position

func (*Graph[T]) NextFromTop

func (g *Graph[T]) NextFromTop() *Node[T]

func (*Graph[T]) RemoveNode

func (g *Graph[T]) RemoveNode(id string) error

RemoveNode removes a node with no children in the graph

func (*Graph[T]) RemoveSubGraph

func (g *Graph[T]) RemoveSubGraph(id string) error

type Node

type Node[T comparable] struct {
	ID   string
	Data T

	Parents []*Node[T]
	Childs  []*Node[T]

	Done bool
}

Node is a node in a graph

func NewNode

func NewNode[T comparable](id string, data T) *Node[T]