dag

package

v1.21.0 Latest Latest Go to latest Published: Jun 5, 2023 License: Apache-2.0 Imports: 3 Imported by: 1

Details

This section is empty.

This section is empty.

This section is empty.

type CycleError[Key comparable] struct {
	Keys []Key
}

CycleError is an error if the Graph had a cycle.

func (c *CycleError[Key]) Error() string

Error implements error.

type Graph[Key comparable] struct {
	// contains filtered or unexported fields
}

Graph is a directed acyclic graph structure with comparable keys.

func NewGraph[Key comparable]() *Graph[Key]

NewGraph returns a new Graph.

Graphs can also safely be instantiated with &Graph{}.

func (g *Graph[Key]) AddEdge(from Key, to Key)

AddEdge adds an edge.

func (g *Graph[Key]) AddNode(key Key)

AddNode adds a node.

func (g *Graph[Key]) ContainsNode(key Key) bool

ContainsNode returns true if the graph contains the given node.

func (g *Graph[Key]) ForEachEdge(start Key, f func(Key, Key) error) error

ForEachEdge visits each edge in the Graph starting at the given key.

Returns a *CycleError if there is a cycle in the graph.

func (g *Graph[Key]) TopoSort(start Key) ([]Key, error)

TopoSort topologically sorts the nodes in the Graph starting at the given key.

Returns a *CycleError if there is a cycle in the graph.