terra-route 0.0.13 → 0.0.17

package/dist/fibonacci-heap.d.ts

@@ -1,11 +0,0 @@
-export declare class FibonacciHeap {
-    private nodeCount;
-    private minNode;
-    insert(key: number, value: number): void;
-    extractMin(): number | null;
-    size(): number;
-    private consolidate;
-    private link;
-    private mergeLists;
-    private removeFromList;
-}

package/dist/graph/graph.d.ts

@@ -1,114 +0,0 @@
-import { Feature, FeatureCollection, LineString, Point } from "geojson";
-import { BoundingBox } from "./methods/bounding-box";
-/**
- * Represents a graph constructed from a GeoJSON FeatureCollection of LineString features.
- * This class provides methods to analyze the graph, including connected components, node and edge counts,
- * and shortest paths. Coordinates in the LineStrings are considered connected if they share identical coordinates.
- */
-export declare class LineStringGraph {
-    constructor(network: FeatureCollection<LineString>);
-    private network;
-    /**
-     * Sets the network for the graph.
-     * This method replaces the current network with a new one.
-     * @param network A GeoJSON FeatureCollection of LineString features representing the network.
-     */
-    setNetwork(network: FeatureCollection<LineString>): void;
-    /**
-     * Gets the current network of the graph.
-     * @returns A GeoJSON FeatureCollection of LineString features representing the network.
-     */
-    getNetwork(): FeatureCollection<LineString>;
-    /**
-     * Gets a filtered network containing only LineStrings that are completely within the specified bounding box.
-     * @param boundingBox A bounding box array in the format [minLng, minLat, maxLng, maxLat]
-     * @returns A GeoJSON FeatureCollection of LineString features representing the network filtered by the bounding box.
-     */
-    getNetworkInBoundingBox(boundingBox: BoundingBox): FeatureCollection<LineString>;
-    /**
-     * Gets the network without duplicate or subsection lines.
-     * This method processes the network to remove any duplicate lines or lines that are subsections of other lines.
-     * @returns A FeatureCollection<LineString> representing the network without duplicate or subsection lines.
-     */
-    getNetworkWithoutDuplicatesOrSubsections(): FeatureCollection<LineString, import("geojson").GeoJsonProperties>;
-    /**
-     * Gets the connected components of the graph.
-     * @returns An array of FeatureCollection<LineString> representing the connected components.
-     */
-    getConnectedComponents(): FeatureCollection<LineString>[];
-    /**
-     * Gets the count of connected components in the graph.
-     * @returns The number of connected components in the graph.
-     */
-    getConnectedComponentCount(): number;
-    /**
-     * Gets the count of unique nodes and edges in the graph.
-     * @returns An object containing the counts of nodes and edges.
-     */
-    getNodeAndEdgeCount(): {
-        nodeCount: number;
-        edgeCount: number;
-    };
-    /**
-     * Gets the unique nodes of the graph as a FeatureCollection of Point features.
-     * @returns A FeatureCollection<Point> containing the nodes of the graph.
-     */
-    getNodes(): FeatureCollection<Point>;
-    /**
-     * Gets the count of unique nodes in the graph.
-     * @returns The number of unique nodes in the graph.
-     */
-    getNodeCount(): number;
-    /**
-     * Gets the unique edges of the graph as a FeatureCollection of LineString features. Each edge is represented as a LineString.
-     * This method ensures that each edge is unique, meaning that edges are not duplicated in the collection. Each linestring only
-     * two coordinates, representing the start and end points of the edge.
-     * @returns A FeatureCollection<LineString> containing the unique edges of the graph.
-     */
-    getEdges(): FeatureCollection<LineString>;
-    /**
-     * Gets the length of the longest edge in the graph based on the length of the LineString.
-     * If no edges exist, it returns -1.
-     * @returns The length of the longest edge in meters, or 0 if no edges exist.
-     */
-    getLongestEdgeLength(): number;
-    /**
-     * Gets the length of the shortest edge in the graph based on the length of the LineString.
-     * If no edges exist, it returns -1.
-     * @returns The length of the shortest edge in meters, or 0 if no edges exist.
-     */
-    getShortestEdgeLength(): number;
-    /**
-     * Gets the longest edge in the graph based on the length of the LineString.
-     * @returns The longest edge as a Feature<LineString> or null if no edges exist.
-     */
-    getLongestEdge(): Feature<LineString> | null;
-    /**
-     * Gets the shortest edge in the graph based on the length of the LineString.
-     * @returns The shortest edge as a Feature<LineString> or null if no edges exist.
-     */
-    getShortestEdge(): Feature<LineString> | null;
-    /**
-     * Gets the count of unique edges in the graph.
-     * @returns The number of unique edges in the graph.
-     */
-    getEdgeCount(): number;
-    /**
-     * Gets the leaf edges of the graph. A leaf edge is defined as an edge whose start or end node has a degree of 1.
-     * Here an edge is defined as a LineString with two coordinates, representing the start and end points.
-     * @returns A FeatureCollection<LineString> containing only the leaf edges of the graph.
-     */
-    getLeafEdges(): FeatureCollection<LineString>;
-    /**
-     * Returns the pruned network, which is the network without the leaf edges.
-     * i.e. This method removes all leaf edges from the network, leaving only the non-leaf edges
-     * @return A FeatureCollection<LineString> representing the pruned network without leaf edges.
-     */
-    getPrunedEdges(depth?: number): FeatureCollection<LineString>;
-    /**
-     * Returns the network where all nodes that are with n meters of each other are unified.
-     * The function will avoid unifying coordinates in the same linestring.
-     * @param toleranceMeters the tolerance for unifying nodes in meters.
-     */
-    getUnifiedNetwork(toleranceMeters: number): FeatureCollection<LineString, import("geojson").GeoJsonProperties>;
-}

package/dist/graph/methods/bounding-box.d.ts

@@ -1,13 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Type representing a bounding box as [minLng, minLat, maxLng, maxLat]
- */
-export type BoundingBox = [number, number, number, number];
-/**
- * Filters a FeatureCollection of LineString features to only include LineStrings
- * that are completely within the specified bounding box.
- * @param featureCollection - A GeoJSON FeatureCollection containing LineString features
- * @param boundingBox - A bounding box array in the format [minLng, minLat, maxLng, maxLat]
- * @returns A new FeatureCollection<LineString> containing only the LineStrings completely within the bounding box
- */
-export declare function getNetworkInBoundingBox(featureCollection: FeatureCollection<LineString>, boundingBox: BoundingBox): FeatureCollection<LineString>;

package/dist/graph/methods/connected.d.ts

@@ -1,9 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Counts the number of connected components in a graph represented by LineString features in a GeoJSON FeatureCollection.
- * Each LineString is treated as an edge in the graph, and connected components are determined by shared coordinates.
- * @param featureCollection - A GeoJSON FeatureCollection containing LineString features
- * @returns The number of connected components in the graph represented by the LineStrings
- */
-export declare function graphGetConnectedComponentCount(featureCollection: FeatureCollection<LineString>): number;
-export declare function graphGetConnectedComponents(featureCollection: FeatureCollection<LineString>): FeatureCollection<LineString>[];

package/dist/graph/methods/duplicates.d.ts

@@ -1,7 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Remove any LineString that is either
- *  - an exact duplicate of an earlier one, or
- *  - a contiguous subsequence (in either direction) of any other.
- */
-export declare function removeDuplicateAndSubsectionLines(collection: FeatureCollection<LineString>): FeatureCollection<LineString>;

package/dist/graph/methods/leaf.d.ts

@@ -1,12 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Separates a graph's edges into leaf and non-leaf edges.
- * A leaf edge has a start or end node with degree 1.
- *
- * @param edgesFc - FeatureCollection containing LineString features representing edges of a graph
- * @returns Object containing two FeatureCollections: leafEdges and nonLeafEdges
- */
-export declare function getLeafEdges(edgesFc: FeatureCollection<LineString>): {
-    leafEdges: FeatureCollection<LineString>;
-    nonLeafEdges: FeatureCollection<LineString>;
-};

package/dist/graph/methods/nodes.d.ts

@@ -1,17 +0,0 @@
-import { Feature, FeatureCollection, LineString, Point } from 'geojson';
-/**
- * Counts the unique nodes and edges in a GeoJSON FeatureCollection of LineString features.
- * @param featureCollection - A GeoJSON FeatureCollection containing LineString features
- * @returns An object containing the count of unique nodes and edges
- */
-export declare function graphGetNodeAndEdgeCount(featureCollection: FeatureCollection<LineString>): {
-    nodeCount: number;
-    edgeCount: number;
-};
-/**
- * Converts a FeatureCollection of LineString features into a FeatureCollection of Point features,
- * where each unique coordinate in the LineStrings becomes a Point.
- * @param lines - A GeoJSON FeatureCollection containing LineString features
- * @returns A FeatureCollection of Point features representing unique nodes
- */
-export declare function graphGetNodesAsPoints(lines: FeatureCollection<LineString>): Feature<Point>[];

package/dist/graph/methods/spatial-index/geokdbush.d.ts

@@ -1,3 +0,0 @@
-import { KDBush } from './kdbush';
-export declare function around(index: KDBush, lng: number, lat: number, maxResults?: number, maxDistanceKm?: number): any[];
-export declare function distance(lng1: number, lat1: number, lng2: number, lat2: number): number;

package/dist/graph/methods/spatial-index/kdbush.d.ts

@@ -1,16 +0,0 @@
-export declare class KDBush {
-    data: ArrayBuffer;
-    ids: Uint16Array | Uint32Array;
-    coords: InstanceType<TypedArrayConstructor>;
-    private _pos;
-    private _finished;
-    numItems: number;
-    nodeSize: number;
-    private ArrayType;
-    private IndexArrayType;
-    constructor(numItems: number, nodeSize?: number, ArrayType?: TypedArrayConstructor, data?: ArrayBuffer);
-    add(x: number, y: number): number;
-    finish(): this;
-}
-type TypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor | Uint8ClampedArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor;
-export {};

package/dist/graph/methods/spatial-index/tinyqueue.d.ts

@@ -1,11 +0,0 @@
-export default class TinyQueue<T> {
-    private data;
-    length: number;
-    private compare;
-    constructor(data?: T[], compare?: (a: T, b: T) => number);
-    push(item: T): void;
-    pop(): T | undefined;
-    peek(): T | undefined;
-    private _up;
-    private _down;
-}

package/dist/graph/methods/unify.d.ts

@@ -1,2 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-export declare function unifyCloseCoordinates(featureCollection: FeatureCollection<LineString>, radiusMeters: number): FeatureCollection<LineString>;

package/dist/graph/methods/unique-segments.d.ts

@@ -1,5 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Breaks LineStrings in a FeatureCollection into unique single line segments
- */
-export declare function graphGetUniqueSegments(input: FeatureCollection<LineString>): FeatureCollection<LineString>;

package/dist/graph/methods/unique.d.ts

@@ -1,5 +0,0 @@
-import { FeatureCollection, LineString } from 'geojson';
-/**
- * Breaks LineStrings in a FeatureCollection into unique single line segments
- */
-export declare function graphGetUniqueSegments(input: FeatureCollection<LineString>): FeatureCollection<LineString>;

package/dist/heap/min-heap.d.ts

@@ -1,9 +0,0 @@
-import { Heap } from "./heap";
-export declare class MinHeap implements Heap {
-    private heap;
-    private insertCounter;
-    insert(key: number, value: number): void;
-    extractMin(): number | null;
-    size(): number;
-    private bubbleDown;
-}

package/dist/min-heap.d.ts

@@ -1,8 +0,0 @@
-export declare class MinHeap {
-    private heap;
-    private insertCounter;
-    insert(key: number, value: number): void;
-    extractMin(): number | null;
-    size(): number;
-    private bubbleDown;
-}

package/dist/test-utils/utils.d.ts

@@ -1,50 +0,0 @@
-import { Position, Feature, Point, LineString, FeatureCollection } from "geojson";
-/**
- * Calculates the total length of a LineString route in meters.
- *
- * @param line - A GeoJSON Feature<LineString> representing the route
- * @returns The total length of the route in meters
- */
-export declare function routeLength(line: Feature<LineString>): number;
-/**
- * Extracts unique coordinates from a FeatureCollection of LineStrings.
- *
- * @param collection - A GeoJSON FeatureCollection of LineStrings
- * @returns An array of unique Position coordinates
- */
-export declare function getUniqueCoordinatesFromLineStrings(collection: FeatureCollection<LineString>): Position[];
-/**
- * Validates a GeoJSON Feature<LineString> route.
- *
- * @param route - The GeoJSON feature to validate
- * @returns A boolean indicating if it is a valid LineString route
- */
-export declare function getReasonIfLineStringInvalid(route: Feature<LineString> | null | undefined): string | undefined;
-/**
- * Checks if the start and end coordinates of a LineString match the given start and end points.
- *
- * @param line - The LineString feature to check
- * @param start - The start point feature
- * @param end - The end point feature
- * @return True if the start and end coordinates match, false otherwise
- * */
-export declare function startAndEndAreCorrect(line: Feature<LineString>, start: Feature<Point>, end: Feature<Point>): boolean;
-/**
- * Checks if the route represented by a LineString is longer than the direct path.
- * In theory, a route should always longer than the direct path if it has more than two points.
- * @param line - The LineString feature representing the route
- * @param start - The start point feature
- * @param end - The end point feature
- * @returns - True if the route is longer than the direct path, false otherwise
- */
-export declare function routeIsLongerThanDirectPath(line: Feature<LineString>, start: Feature<Point>, end: Feature<Point>): boolean;
-/**
- * Modifies a FeatureCollection of LineStrings to break connections
- * between lines that share coordinates, by adjusting one of the shared
- * coordinates within a given tolerance.
- *
- * @param collection - The input FeatureCollection of LineStrings
- * @param tolerance - The amount by which to offset shared coordinates (in degrees)
- * @returns A new FeatureCollection with modified coordinates
- */
-export declare function disconnectLineStrings(collection: FeatureCollection<LineString>, tolerance: number): FeatureCollection<LineString>;

package/instructions.md

@@ -1,13 +0,0 @@
-Here we want to improve the performance by a consistently significant amount for the getRoute method TerraRoute class.
-
-We could achieve this via data structures or algorithmic changes to the class. Look into the academic literature of Shortest Path Algorithms to get good suggestions for what would yield speedups. Also think about how this would work most effectively in the JavaScript language.
-
-You can run tests with:
-
-npm run test
-
-You can assume unit tests are already passing, and do not need to run them until changes are made. You should not need to make any changes to the unit test files (.spec.ts files). In addition to unit tests, you can run a benchmark with the following command:
-
-npm run benchmark:loop
-
-This will run the benchmark tool 8 times. Run this first to get a comparison for future changes. You can assume the unit test