https://github.com/geocrystal/dijkstra

Dijkstra's algorithm using a priority queue in Crystal
https://github.com/geocrystal/dijkstra

crystal dijkstra dijkstra-algorithm priority-queue

Last synced: about 2 months ago
JSON representation

Dijkstra's algorithm using a priority queue in Crystal

• Host: GitHub
• URL: https://github.com/geocrystal/dijkstra
• Owner: geocrystal
• License: mit
• Created: 2021-12-22T17:16:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-30T12:24:25.000Z (about 1 year ago)
• Last Synced: 2024-05-07T00:04:53.419Z (about 1 year ago)
• Topics: crystal, dijkstra, dijkstra-algorithm, priority-queue
• Language: Crystal
• Homepage:
• Size: 4.75 MB
• Stars: 14
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dijkstra

[![Crystal CI](https://github.com/geocrystal/dijkstra/actions/workflows/crystal.yml/badge.svg)](https://github.com/geocrystal/dijkstra/actions/workflows/crystal.yml)

[![License](https://img.shields.io/github/license/geocrystal/dijkstra.svg)](https://github.com/geocrystal/dijkstra/blob/master/LICENSE)

Dijkstra's algorithm using a priority queue in Crystal.

[Dijkstra's algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm) is an algorithm for finding the shortest paths between nodes in a graph, which may represent, for example, road networks.

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     dijkstra:

       github: geocrystal/dijkstra

   ```

2. Run `shards install`

## Usage

![image](https://github.com/geocrystal/dijkstra/blob/main/samples/image.png?raw=true)

```crystal

require "dijkstra"

gr = Dijkstra::Graph(Char).new(directed: true)

gr.add_edge('a', 'b', 7)

gr.add_edge('a', 'c', 9)

gr.add_edge('a', 'f', 14)

gr.add_edge('b', 'c', 10)

gr.add_edge('b', 'd', 15)

gr.add_edge('c', 'd', 11)

gr.add_edge('c', 'f', 2)

gr.add_edge('d', 'e', 6)

gr.add_edge('e', 'f', 9)

gr.shortest_path('a', 'e')

# => {26, ['a', 'c', 'd', 'e']}

# Directed   : a -> c(9) -> d(20) -> e(26)

# Undirected : a -> c(9) -> f(11) -> e(20)

```

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer