https://github.com/nervgh/astar-algorithm

An almost universal implementation of A* search algorithm in JavaScript
https://github.com/nervgh/astar-algorithm

Last synced: about 1 month ago
JSON representation

An almost universal implementation of A* search algorithm in JavaScript

• Host: GitHub
• URL: https://github.com/nervgh/astar-algorithm
• Owner: nervgh
• License: mit
• Created: 2017-07-22T12:02:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-27T06:02:57.000Z (over 7 years ago)
• Last Synced: 2024-10-05T01:14:07.345Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# astar-algorithm

An almost universal implementation of [A* search algorithm](https://en.wikipedia.org/wiki/A*_search_algorithm#Example) in JavaScript.

[![NPM version][npm-image]][npm-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

### Requirements

+ ECMAScript 2015+

### Usage

```js

// 1)

const astar = require('astar-algorithm')

// 2)

let callbacks = {

  // It should return id / key / hash for a node

  id(node) {

    // return {String} or what you want

  },

  // It should check: is a node is the goal?

  isGoal(node) {

    // return {Boolean}

  },

  // It should return an array of successors / neighbors / children

  getSuccessors(node) {

    // return {Array} of nodes

  },

  // g(x). It should return the cost of path between two nodes

  distance(nodeA, nodeB) {

    // return {Number}

  },

  // h(x). It should return the cost of path from a node to the goal

  estimate(node, goal) {

    // return {Number}

  }

}

// 3)

let path = astar(start, goal, callbacks)

```

See more examples [there](test/index.js).

[npm-image]: https://img.shields.io/npm/v/astar-algorithm.svg?style=flat

[npm-url]: https://npmjs.org/package/astar-algorithm

[travis-image]: https://img.shields.io/travis/nervgh/astar-algorithm.svg?style=flat

[travis-url]: https://travis-ci.org/nervgh/astar-algorithm

[coveralls-image]: https://img.shields.io/coveralls/nervgh/astar-algorithm.svg?style=flat

[coveralls-url]: https://coveralls.io/r/nervgh/astar-algorithm?branch=master