Skip to content

Commit

Permalink
example: add a path finding algorithm visualizer using gg (#20060)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuyi-hao committed Dec 28, 2023
1 parent 2dce525 commit 680b0d4
Show file tree
Hide file tree
Showing 4 changed files with 533 additions and 0 deletions.
21 changes: 21 additions & 0 deletions examples/gg/path_finding_algorithm_visualizer/LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2023] [Yuyi Hao]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 33 additions & 0 deletions examples/gg/path_finding_algorithm_visualizer/README.md
@@ -0,0 +1,33 @@
# A* path finding algorithm visualizer
This is a simple visualizer for an A* path finding algorithm written in V.

# Quick start

```console
# to run:
$ v run aStar.v

# to just compile:
$ v aStar.v

# then to run:
$ ./aStar
```

# Controls

- `q` : To quit the application
- `c`: clear the grid and start from new one
- `space`: initialize path finding algorithm


# Demo
![Demo image of the algorithm](screenshot.png)

# 🔴🔴🔴🔴 Area of improvments 🔴🔴🔴🔴🔴

- 🚧 Under Construction: We are using heap, but that is not correctly
implemented, since instead of O(log(n)) it takes O(n). For that reason,
having a bigger grid size, will break the application.

- 🌱 Growth Opportunity: make it responsive.

0 comments on commit 680b0d4

Please sign in to comment.