dag

package
v0.24.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2023 License: Apache-2.0, MPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func StronglyConnected 

func StronglyConnected(g *Graph) [][]Vertex

StronglyConnected returns the list of strongly connected components within the Graph g. This information is primarily used by this package for cycle detection, but strongly connected components have widespread use.

func VertexName 

func VertexName(raw Vertex) string

VertexName returns the name of a vertex.

Types

type AcyclicGraph 

type AcyclicGraph struct {
	Graph
}

AcyclicGraph is a specialization of Graph that cannot have cycles.

func (*AcyclicGraph) Ancestors 

func (g *AcyclicGraph) Ancestors(v Vertex) (Set, error)

Returns a Set that includes every Vertex yielded by walking down from the provided starting Vertex v.

func (*AcyclicGraph) BreadthFirstWalk 

func (g *AcyclicGraph) BreadthFirstWalk(start Set, f DepthWalkFunc) error

BreadthFirstWalk does a breadth-first walk of the graph starting from the vertices in start.

func (*AcyclicGraph) Cycles 

func (g *AcyclicGraph) Cycles() [][]Vertex

Cycles reports any cycles between graph nodes. Self-referencing nodes are not reported, and must be detected separately.

func (*AcyclicGraph) DepthFirstWalk 

func (g *AcyclicGraph) DepthFirstWalk(start Set, f DepthWalkFunc) error

DepthFirstWalk does a depth-first walk of the graph starting from the vertices in start.

func (*AcyclicGraph) Descendents 

func (g *AcyclicGraph) Descendents(v Vertex) (Set, error)

Returns a Set that includes every Vertex yielded by walking up from the provided starting Vertex v.

func (*AcyclicGraph) DirectedGraph 

func (g *AcyclicGraph) DirectedGraph() Grapher

func (*AcyclicGraph) ReverseBreadthFirstWalk 

func (g *AcyclicGraph) ReverseBreadthFirstWalk(start Set, f DepthWalkFunc) error

ReverseBreadthFirstWalk does a breadth-first walk _up_ the graph starting from the vertices in start.

func (*AcyclicGraph) ReverseDepthFirstWalk 

func (g *AcyclicGraph) ReverseDepthFirstWalk(start Set, f DepthWalkFunc) error

ReverseDepthFirstWalk does a depth-first walk _up_ the graph starting from the vertices in start.

func (*AcyclicGraph) ReverseTopologicalOrder 

func (g *AcyclicGraph) ReverseTopologicalOrder() []Vertex

ReverseTopologicalOrder returns a topological sort of the given graph, following each edge in reverse. The nodes are not sorted, and any valid order may be returned. This function will panic if it encounters a cycle.

func (*AcyclicGraph) Root 

func (g *AcyclicGraph) Root() (Vertex, error)

Root returns the root of the DAG, or an error.

Complexity: O(V)

func (*AcyclicGraph) TopologicalOrder 

func (g *AcyclicGraph) TopologicalOrder() []Vertex

TopologicalOrder returns a topological sort of the given graph. The nodes are not sorted, and any valid order may be returned. This function will panic if it encounters a cycle.

func (*AcyclicGraph) TransitiveReduction 

func (g *AcyclicGraph) TransitiveReduction()

TransitiveReduction performs the transitive reduction of graph g in place. The transitive reduction of a graph is a graph with as few edges as possible with the same reachability as the original graph. This means that if there are three nodes A => B => C, and A connects to both B and C, and B connects to C, then the transitive reduction is the same graph with only a single edge between A and B, and a single edge between B and C.

The graph must be free of cycles for this operation to behave properly.

Complexity: O(V(V+E)), or asymptotically O(VE)

func (*AcyclicGraph) Validate 

func (g *AcyclicGraph) Validate() error

Validate validates the DAG. A DAG is valid if it has a single root with no cycles.

func (*AcyclicGraph) Walk 

func (g *AcyclicGraph) Walk(cb WalkFunc) tfdiags.Diagnostics

Walk walks the graph, calling your callback as each node is visited. This will walk nodes in parallel if it can. The resulting diagnostics contains problems from all graphs visited, in no particular order.

type DepthWalkFunc 

type DepthWalkFunc func(Vertex, int) error

DepthWalkFunc is a walk function that also receives the current depth of the walk as an argument

type DotNode 

type DotNode struct {
	Name  string
	Attrs map[string]string
}

DotNode provides a structure for Vertices to return in order to specify their dot format.

type DotOpts 

type DotOpts struct {
	// Allows some nodes to decide to only show themselves when the user has
	// requested the "verbose" graph.
	Verbose bool

	// Highlight Cycles
	DrawCycles bool

	// How many levels to expand modules as we draw
	MaxDepth int
	// contains filtered or unexported fields
}

DotOpts are the options for generating a dot formatted Graph.

type Edge 

type Edge interface {
	Source() Vertex
	Target() Vertex

	Hashable
}

Edge represents an edge in the graph, with a source and target vertex.

func BasicEdge 

func BasicEdge(source, target Vertex) Edge

BasicEdge returns an Edge implementation that simply tracks the source and target given as-is.

type Graph 

type Graph struct {
	// contains filtered or unexported fields
}

Graph is used to represent a dependency graph.

func (*Graph) Add 

func (g *Graph) Add(v Vertex) Vertex

Add adds a vertex to the graph. This is safe to call multiple time with the same Vertex.

func (*Graph) Connect 

func (g *Graph) Connect(edge Edge)

Connect adds an edge with the given source and target. This is safe to call multiple times with the same value. Note that the same value is verified through pointer equality of the vertices, not through the value of the edge itself.

func (*Graph) DirectedGraph 

func (g *Graph) DirectedGraph() Grapher

func (*Graph) Dot 

func (g *Graph) Dot(opts *DotOpts) []byte

Dot returns a dot-formatted representation of the Graph.

func (*Graph) DownEdges 

func (g *Graph) DownEdges(v Vertex) Set

DownEdges returns the vertices connected from the inward edges to Vertex v.

func (*Graph) Edges 

func (g *Graph) Edges() []Edge

Edges returns the list of all the edges in the graph.

func (*Graph) EdgesFrom 

func (g *Graph) EdgesFrom(v Vertex) []Edge

EdgesFrom returns the list of edges from the given source.

func (*Graph) EdgesTo 

func (g *Graph) EdgesTo(v Vertex) []Edge

EdgesTo returns the list of edges to the given target.

func (*Graph) HasEdge 

func (g *Graph) HasEdge(e Edge) bool

HasEdge checks if the given Edge is present in the graph.

func (*Graph) HasVertex 

func (g *Graph) HasVertex(v Vertex) bool

HasVertex checks if the given Vertex is present in the graph.

func (*Graph) Remove 

func (g *Graph) Remove(v Vertex) Vertex

Remove removes a vertex from the graph. This will also remove any edges with this vertex as a source or target.

func (*Graph) RemoveEdge 

func (g *Graph) RemoveEdge(edge Edge)

RemoveEdge removes an edge from the graph.

func (*Graph) Replace 

func (g *Graph) Replace(original, replacement Vertex) bool

Replace replaces the original Vertex with replacement. If the original does not exist within the graph, then false is returned. Otherwise, true is returned.

func (*Graph) String 

func (g *Graph) String() string

String outputs some human-friendly output for the graph structure.

func (*Graph) StringWithNodeTypes 

func (g *Graph) StringWithNodeTypes() string

String outputs some human-friendly output for the graph structure.

func (*Graph) Subsume 

func (g *Graph) Subsume(other *Graph)

Subsume imports all of the nodes and edges from the given graph into the reciever, leaving the given graph unchanged.

If any of the nodes in the given graph are already present in the reciever then the existing node will be retained and any new edges from the given graph will be connected with it.

If the given graph has edges in common with the reciever then they will be ignored, because each pair of nodes can only be connected once.

func (*Graph) UpEdges 

func (g *Graph) UpEdges(v Vertex) Set

UpEdges returns the vertices connected to the outward edges from the source Vertex v.

func (*Graph) Vertices 

func (g *Graph) Vertices() []Vertex

Vertices returns the list of all the vertices in the graph.

type GraphNodeDotter 

type GraphNodeDotter interface {
	// Dot is called to return the dot formatting for the node.
	// The first parameter is the title of the node.
	// The second parameter includes user-specified options that affect the dot
	// graph. See GraphDotOpts below for details.
	DotNode(string, *DotOpts) *DotNode
}

GraphNodeDotter can be implemented by a node to cause it to be included in the dot graph. The Dot method will be called which is expected to return a representation of this node.

type Grapher 

type Grapher interface {
	DirectedGraph() Grapher
}

A Grapher is any type that returns a Grapher, mainly used to identify dag.Graph and dag.AcyclicGraph. In the case of Graph and AcyclicGraph, they return themselves.

type Hashable 

type Hashable interface {
	Hashcode() interface{}
}

Hashable is the interface used by set to get the hash code of a value. If this isn't given, then the value of the item being added to the set itself is used as the comparison value.

type NamedVertex 

type NamedVertex interface {
	Vertex
	Name() string
}

NamedVertex is an optional interface that can be implemented by Vertex to give it a human-friendly name that is used for outputting the graph.

type Set 

type Set map[interface{}]interface{}

Set is a set data structure.

func (Set) Add 

func (s Set) Add(v interface{})

Add adds an item to the set

func (Set) Copy 

func (s Set) Copy() Set

Copy returns a shallow copy of the set.

func (Set) Delete 

func (s Set) Delete(v interface{})

Delete removes an item from the set.

func (Set) Difference 

func (s Set) Difference(other Set) Set

Difference returns a set with the elements that s has but other doesn't.

func (Set) Filter 

func (s Set) Filter(cb func(interface{}) bool) Set

Filter returns a set that contains the elements from the receiver where the given callback returns true.

func (Set) Include 

func (s Set) Include(v interface{}) bool

Include returns true/false of whether a value is in the set.

func (Set) Intersection 

func (s Set) Intersection(other Set) Set

Intersection computes the set intersection with other.

func (Set) Len 

func (s Set) Len() int

Len is the number of items in the set.

func (Set) List 

func (s Set) List() []interface{}

List returns the list of set elements.

type Subgrapher 

type Subgrapher interface {
	Subgraph() Grapher
}

Subgrapher allows a Vertex to be a Graph itself, by returning a Grapher.

type Vertex 

type Vertex interface{}

Vertex of the graph.

func AsVertexList 

func AsVertexList(s Set) []Vertex

simple convenience helper for converting a dag.Set to a []Vertex

type WalkFunc 

type WalkFunc func(Vertex) tfdiags.Diagnostics

WalkFunc is the callback used for walking the graph.

type Walker 

type Walker struct {
	// Callback is what is called for each vertex
	Callback WalkFunc

	// Reverse, if true, causes the source of an edge to depend on a target.
	// When false (default), the target depends on the source.
	Reverse bool
	// contains filtered or unexported fields
}

Walker is used to walk every vertex of a graph in parallel.

A vertex will only be walked when the dependencies of that vertex have been walked. If two vertices can be walked at the same time, they will be.

Update can be called to update the graph. This can be called even during a walk, changing vertices/edges mid-walk. This should be done carefully. If a vertex is removed but has already been executed, the result of that execution (any error) is still returned by Wait. Changing or re-adding a vertex that has already executed has no effect. Changing edges of a vertex that has already executed has no effect.

Non-parallelism can be enforced by introducing a lock in your callback function. However, the goroutine overhead of a walk will remain. Walker will create V*2 goroutines (one for each vertex, and dependency waiter for each vertex). In general this should be of no concern unless there are a huge number of vertices.

The walk is depth first by default. This can be changed with the Reverse option.

A single walker is only valid for one graph walk. After the walk is complete you must construct a new walker to walk again. State for the walk is never deleted in case vertices or edges are changed.

func (*Walker) Update 

func (w *Walker) Update(g *AcyclicGraph)

Update updates the currently executing walk with the given graph. This will perform a diff of the vertices and edges and update the walker. Already completed vertices remain completed (including any errors during their execution).

This returns immediately once the walker is updated; it does not wait for completion of the walk.

Multiple Updates can be called in parallel. Update can be called at any time during a walk.

func (*Walker) Wait 

func (w *Walker) Wait() tfdiags.Diagnostics

Wait waits for the completion of the walk and returns diagnostics describing any problems that arose. Update should be called to populate the walk with vertices and edges prior to calling this.

Wait will return as soon as all currently known vertices are complete. If you plan on calling Update with more vertices in the future, you should not call Wait until after this is done.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.