feat: added Astar Search Algorithm in Graphs by mathangpeddi · Pull Request #1739 · TheAlgorithms/JavaScript

mathangpeddi · 2024-10-20T01:27:12Z

know more

Describe your change:

Add an algorithm?
Fix a bug or typo in an existing algorithm?
Documentation change?

Checklist:

I have read CONTRIBUTING.md.
This pull request is all my own work -- I have not plagiarized.
I know that pull requests will not be merged if they fail the automated tests.
This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
All new JavaScript files are placed inside an existing directory.
All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames.
Example:UserProfile.js is allowed but userprofile.js,Userprofile.js,user-Profile.js,userProfile.js are not
All new algorithms have a URL in their comments that points to Wikipedia or another similar explanation.
If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

codecov-commenter · 2024-10-20T01:30:37Z

Codecov Report

Attention: Patch coverage is 0% with 207 lines in your changes missing coverage. Please review.

Project coverage is 83.88%. Comparing base (55ff0ad) to head (6142d3d).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
Graphs/Astar.js	0.00%	207 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1739      +/-   ##
==========================================
- Coverage   84.76%   83.88%   -0.88%     
==========================================
  Files         378      379       +1     
  Lines       19738    19945     +207     
  Branches     2957     2958       +1     
==========================================
  Hits        16731    16731              
- Misses       3007     3214     +207

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mathangpeddi · 2024-10-20T15:56:38Z

@appgurueu @raklaptudirm
Can you please check this and let me know if this can be added to Graph Algorithms?

appgurueu · 2024-10-20T18:44:24Z

Graphs/Astar.js

@@ -0,0 +1,107 @@
+/**
+ * Author: Mathang Peddi


Please use JSDoc annotations like @author.

Have changed it to @author: Mathang Peddi
Do I need to make any other change here?

appgurueu · 2024-10-20T18:44:31Z

Graphs/Astar.js

@@ -0,0 +1,107 @@
+/**
+ * Author: Mathang Peddi
+ * A* Search Algorithm implementation in JavaScript


Suggested change

* A* Search Algorithm implementation in JavaScript

Removed this line.

appgurueu · 2024-10-20T18:45:13Z

Graphs/Astar.js

+ * It uses graph data structure.
+ */
+
+function createGraph(V, E) {


This function is unnecessary. Just take the graph in adjacency list representation. There is also no need to restrict this to undirected graphs.

Removed this function, created an adjacency list and directly passed it to the function.

appgurueu · 2024-10-20T18:46:12Z

Graphs/Astar.js

+}
+
+// Heuristic function to estimate the cost to reach the goal
+// You can modify this based on your specific problem, for now, we're using Manhattan distance


This is not a useful manhattan distance. This is just the absolute distance between vertex IDs. Instead you want some kind of associated "points" (say, in 2d or 3d space) for which you compute distances.

In any case, the heuristic function should probably be a (mandatory) parameter.

I have made the changes, I am using Euclidian Distance here, do I need to make any other change here?

appgurueu · 2024-10-20T18:46:46Z

Graphs/Astar.js

+  return Math.abs(a - b)
+}
+
+function aStar(graph, V, src, target) {


Again, just take the graph in adjacency list representation. V is then redundant (and also conflicts with our naming scheme).

Changed it.

appgurueu · 2024-10-20T18:48:29Z

Graphs/Astar.js

+    }
+  }
+
+  return [] // Return empty path if there's no path to the target


Should be null instead.

appgurueu · 2024-10-20T18:49:02Z

Graphs/Astar.js

+
+function aStar(graph, V, src, target) {
+  const openSet = new Set([src]) // Nodes to explore
+  const cameFrom = Array(V).fill(-1) // Keep track of path


Use null instead of -1, it's the idiomatic value to use in JS for absence of a value.

appgurueu · 2024-10-20T18:49:55Z

Graphs/Astar.js

+    openSet.delete(current)
+
+    // Explore neighbors
+    for (let i = 0; i < graph[current].length; i++) {


Just do for (const [neighbor, weight] of graph[current])

appgurueu · 2024-10-20T18:50:35Z

Graphs/Astar.js

+
+module.exports = { createGraph, aStar }
+
+// const V = 9


Should be a test instead.

Removed this part, do you want me to add a Astar.test.js file as a part of Unit Testing?

appgurueu · 2024-10-20T18:51:34Z

Graphs/Astar.js

+  return [] // Return empty path if there's no path to the target
+}
+
+module.exports = { createGraph, aStar }


Suggested change

module.exports = { createGraph, aStar }

export { aStar }

mathangpeddi · 2024-10-21T19:14:54Z

@appgurueu Can you check if all the changes are proper?

appgurueu · 2024-10-23T16:23:38Z

Graphs/Astar.js

+}
+
+// Priority Queue (Min-Heap) implementation
+class PriorityQueue {


Please import this (we have a priority queue implementation in this repo) rather than reimplementing it.

appgurueu · 2024-10-23T16:24:12Z

Graphs/Astar.js

+  }
+}
+
+function aStar(graph, src, target, points) {


Where are these parameters documented? Also why is the heuristic function not a parameter (which may default to a simple euclidean heuristic)?

appgurueu · 2024-10-23T16:25:25Z

Graphs/Astar.js

+      return path.reverse()
+    }
+
+    // Explore neighbors using destructuring for cleaner code


the "using destructuring for cleaner code part" is obvious

appgurueu · 2024-10-23T16:25:42Z

Graphs/Astar.js

+  return null // Return null if there's no path to the target
+}
+
+// Define the graph as an adjacency list


This should be a proper test case.

Added Astar Search Algorithm

ff23c98

mathangpeddi requested review from appgurueu and raklaptudirm as code owners October 20, 2024 01:27

mathangpeddi added 2 commits October 20, 2024 10:20

Modified Astar code

3c30bce

Fixed lint issue

a9e17ed

mathangpeddi changed the title ~~Added Astar Search Algorithm~~ feat: added Astar Search Algorithm in Graphs Oct 20, 2024

appgurueu requested changes Oct 20, 2024

View reviewed changes

mathangpeddi added 3 commits October 20, 2024 18:48

Review changes

90eac72

Fixed lint issues

45b8231

Adjusted lint issue

6142d3d

appgurueu reviewed Oct 23, 2024

View reviewed changes

Uh oh!

Conversation

mathangpeddi commented Oct 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your change:

Checklist:

Uh oh!

codecov-commenter commented Oct 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mathangpeddi commented Oct 20, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mathangpeddi commented Oct 21, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

appgurueu Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mathangpeddi commented Oct 20, 2024 •

edited

Loading

codecov-commenter commented Oct 20, 2024 •

edited

Loading

appgurueu Oct 23, 2024 •

edited

Loading