https://github.com/bradhowes/astar
A* path finding library in Swift
https://github.com/bradhowes/astar
algorithm pathfinding swift-package-manager swift5
Last synced: about 1 month ago
JSON representation
A* path finding library in Swift
- Host: GitHub
- URL: https://github.com/bradhowes/astar
- Owner: bradhowes
- License: mit
- Created: 2020-04-22T18:11:03.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T17:34:53.000Z (over 2 years ago)
- Last Synced: 2024-05-02T02:56:43.475Z (about 2 years ago)
- Topics: algorithm, pathfinding, swift-package-manager, swift5
- Language: Swift
- Size: 55.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[![CI][status]][ci]
[![][spiv]][spi]
[![][spip]][spi]
[![][mit]][license]
# AStar - an A* Library in Swift
The AStar library implements the classic A* path-finding algorithm. It uses a min priority queue for managing potential
paths, ordered by each path's known and estimated cost. The AStar class delegates map-related functionality to a
[GraphOracle](Sources/AStar/GraphOracle.swift) protocol to determine valid locations as well as the cost of adding a
location to a path candidate. An example of a `GraphOracle` can be found in the
[AStarTests.swift](Tests/AStarTests/AStarTests.swift) file.
API Documentation: [AStar][doc]
## Example
The AStar API is quite basic: there is just the static
[find](Sources/AStar/AStar.swift#L47) method which provides the
oracle to use, and the start and end locations for the path.
```swift
let oracle = Oracle(data: [
[.🌊, .🌲, .🌲, .🌲, .🚩, .🌲, .🌲, .🌲],
[.🌊, .🌲, .🌲, .🌲, .🌲, .🌲, .🌲, .🌲],
[.🌲, .🌲, .🌲, .🌲, .🗻, .🌲, .🌲, .🌲],
[.🌲, .🌲, .🗻, .🗻, .🗻, .🗻, .🗻, .🌲],
[.🌲, .🌲, .🗻, .🌲, .🏁, .🗻, .🌊, .🌊],
[.🌲, .🌲, .🗻, .🌲, .🗻, .🌲, .🌲, .🌊],
[.🌊, .🌲, .🗻, .🌲, .🌲, .🌲, .🗻, .🗻],
[.🌊, .🌲, .🌲, .🌲, .🌲, .🌲, .🗻, .🌲]
])
let start = Coord2D(x: 4, y: 0) // location of 🚩 above
let end = Coord2D(x: 4, y: 4) // location of 🏁 above
let path = AStar.find(
oracle: oracle,
start: start,
end: end
)
```
You supply an `oracle` entity that implements the `GraphOracle` protocol like the `Oracle` above. The oracle provides
information used by the A* algorithm to learn about the routes available from a location and the costs involved in
picking one. The start and end points indicate where to start the path and the goal to reach with the lowest possible
cost.
You get back an optional array of [Position](Sources/AStar/Position.swift) values. If this is `nil` then no path was found.
Otherwise, the array will have the map coordinates and their associated costs for the path that was found,
starting at `start` and ending with `end`.
Here is the visual representation of the map with the found path. The starting position appears as a red flag (🚩) and
the end position is a checkered flag (🏁). The path in between these two points contains an adventurer (🏃).
```swift
let image = mapData.asString(path: path!)
print(image)
🌊🌲🌲🌲🚩🌲🌲🌲
🌊🌲🌲🌲🌲🏃🌲🌲
🌲🌲🌲🌲🗻🌲🏃🌲
🌲🌲🗻🗻🗻🗻🗻🏃
🌲🌲🗻🌲🏁🗻🏃🌊
🌲🌲🗻🌲🗻🏃🌲🌊
🌊🌲🗻🌲🌲🌲🗻🗻
🌊🌲🌲🌲🌲🌲🗻🌲
```
For this example, the map contains three different terrain elements, each with their own cost for travelling into their square:
* 🌲 tree (1)
* 🌊 water (2)
* 🗻 boulder (99)
The algorithm minimizes the cost of traveling over terrain elements while at the same time trying to keep to the shortest path.
For comparison, here is what the algorithm finds when constrained to not use diagonal moves:
```swift
🌊🌲🌲🌲🚩🌲🌲🌲
🌊🌲🌲🏃🏃🌲🌲🌲
🌲🏃🏃🏃🗻🌲🌲🌲
🌲🏃🗻🗻🗻🗻🗻🌲
🌲🏃🗻🏃🏁🗻🌊🌊
🌲🏃🗻🏃🗻🌲🌲🌊
🌊🏃🗻🏃🌲🌲🗻🗻
🌊🏃🏃🏃🌲🌲🗻🌲
```
Note that this is not the only path to the flag in 16 moves -- there is another path to goes to the right but it goes over two
🌊 positions which increases the total cost of the route by 2. Thus the algorithm chose the one shown above due to the overal
lower cost of the journey.
## Dependencies
This package relies on the [PriorityQueue](https://github.com/bradhowes/PriorityQueue) package for Swift that provides a
min/max ordering of items using a binary heap.
[doc]: https://swiftpackageindex.com/bradhowes/astar/main/documentation/astar
[ci]: https://github.com/bradhowes/astar/actions/workflows/CI.yml
[status]: https://github.com/bradhowes/astar/workflows/CI/badge.svg
[spi]: https://swiftpackageindex.com/bradhowes/astar
[spiv]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbradhowes%2Fastar%2Fbadge%3Ftype%3Dswift-versions
[spip]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbradhowes%2Fastar%2Fbadge%3Ftype%3Dplatforms
[mit]: https://img.shields.io/badge/License-MIT-A31F34.svg
[license]: https://opensource.org/licenses/MIT