of \n// a coordinate node which is present on the network (i.e. the coordinate \n// exists in one of the linestrings)\nconst route = router.getRoute(startPoint, endPoint);\n\nconsole.log(\"Shortest route:\", JSON.stringify(route, null, 2));\n```\n\n## Terra Route Graph\n\nUnderstanding and debugging routing graphs can be complicated. There is an additional helper library called [Terra Route Graph](https://www.github.com/JamesLMilner/terra-route-graph) (`terra-route-graph`) which can be used to help understand the graphs you are working with.\n\n## Benchmarks\n\nThe benchmarks make use of a series out route example route networks from OSM in a moderate sized section of East London. It runs against the GeoJSON Path Finder library and also the ngraph.graph library. You can run the benchmarks yourself using:\n\n```\nnpm run benchmark\n```\n\nHere is an example output of a benchmark run for routing:\n\n\nTerra Route | ████ 91ms\nGeoJSON Path Finder | ██████████████████████ 537ms\nngraph.graph | ██████████████████████████████████████████████████ 1229ms\n
\n\nUsing default Haversine distance, Terra Route is approximately 5.75x faster than GeoJSON Path Finder with Haversine distance for A -> B path finding. If you pass in the CheapRuler distance metric (you can use the exposed `createCheapRuler` function), it is approximately x8 faster than GeoJSON Path Finder with Haversine distance. \n\nFor initialisation of the network, Terra Route is approximately 19x faster with Haversine than GeoJSON Path Finder. Terra Draw splits out instantiating the Class of the library from the actual graph building, which is done via `buildRouteGraph`. This allows you to defer graph creation to an appropriate time.\n\nTerra Route uses an [A* algorithm](https://en.wikipedia.org/wiki/A*_search_algorithm) landmark-assisted heuristics. By default it uses a [four-ary heap](https://en.wikipedia.org/wiki/D-ary_heap) for the underlying priority queue, although this is configurable. \n\n## Limitations\n\n- Terra Route does not currently support weighting functions.\n- Coordinates must be identical to be considered connected\n\n## Acknowledgements\n\nTerra Route is inspired by the the prior art of [geojson-path-finder](https://github.com/perliedman/geojson-path-finder/) and we use this library to help benchmark Terra Routes performance. \n\n## License\n\nMIT","readmeFilename":"README.md"}![\"Terra](\"./assets/logo.png\"){kind=logo}
\n