optiwindnet.pathfinding

Module Contents

class optiwindnet.pathfinding.PathFinder(Gʹ: networkx.Graph, planar: networkx.PlanarEmbedding, A: networkx.Graph | None = None, branched: bool = True, iterations_limit: int = 15000, traversals_limit: int = 2, promising_margin: float = 0.1, bad_streak_limit: int = 9)

Router for gates that don’t belong to the PlanarEmbedding of the graph. Initialize it with a detour-free routeset G and it will find paths from all nodes to the nearest root without crossing any used edges.

Only edges in graph attribute ‘tentative’ or, lacking that, edges with the attribute ‘kind’ == ‘tentative’ are checked for crossings.

These paths can be used to replace the existing gates that cross other edges by gate paths with detours.

Example:

H = PathFinder(G, planar=P, A=A).create_detours()

iterations = 0

ST

fnT

d2roots

d2rootsRank = None

predetour_length

branched = True

traversals_limit = 2

promising_margin = 0.1

bad_streak_limit = 9

num_revisits = 0

adv_counter = 0

get_best_path(n: int)

_.get_best_path(«node») produces a tuple(path, dists). path contains a sequence of nodes from the original networx.Graph G, from «node» to the closest root. dists contains the lengths of the segments defined by paths.

best_paths_overlay() → networkx.Graph

Merges the shortest paths for all nodes with G.

The output includes G’s edges, excluding its gates.

Returns:

Merged graph (pass to plotting.gplot() or ‘svg.svgplot()`).

scaffolded() → networkx.Graph

Wrapper for interarraylib.scaffolded.

create_detours() → networkx.Graph

Reroute all gate edges in G with crossings using detour paths.

Returns:

New networkx.Graph (shallow copy of G, with detours).