dag

Documentation

Index

• func JSON2Dot(r io.Reader) ([]byte, error)
• func StronglyConnected(g *Graph) [][]Vertex
• func VertexName(raw Vertex) string
• type AcyclicGraph
  • func (g *AcyclicGraph) Ancestors(v Vertex) (*Set, error)
  • func (g *AcyclicGraph) Cycles() [][]Vertex
  • func (g *AcyclicGraph) DepthFirstWalk(start []Vertex, f DepthWalkFunc) error
  • func (g *AcyclicGraph) Descendents(v Vertex) (*Set, error)
  • func (g *AcyclicGraph) DirectedGraph() Grapher
  • func (g *AcyclicGraph) ReverseDepthFirstWalk(start []Vertex, f DepthWalkFunc) error
  • func (g *AcyclicGraph) Root() (Vertex, error)
  • func (g *AcyclicGraph) TransitiveReduction()
  • func (g *AcyclicGraph) Validate() error
  • func (g *AcyclicGraph) Walk(cb WalkFunc) error
• type DebugOperationEnd
  • func (e DebugOperationEnd) End(info string)
• type DepthWalkFunc
• type DotNode
• type DotOpts
• type Edge
  • func BasicEdge(source, target Vertex) Edge
• type Graph
  • func (g *Graph) Add(v Vertex) Vertex
  • func (g *Graph) Connect(edge Edge)
  • func (g *Graph) DebugEdgeInfo(e Edge, info string)
  • func (g *Graph) DebugOperation(operation string, info string) DebugOperationEnd
  • func (g *Graph) DebugVertexInfo(v Vertex, info string)
  • func (g *Graph) DebugVisitInfo(v Vertex, info string)
  • func (g *Graph) DirectedGraph() Grapher
  • func (g *Graph) Dot(opts *DotOpts) []byte
  • func (g *Graph) DownEdges(v Vertex) *Set
  • func (g *Graph) Edges() []Edge
  • func (g *Graph) EdgesFrom(v Vertex) []Edge
  • func (g *Graph) EdgesTo(v Vertex) []Edge
  • func (g *Graph) HasEdge(e Edge) bool
  • func (g *Graph) HasVertex(v Vertex) bool
  • func (g *Graph) MarshalJSON() ([]byte, error)
  • func (g *Graph) Remove(v Vertex) Vertex
  • func (g *Graph) RemoveEdge(edge Edge)
  • func (g *Graph) Replace(original, replacement Vertex) bool
  • func (g *Graph) SetDebugWriter(w io.Writer)
  • func (g *Graph) String() string
  • func (g *Graph) StringWithNodeTypes() string
  • func (g *Graph) UpEdges(v Vertex) *Set
  • func (g *Graph) Vertices() []Vertex
• type GraphNodeDotter
• type Grapher
• type Hashable
• type NamedVertex
• type Set
  • func (s *Set) Add(v interface{})
  • func (s *Set) Delete(v interface{})
  • func (s *Set) Difference(other *Set) *Set
  • func (s *Set) Include(v interface{}) bool
  • func (s *Set) Intersection(other *Set) *Set
  • func (s *Set) Len() int
  • func (s *Set) List() []interface{}
• type Subgrapher
• type Vertex
  • func AsVertexList(s *Set) []Vertex
• type WalkFunc
• type Walker
  • func (w *Walker) Update(g *AcyclicGraph)
  • func (w *Walker) Wait() error

Functions

func JSON2Dot

func JSON2Dot(r io.Reader) ([]byte, error)

JSON2Dot reads a Graph debug log from and io.Reader, and converts the final graph dot format.

TODO: Allow returning the output at a certain point during decode.

Encode extra information from the json log into the Dot.

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. With this property, we get the property of sane graph traversal.

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) Cycles

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

func (*AcyclicGraph) DepthFirstWalk

func (g *AcyclicGraph) DepthFirstWalk(start []Vertex, f DepthWalkFunc) error

depthFirstWalk does a depth-first walk of the graph starting from the vertices in start. This is not exported now but it would make sense to export this publicly at some point.

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) ReverseDepthFirstWalk

func (g *AcyclicGraph) ReverseDepthFirstWalk(start []Vertex, f DepthWalkFunc) error

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

func (*AcyclicGraph) Root

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

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

Complexity: O(V)

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 valid for this operation to behave properly. If Validate() returns an error, the behavior is undefined and the results will likely be unexpected.

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) error

Walk walks the graph, calling your callback as each node is visited. This will walk nodes in parallel if it can. Because the walk is done in parallel, the error returned will be a multierror.

type DebugOperationEnd

type DebugOperationEnd func(string)

The DebugOperationEnd func type provides a way to call an End function via a method call, allowing for the chaining of methods in a defer statement.

func (DebugOperationEnd) End

func (e DebugOperationEnd) End(info string)

End calls function e with the info parameter, marking the end of this operation in the logs.

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) DebugEdgeInfo

func (g *Graph) DebugEdgeInfo(e Edge, info string)

DebugEdgeInfo encodes arbitrary information about an edge in the graph debug logs.

func (*Graph) DebugOperation

func (g *Graph) DebugOperation(operation string, info string) DebugOperationEnd

DebugOperation marks the start of a set of graph transformations in the debug log, and returns a DebugOperationEnd func, which marks the end of the operation in the log. Additional information can be added to the log via the info parameter.

The returned func's End method allows this method to be called from a single defer statement:

defer g.DebugOperationBegin("OpName", "operating").End("")

The returned function must be called to properly close the logical operation in the logs.

func (*Graph) DebugVertexInfo

func (g *Graph) DebugVertexInfo(v Vertex, info string)

DebugVertexInfo encodes arbitrary information about a vertex in the graph debug logs.

func (*Graph) DebugVisitInfo

func (g *Graph) DebugVisitInfo(v Vertex, info string)

DebugVisitInfo records a visit to a Vertex during a walk operation.

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 outward edges from the source 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) MarshalJSON

func (g *Graph) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of the entire 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) SetDebugWriter

func (g *Graph) SetDebugWriter(w io.Writer)

SetDebugWriter sets the io.Writer where the Graph will record debug information. After this is set, the graph will immediately encode itself to the stream, and continue to record all subsequent operations.

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) UpEdges

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

UpEdges returns the inward edges to the destination 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 struct {
	// contains filtered or unexported fields
}

Set is a set data structure.

func (*Set) Add

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

Add adds an item to 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) 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) error

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, cahnging 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() error

Wait waits for the completion of the walk and returns any errors ( in the form of a multierror) that occurred. 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.