package routing

Import Path
	github.com/pancsta/d2/d2layouts/d2talalayout/internal/routing (on go.dev)

Dependency Relation
	imports 25 packages, and imported by 2 packages

Involved Source Files

	    balance_crossings.go
	    balance_route_guard.go
	    cluster_route_guard.go
	    coordinator.go
	    cost.go
	  d doc.go
		Package routing builds orthogonal visibility graphs, searches them for edge
		routes, and applies the routing post-processing stages.

	    edge_simplify.go
	    filter.go
	    geometry.go
	    graph_stage.go
	    loop_router.go
	    nudge_channels.go
	    ovg.go
	    ovg_edge.go
	    ovg_edge_router.go
	    ovg_edge_set.go
	    ovg_hierarchy.go
	    ovg_node.go
	    ovg_resource.go
	    port_interior_balance.go
	    postprocess.go
	    priority_queue.go
	    route.go
	    route_search_guard.go
	    route_stage_guard.go
	    shortcut_routes.go
	    slingshot.go
	    snapshot.go
	    standalone_route_guard.go
	    standalone_router.go
	    swap_ports.go
	    trace.go
	    tree_routes.go
	    tuning.go
	    tunnel.go
	    turns.go
	    work.go
Package-Level Type Names (total 15)

	/* sort by: alphabet | popularity */
	 type GenerateRouteResponse (struct)

		Fields (total 4)
			Distance float64
			Err error
			Flavor RouteGenerationFlavor
			Routes []*Route

	 type GraphRouteOptions (struct)
		GraphRouteOptions describes the route state owned by the pipeline around a
		whole-graph routing pass.

		Fields (total 4)
			CompletionObserver RouteCompletionObserver
			ForceReroute bool
			Observer SubgraphRouteObserver
			RoutesPreviouslyCompleted bool
		As Inputs Of (at least 2)
			func RouteGraph(ctx context.Context, graph *layoutgraph.Graph, options GraphRouteOptions) (bool, error)
			func RouteGraphWithWorkLimit(ctx context.Context, graph *layoutgraph.Graph, options GraphRouteOptions, workLimit uint64) (routingComplete bool, err error)

	 type OVG (struct)
		Orthogonal Visibility Graph

		Fields (total 8)
			Centers map[*layoutgraph.Node]*OVGNode
			Edges []*OVGEdge
			HorizontalEdges map[float64][]*OVGEdge
			Nodes []*OVGNode
			NodesInsideBoundingBox []*layoutgraph.Node
			OccupiedPoints map[geo.Point]*OVGNode
			Ports map[*layoutgraph.Node][]*OVGNode
			VerticalEdges map[float64][]*OVGEdge
		Methods (total 5)
			(*OVG) AddNode(node *OVGNode) *OVGNode
			(*OVG) AddNodeUnchecked(node *OVGNode)
			(*OVG) Connect(nodeA, nodeB *OVGNode) *OVGEdge
			(*OVG) MarshalJSON() ([]byte, error)
			(*OVG) UnmarshalJSON(content []byte) error
		Implements (at least 4)
			*OVG : github.com/goccy/go-json.Marshaler
			*OVG : github.com/goccy/go-json.Unmarshaler
			*OVG : encoding/json/v2.Marshaler
			*OVG : encoding/json/v2.Unmarshaler
		As Outputs Of (at least one exported)
			func NewOVG(nodesInsideBoundingBox []*layoutgraph.Node) *OVG
		As Inputs Of (at least one exported)
			func SubgraphRouteObserver.SubgraphRouted(*OVG) error

	 type OVGEdge (struct)

		Fields (total 3)
			Distance float64
			From *OVGNode
			To *OVGNode
		As Outputs Of (at least 2)
			func NewOVGEdge(from, to *OVGNode) *OVGEdge
			func (*OVG).Connect(nodeA, nodeB *OVGNode) *OVGEdge
		As Inputs Of (at least one exported)
			func (*OVGNode).Adjacent(edge *OVGEdge) *OVGNode

	 type OVGNode (struct)

		Fields (total 9)
			Container *layoutgraph.Node
			Edges []*OVGEdge
				// 24 bytes

			Index int
				// 8 bytes

			IsNearPort map[*layoutgraph.Node]struct{}
				// 8 bytes

			IsNodeCenter bool
				// 1 byte

			IsTunnel bool
				// 1 byte

			Point *geo.Point
				// 8 bytes

			Point.X float64
			Point.Y float64
		Methods (total 16)
			( OVGNode) AddVector(v geo.Vector) *geo.Point
				Moves the given point by Vector

			(*OVGNode) Adjacent(edge *OVGEdge) *OVGNode
			( OVGNode) Compare(p2 *geo.Point) int
			( OVGNode) Copy() *geo.Point
			( OVGNode) DistanceToLine(p1, p2 *geo.Point) float64
				https://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

			( OVGNode) Equals(p2 *geo.Point) bool
			( OVGNode) FormattedCoordinates() string
			( OVGNode) GetOrientation(pTo *geo.Point) geo.Orientation
				GetOrientation gets orientation of pFrom to pTo
				E.g. pFrom ---> pTo, here, pFrom is to the left of pTo, so Left would be returned

			( OVGNode) Interpolate(b *geo.Point, t float64) *geo.Point
				point t% of the way between a and b

			( OVGNode) OnOrthogonalSegment(a, b *geo.Point) bool
				returns true if point p is on orthogonal segment between points a and b

			( OVGNode) ToString() string
			( OVGNode) ToVector() geo.Vector
				Creates a Vector pointing to point

			( OVGNode) Transpose()
			( OVGNode) TruncateDecimals()
			( OVGNode) TruncateFloat32()
			( OVGNode) VectorTo(endpoint *geo.Point) geo.Vector
				Creates a Vector of the size between start and endpoint, pointing to endpoint

		As Outputs Of (at least 3)
			func NewOVGNode(p *geo.Point) *OVGNode
			func (*OVG).AddNode(node *OVGNode) *OVGNode
			func (*OVGNode).Adjacent(edge *OVGEdge) *OVGNode
		As Inputs Of (at least 5)
			func NewOVGEdge(from, to *OVGNode) *OVGEdge
			func NewTunnelEntry(node *layoutgraph.Node, ovgNode *OVGNode) *TunnelEntry
			func (*OVG).AddNode(node *OVGNode) *OVGNode
			func (*OVG).AddNodeUnchecked(node *OVGNode)
			func (*OVG).Connect(nodeA, nodeB *OVGNode) *OVGEdge

	 type Range (struct)
	 type Route (struct)

		Fields (total 4)
			FromPort geo.Point
			GEdge *layoutgraph.Edge
			OVGNodes []*OVGNode
			ToPort geo.Point

	 type RouteChecker (struct)
	 type RouteCompletionObserver (interface)
		RouteCompletionObserver observes the route-complete transition inside the
		atomic routing stage. The engine retains pipeline-status ownership while the
		routing guard can still observe cancellation before commit.

		Methods (only one)
			( RouteCompletionObserver) RoutingCompleted()

	 type RouteGenerationFlavor string (basic type)

		As Types Of (total 4)
			const Default
			const LongestToShortest
			const ShortestToLongest
			const TopDownLeftRight

	 type SearchTelemetry (struct)
		SearchTelemetry collects per-flavor work samples for routing diagnostics
		and calibration. It is safe to share across concurrent route workers.

		Methods (only one)
			(*SearchTelemetry) WorkSamples() []uint64
				WorkSamples returns a stable copy of the recorded per-flavor work totals.

		As Inputs Of (at least one exported)
			func WithSearchTelemetry(ctx context.Context, telemetry *SearchTelemetry) context.Context

	 type SubgraphRouteObserver (interface)
		SubgraphRouteObserver observes each completed subgraph route at the exact
		point where its OVG and the graph's current route state agree. Snapshot
		serialization belongs to the engine orchestrator and can be implemented by
		this optional observer without making routing depend on engine.

		Methods (only one)
			( SubgraphRouteObserver) SubgraphRouted(*OVG) error

	 type TreeEdgePath (struct)

		Fields (total 5)
			SourceMidpoint *geo.Point
			SourceOrientationToTarget geo.Orientation
			SourcePortNode *OVGNode
			TargetMidpoint *geo.Point
			TargetPortNode *OVGNode

	 type Tunnel (struct)

		Fields (total 2)
			EntryA *TunnelEntry
			EntryB *TunnelEntry
		As Outputs Of (at least one exported)
			func NewTunnel(entryA, entryB *TunnelEntry) *Tunnel

	 type TunnelEntry (struct)

		Fields (total 2)
			Node *layoutgraph.Node
			OVGNode *OVGNode
		As Outputs Of (at least one exported)
			func NewTunnelEntry(node *layoutgraph.Node, ovgNode *OVGNode) *TunnelEntry
		As Inputs Of (at least one exported)
			func NewTunnel(entryA, entryB *TunnelEntry) *Tunnel


Package-Level Functions (total 19)

	 func BalanceEdgeSegments(ctx context.Context, g *layoutgraph.Graph) error
	 func Crosshatch(ctx context.Context, g *layoutgraph.Graph) error
	 func FixClusterEdgeBranching(ctx context.Context, g *layoutgraph.Graph) error
		FixClusterEdgeBranching resolves route branching at cluster boundaries.

	 func NewOVG(nodesInsideBoundingBox []*layoutgraph.Node) *OVG
	 func NewOVGEdge(from, to *OVGNode) *OVGEdge
	 func NewOVGNode(p *geo.Point) *OVGNode
	 func NewTunnel(entryA, entryB *TunnelEntry) *Tunnel
	 func NewTunnelEntry(node *layoutgraph.Node, ovgNode *OVGNode) *TunnelEntry
	 func NudgeEdgeChannels(ctx context.Context, g *layoutgraph.Graph) error
	 func ReorderDuplicates(ctx context.Context, g *layoutgraph.Graph) error
	 func RouteEdges(ctx context.Context, g *layoutgraph.Graph, edges []*layoutgraph.Edge) error
	 func RouteGraph(ctx context.Context, graph *layoutgraph.Graph, options GraphRouteOptions) (bool, error)
		RouteGraph runs the complete graph-routing stage. The returned boolean is
		the updated value of RoutesPreviouslyCompleted; on error the caller must
		retain its prior value.

	 func RouteGraphWithWorkLimit(ctx context.Context, graph *layoutgraph.Graph, options GraphRouteOptions, workLimit uint64) (routingComplete bool, err error)
		RouteGraphWithWorkLimit is RouteGraph with an explicit aggregate budget.
		It exists for deterministic resource-boundary testing inside TALA.

	 func ShortcutEdgeRoutes(ctx context.Context, g *layoutgraph.Graph) error
		ShortcutEdgeRoutes is a bounded bend-reduction postpass with fixed boxes and
		ports. WueOrtho's routing step chooses bend-minimal shortest paths
		(https://arxiv.org/html/2309.01671v2#S2), motivating this local adaptation:
		replace a subchain by either rectilinear L, retaining only strict bend wins.
		It is not a shortest-path solver and does not change the routing grid.

	 func SimplifyEdgeRoutes(ctx context.Context, g *layoutgraph.Graph) error
		simplifyEdgeRoutes post-processes edge routes to remove unnecessary bending caused by the constraint that routes have to go through OVG nodes
		It identifies unnecessary bends in routes and eliminates them when possible.

	 func StraightEdgesFallback(ctx context.Context, g *layoutgraph.Graph) error
	 func SwapAllEdgePorts(ctx context.Context, graph *layoutgraph.Graph) error
		SwapAllEdgePorts applies port swapping to every node under one atomic
		route-stage budget and rollback boundary.

	 func TraceEdgesToShapeBorder(ctx context.Context, graph *layoutgraph.Graph) error
		TraceEdgesToShapeBorder trims every route endpoint to the rendered shape.

	 func WithSearchTelemetry(ctx context.Context, telemetry *SearchTelemetry) context.Context
		WithSearchTelemetry attaches route-search diagnostics to a routing context.


Package-Level Constants (total 5)

	const Default RouteGenerationFlavor = "Default"
	const LongestToShortest RouteGenerationFlavor = "LongestToShortest"
	const MaxSearchWorkUnits uint64 = 120000000
		MaxSearchWorkUnits is the calibrated per-flavor route-search budget.

	const ShortestToLongest RouteGenerationFlavor = "ShortestToLongest"
	const TopDownLeftRight RouteGenerationFlavor = "TopDownLeftRight"

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.