dijkstra_graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40d8dfafa22964edb55043f62194663df6ffe708
+  data.tar.gz: 7c76517bd99090caca0eb6bafb488c147851391f
+SHA512:
+  metadata.gz: 06cd0b89391979779f79bca07e34d8ea6e4917249d9d7d3a748f9c7843859e7b83acf6d6d248cc405e6a9683f3d3fbd5cbafb9283c4d5b8b626c483adf99cecf
+  data.tar.gz: 610fce885958f2aa28ae069448368fb080df6a24f74ab265d955b2d4739e4c281ea83bb5e13df4ca877c673979b7ed1bccba276c0fb08ce4517c9ac4092a2bbd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop

@@ -0,0 +1,2 @@
+--rails
+--display-cop-names

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/BlockLength:
+  Exclude:
+    - 'dijkstra_graph.gemspec'
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+cache: bundler
+
+before_install: gem install bundler -v 1.14.6
+before_script: bundle install
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dijkstra_graph.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Sayson
+
+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.

data/README.md

@@ -0,0 +1,66 @@
+# dijkstra_graph
+
+dijkstra_graph is a Ruby library implementing Dijkstra's shortest path algorithm.
+
+It uses a Fibonnaci heap for amortized O(1) updates of vertex distances, and an adjacency list for edges for O(1) look-up of the neighbours list for the current vertex.
+
+## DijkstraGraph::Graph API
+
+```ruby
+# Add directed edge (source, destination) to the graph with given weight
+# Requires that weight is a positive number
+add_edge(source, destination, weight)
+
+# Add undirected edge (vertex_a, vertex_b) to the graph with given weight
+# Requires that weight is a positive number
+add_undirected_edge(vertex_a, vertex_b, weight)
+
+# Remove directed edge (source, destination) from the graph
+remove_edge(source, destination)
+
+# Remove undirected edge (vertex_a, vertex_b) from the graph
+remove_undirected_edge(vertex_a, vertex_b)
+
+# Return true iff the graph contains directed edge (source, destination)
+contains_edge?(source, destination)
+
+# Returns the weight of directed edge (source, destination),
+# or returns Float::INFINITY if no such edge exists
+get_edge_weight(source, destination)
+
+# Returns the set of vertices v_i where edge (source, v_i) is in the graph
+get_adjacent_vertices(source)
+
+# Use Dijkstra's algorithm to find the shortest distances
+# from the start vertex to each of the other vertices
+#
+# Returns a hash of form { 'start' => 0, 'a' => 3, 'b' => 4 },
+# where result[v] indicates the shortest distance from start to v
+shortest_distances(start)
+
+# Use Dijkstra's algorithm to find the shortest paths
+# from the start vertex to each of the other vertices
+#
+# Returns a hash of form { 'c' => ['a', 'b', 'c'] }, where
+# result[v] indicates the shortest path from start to v
+shortest_paths(start)
+
+# Use Dijkstra's algorithm to find the shortest path
+# from the start vertex to the destination vertex
+#
+# Returns an array of vertices along the shortest path
+# of form ['a', 'b', 'c'], or [] if no such path exists
+shortest_path(start, destination)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msayson/dijkstra_graph.
+
+## License
+
+The weighted_graph library is open source and available under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dijkstra_graph'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dijkstra_graph.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dijkstra_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dijkstra_graph'
+  spec.version       = DijkstraGraph::VERSION
+  spec.authors       = ['Mark Sayson']
+  spec.email         = ['masayson@gmail.com']
+
+  spec.summary       = "A graph implementation supporting Dijkstra's " \
+                       'shortest path algorithm'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/msayson/dijkstra_graph'
+  spec.license       = 'MIT'
+
+  # Specify hosts this gem may be pushed to.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/gems/dijkstra_graph'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'PriorityQueue', '~> 0.1'
+  spec.add_dependency 'weighted_graph', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # Pry is a useful debugging utility, uncomment for local use.
+  #
+  # To use pry:
+  # - Uncomment the 'spec.add_development_dependency' line below
+  # - Add "require 'pry'" to the relevant Ruby source file
+  # - Add 'binding.pry' above the line you wish to break at
+  # - Run 'rake spec', and the console will break at that line
+  # spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/dijkstra_graph/graph.rb

@@ -0,0 +1,107 @@
+require 'priority_queue'
+require 'weighted_graph'
+
+require_relative '../util/path_util'
+
+# Dijstra graph library
+module DijkstraGraph
+  # A graph supporting Dijkstra's shortest path algorithm
+  #
+  # Edges are stored in an adjacency list for O(1) access
+  # to the neighbours list of a given vertex.
+  #
+  # Vertices 'to-visit' are stored in a priority queue that
+  # uses a Fibonacci heap to give O(1) insert, amortized O(1)
+  # decrease_priority, and amortized O(log n) delete_min.
+  # Priority represents path distance from the start vertex.
+  #
+  # The shortest distances found so far to each vertex are
+  # stored in a simple hash which gives O(1) read/write.
+  class Graph < WeightedGraph::PositiveWeightedGraph
+    # Initialize graph edges
+    def initialize
+      super
+    end
+
+    # Use Dijkstra's algorithm to find the shortest distances
+    # from the start vertex to each of the other vertices
+    #
+    # Returns a hash of form { 'start' => 0, 'a' => 3, 'b' => 4 },
+    # where result[v] indicates the shortest distance from start to v
+    def shortest_distances(start)
+      distances = Hash.new { Float::INFINITY } # Initial distances = Inf
+      queue = initialize_queue(start)          # Begin at start node
+      until queue.empty?
+        v, distances[v] = queue.delete_min     # Visit next closest vertex
+        update_distances_to_neighbours(v, distances, queue) # Update neighbours
+      end
+      distances
+    end
+
+    # Use Dijkstra's algorithm to find the shortest paths
+    # from the start vertex to each of the other vertices
+    #
+    # Returns a hash of form { 'c' => ['a', 'b', 'c'] }, where
+    # result[v] indicates the shortest path from start to v
+    def shortest_paths(start)
+      predecessors = {}                        # Initialize vertex predecessors
+      distances = Hash.new { Float::INFINITY } # Initialize distances to Inf
+      queue = initialize_queue(start)          # Initialize queue with start
+      until queue.empty?
+        # Visit next closest vertex and update neighbours
+        v, distances[v] = queue.delete_min
+        update_paths_to_neighbours(v, predecessors, distances, queue)
+      end
+      PathUtil.path_arrays(predecessors, start)
+    end
+
+    # Use Dijkstra's algorithm to find the shortest path
+    # from the start vertex to the destination vertex
+    #
+    # Returns an array of vertices along the shortest path
+    # of form ['a', 'b', 'c'], or [] if no such path exists
+    def shortest_path(start, dest)
+      predecessors = {}                        # Initialize vertex predecessors
+      distances = Hash.new { Float::INFINITY } # Initialize distances to Inf
+      queue = initialize_queue(start)          # Initialize queue with start
+      until queue.empty?
+        v, distances[v] = queue.delete_min     # Visit next closest node
+        return PathUtil.path_array(predecessors, start, dest) if v == dest
+        update_paths_to_neighbours(v, predecessors, distances, queue)
+      end
+      [] # No path found from start to dest
+    end
+
+    private
+
+    # Initialize priority queue with start vertex at distance = 0
+    def initialize_queue(start_vertex)
+      queue = PriorityQueue.new
+      queue[start_vertex] = 0
+      queue
+    end
+
+    # Update distances to neighbours of v and queue changed neighbours
+    def update_distances_to_neighbours(v, distances, queue)
+      distance_v = distances[v]
+      get_adjacent_vertices(v).each do |w|
+        distance_through_v = distance_v + get_edge_weight(v, w)
+        if distance_through_v < distances[w]
+          queue[w] = distances[w] = distance_through_v
+        end
+      end
+    end
+
+    # Update paths to neighbours of v and queue changed neighbours
+    def update_paths_to_neighbours(v, predecessors, distances, queue)
+      distance_v = distances[v]
+      get_adjacent_vertices(v).each do |w|
+        distance_through_v = distance_v + get_edge_weight(v, w)
+        if distance_through_v < distances[w]
+          queue[w] = distances[w] = distance_through_v
+          predecessors[w] = v
+        end
+      end
+    end
+  end
+end

data/lib/dijkstra_graph/version.rb

@@ -0,0 +1,3 @@
+module DijkstraGraph
+  VERSION = '0.1.0'.freeze
+end

data/lib/dijkstra_graph.rb

@@ -0,0 +1,6 @@
+require_relative './dijkstra_graph/graph'
+require_relative './dijkstra_graph/version'
+
+# A graph library supporting Dijkstra's shortest path algorithm
+module DijkstraGraph
+end

data/lib/util/path_util.rb

@@ -0,0 +1,37 @@
+# Utility functions for path manipulation
+module PathUtil
+  # Returns hash mapping each vertex to the shortest path
+  # from the start to that vertex
+  def self.path_arrays(predecessors, start)
+    paths = Hash.new { [] }
+    start_has_outgoing_edges = false
+    predecessors.each do |v, pred|
+      start_has_outgoing_edges = true if pred == start
+      paths[v] = path_to_vertex(paths, predecessors, start, v)
+    end
+    start_has_outgoing_edges ? paths : {}
+  end
+
+  # Returns array of vertices on shortest path from start to destination
+  def self.path_array(predecessors, start, destination)
+    path = []
+    curr_vertex = destination
+    loop do
+      path.push(curr_vertex)
+      return path.reverse if curr_vertex == start
+      curr_vertex = predecessors[curr_vertex]
+      return [] if curr_vertex.nil?
+    end
+  end
+
+  # Returns path to vertex, re-using existing paths
+  # if already have the path to v's predecessor
+  def self.path_to_vertex(paths, predecessors, start, v)
+    pred = predecessors[v]
+    if paths.include?(pred)
+      paths[pred] + [v]
+    else
+      path_array(predecessors, start, v)
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: dijkstra_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Sayson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: PriorityQueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: weighted_graph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A graph implementation supporting Dijkstra's shortest path algorithm
+email:
+- masayson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dijkstra_graph.gemspec
+- lib/dijkstra_graph.rb
+- lib/dijkstra_graph/graph.rb
+- lib/dijkstra_graph/version.rb
+- lib/util/path_util.rb
+homepage: https://github.com/msayson/dijkstra_graph
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/gems/dijkstra_graph
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A graph implementation supporting Dijkstra's shortest path algorithm
+test_files: []