@tscircuit/capacity-autorouter 0.0.149 → 0.0.151

package/dist/index.d.ts

@@ -4,6 +4,16 @@ import { Polygon } from '@tscircuit/math-utils';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 type TraceId = string;
+type NetId = string;
+type PointId = string;
+type OffBoardConnectionId = string;
+type ConnectionPoint = {
+    x: number;
+    y: number;
+    layer: string;
+    pointId?: PointId;
+    pcb_port_id?: string;
+};
 interface SimpleRouteJson {
     layerCount: number;
     minTraceWidth: number;
@@ -32,22 +42,18 @@ interface Obstacle {
     };
     width: number;
     height: number;
-    connectedTo: TraceId[];
+    connectedTo: Array<TraceId | NetId>;
     netIsAssignable?: boolean;
-    offBoardConnectsTo?: TraceId[];
+    offBoardConnectsTo?: Array<OffBoardConnectionId>;
 }
 interface SimpleRouteConnection {
     name: string;
+    isOffBoard?: boolean;
     netConnectionName?: string;
     nominalTraceWidth?: number;
-    pointsToConnect: Array<{
-        x: number;
-        y: number;
-        layer: string;
-        pointId?: string;
-        pcb_port_id?: string;
-    }>;
-    externallyConnectedPointIds?: string[][];
+    pointsToConnect: ConnectionPoint[];
+    /** @deprecated DO NOT USE **/
+    externallyConnectedPointIds?: PointId[][];
 }
 interface SimplifiedPcbTrace {
     type: "pcb_trace";
@@ -1984,6 +1990,60 @@ declare class UselessViaRemovalSolver extends BaseSolver {
     visualize(): GraphicsObject;
 }
 
+/**
+ * A Disjoint Set Union (DSU) or Union-Find data structure.
+ * It tracks a collection of disjoint sets and can efficiently merge them.
+ */
+declare class DSU {
+    private parent;
+    /**
+     * Creates a new DSU instance.
+     * Each ID is initially in its own set.
+     */
+    constructor(ids: string[]);
+    /**
+     * Finds the representative of the set containing the given ID.
+     * Uses path compression.
+     */
+    find(id: string): string;
+    /**
+     * Merges the sets containing the two given IDs.
+     */
+    union(id1: string, id2: string): void;
+    /**
+     * Gets all IDs in the same set as the given ID.
+     */
+    getGroup(id: string): string[];
+}
+
+/**
+ * Extends the base NetToPointPairsSolver with an optimization that utilizes
+ * off-board connections to find shorter routing paths.
+ *
+ * This solver preprocesses all connections to identify points that are
+ * electrically connected off-board (via the `isOffBoard` flag). It builds
+ * "equivalence groups" of these points using a Disjoint Set Union (DSU)
+ * data structure.
+ *
+ * When the solver processes an on-board connection or a segment from a
+ * Minimum Spanning Tree (MST), it checks if either of the connection's
+ * endpoints has an off-board equivalent. If so, it calculates the distance
+ * to all possible substitutes and chooses the pair that results in the
+ * shortest path, potentially rerouting the connection to a more optimal
+ * equivalent point.
+ */
+declare class NetToPointPairsSolver2_OffBoardConnection extends NetToPointPairsSolver {
+    ogSrj: SimpleRouteJson;
+    colorMap: Record<string, string>;
+    connectionPointDsu: DSU;
+    connectionPointMap: Map<string, ConnectionPoint>;
+    constructor(ogSrj: SimpleRouteJson, colorMap?: Record<string, string>);
+    _findBestConnectionPointsFromDisjointSets(sourcePoint: ConnectionPoint, targetPoint: ConnectionPoint): {
+        pointsToConnect: [ConnectionPoint, ConnectionPoint];
+    };
+    _step(): void;
+}
+
 interface CapacityMeshSolverOptions$1 {
     capacityDepth?: number;
     targetMinCapacity?: number;
@@ -2029,7 +2089,7 @@ declare class AutoroutingPipelineSolver extends BaseSolver {
     capacityNodes: CapacityMeshNode[] | null;
     capacityEdges: CapacityMeshEdge[] | null;
     cacheProvider: CacheProvider | null;
-    pipelineDef: (PipelineStep$1<typeof NetToPointPairsSolver> | PipelineStep$1<typeof CapacityMeshNodeSolver2_NodeUnderObstacle> | PipelineStep$1<typeof SingleLayerNodeMergerSolver> | PipelineStep$1<typeof StrawSolver> | PipelineStep$1<typeof CapacityMeshEdgeSolver2_NodeTreeOptimization> | PipelineStep$1<typeof DeadEndSolver> | PipelineStep$1<typeof CapacityPathingGreedySolver> | PipelineStep$1<typeof CapacityPathingMultiSectionSolver> | PipelineStep$1<typeof CapacityEdgeToPortSegmentSolver> | PipelineStep$1<typeof CapacitySegmentToPointSolver> | PipelineStep$1<typeof UnravelMultiSectionSolver> | PipelineStep$1<typeof HighDensitySolver> | PipelineStep$1<typeof MultipleHighDensityRouteStitchSolver> | PipelineStep$1<typeof UselessViaRemovalSolver> | PipelineStep$1<typeof MultiSimplifiedPathSolver>)[];
+    pipelineDef: (PipelineStep$1<typeof NetToPointPairsSolver2_OffBoardConnection> | PipelineStep$1<typeof CapacityMeshNodeSolver2_NodeUnderObstacle> | PipelineStep$1<typeof SingleLayerNodeMergerSolver> | PipelineStep$1<typeof StrawSolver> | PipelineStep$1<typeof CapacityMeshEdgeSolver2_NodeTreeOptimization> | PipelineStep$1<typeof DeadEndSolver> | PipelineStep$1<typeof CapacityPathingGreedySolver> | PipelineStep$1<typeof CapacityPathingMultiSectionSolver> | PipelineStep$1<typeof CapacityEdgeToPortSegmentSolver> | PipelineStep$1<typeof CapacitySegmentToPointSolver> | PipelineStep$1<typeof UnravelMultiSectionSolver> | PipelineStep$1<typeof HighDensitySolver> | PipelineStep$1<typeof MultipleHighDensityRouteStitchSolver> | PipelineStep$1<typeof UselessViaRemovalSolver> | PipelineStep$1<typeof MultiSimplifiedPathSolver>)[];
     constructor(srj: SimpleRouteJson, opts?: CapacityMeshSolverOptions$1);
     currentPipelineStepIndex: number;
     _step(): void;