Merge pull request #13 from digitsensitive/bugfix/rename-manhatten-to-manhattan

Bugfix manhatten - manhattan

Author: digitsensitive

CHANGELOG.md

@@ -10,10 +10,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ---
 
+## [1.2.2] - 2020-08-06
+
+### Changed
+- Update astar-typescript version from 1.2.0 to 1.2.1 in example 
+
+### Fixed
+- Fix misspelling: It is not manhatt**e**n, it is manhatt**a**n
+  (Thank you @spassvogel)
+
+---
+
 ## [1.2.1] - 2020-08-06
 
 ### Changed
-- Update astar-typescript version from 1.1.9 to 1.2.0 in example 
+- Update astar-typescript version from 1.1.9 to 1.2.0 in example
 
 ---
 

README.md

@@ -142,15 +142,15 @@ this.aStarInstance = new AStarFinder({
 });
 ```
 
-Set the `heuristic function` (Manhatten, Euclidean, Chebyshev or Octile):
+Set the `heuristic function` (Manhattan, Euclidean, Chebyshev or Octile):
 
 ``` ts
 this.aStarInstance = new AStarFinder({
   grid: {
     width: 8,
     height: 8
   },
-  heuristicFunction: "Manhatten"
+  heuristicFunction: "Manhattan"
 });
 ```
 

example/package.json

@@ -25,7 +25,7 @@
     "webpack-dev-server": "3.11.0"
   },
   "dependencies": {
-    "astar-typescript": "1.2.0",
+    "astar-typescript": "1.2.1",
     "phaser": "3.24.1",
     "dat.gui": "0.7.7"
   },

example/scenes/main-scene.ts

@@ -65,7 +65,7 @@ export class MainScene extends Phaser.Scene {
       this.aMatrix[i] = Array<number>(this.gridWidth).fill(0);
     }
     this.diagonalMovement = false;
-    this.heuristic = 'Manhatten';
+    this.heuristic = 'Manhattan';
     this.weight = 1;
     this.aStarInstance = new AStarFinder({
       grid: {
@@ -158,7 +158,7 @@ export class MainScene extends Phaser.Scene {
         this.destroyPathAndSurroundingNodes();
         this.resetAStarInstance();
       },
-      ['Manhatten', 'Euclidean', 'Chebyshev', 'Octile']
+      ['Manhattan', 'Euclidean', 'Chebyshev', 'Octile']
     );
 
     this.datGuiServiceInstance.addNumberController(

example/yarn.lock

@@ -330,10 +330,10 @@ assign-symbols@^1.0.0:
   resolved "https://registry.yarnpkg.com/assign-symbols/-/assign-symbols-1.0.0.tgz#59667f41fadd4f20ccbc2bb96b8d4f7f78ec0367"
   integrity sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=
 
-astar-typescript@1.2.0:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/astar-typescript/-/astar-typescript-1.2.0.tgz#ee6cec26718b25cb6ba20f238d1b352a4e35e671"
-  integrity sha512-nidjd+JgpyXtrIRaCtY9joUygFQtaSDQ0q23DbHd7RUHK9g3zsFVxIonqqdDHJs4AmIa2HAldFoiiPw4SlGOdQ==
+astar-typescript@1.2.1:
+  version "1.2.1"
+  resolved "https://registry.yarnpkg.com/astar-typescript/-/astar-typescript-1.2.1.tgz#3a38e85f04511c88aff92a7dbba4ff4a14cc4cc3"
+  integrity sha512-DXK58vIE5jQmIqGI1szc0pMgaTF+BgFeHGcitZmvIiAFaOPAhd9BbJI8Mgy84GT1yh0Th7KOIf71WMbQ57g0vw==
   dependencies:
     lodash "4.17.19"
 

lib/core/heuristic.ts

@@ -27,9 +27,11 @@ export function calculateHeuristic(
   const dy = Math.abs(pos1.y - pos0.y);
 
   switch (heuristicFunction) {
+    // TODO: Remove Manhatten in next major release
     case 'Manhatten':
+    case 'Manhattan':
       /**
-       * Calculate the Manhatten distance.
+       * Calculate the Manhattan distance.
        * Generally: Overestimates distances because diagonal movement not taken into accout.
        * Good for a 4-connected grid (diagonal movement not allowed)
        */

lib/finders/astar-finder.ts

@@ -43,7 +43,7 @@ export class AStarFinder {
       aParams.diagonalAllowed !== undefined ? aParams.diagonalAllowed : true;
 
     // Set heuristic function
-    this.heuristic = aParams.heuristic ? aParams.heuristic : 'Manhatten';
+    this.heuristic = aParams.heuristic ? aParams.heuristic : 'Manhattan';
 
     // Set if start node included
     this.includeStartNode =

lib/types/astar.types.ts

@@ -1 +1,6 @@
-export type Heuristic = 'Manhatten' | 'Euclidean' | 'Chebyshev' | 'Octile';
+export type Heuristic =
+  | 'Manhatten'
+  | 'Manhattan'
+  | 'Euclidean'
+  | 'Chebyshev'
+  | 'Octile';

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "astar-typescript",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A*(a-star) pathfinding in TypeScript",
   "keywords": [
     "A-star",
@@ -32,4 +32,4 @@
     "url": "git+https://github.com/digitsensitive/astar-typescript.git"
   },
   "homepage": "https://github.com/digitsensitive/astar-typescript#readme"
-}
+}