abuelo 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fec3a84e6365d1dabdbb0a97dfaae5c5f616dfe
-  data.tar.gz: d687748513f8e7aabb0eae7fbfc186949dc61334
+  metadata.gz: 353ed08a9040bffa3feb4b0849ac570528d34e14
+  data.tar.gz: 7a851f16545babb62022b33316b08cf2bd26fa08
 SHA512:
-  metadata.gz: edca527570d0e4775ebaf20458dfdfb393c3ba54e0d250eaccae09d9476d68e249c62dd7620458824d4030b0d1956e4eb09b7da4d30d7704240116d20d8b2c3f
-  data.tar.gz: d7bc96b07f9ded38385e0a24a1201edc4f7ce6788596c79bbf3ee7ce99c580e274c916ad972a98e2e12940f47c2f9195e8615ec3cc2e7f2ae06756c106ef71ab
+  metadata.gz: 1cfa8bf9e255e57572166984c86fd06dddd04dd8e16ae0c4757cb2da285ba23a534e2499ffe282bd564d342c85c77c20d05b6f845fc259698a29317d7b706553
+  data.tar.gz: a31822a057e438e778c25b5fc305367bbb8f82793aa654bb78d61c1b088b11924552d3c25ce780e16df3ef41942ae326bea84a63b6a8cdf49d0b934972a7c92c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.1.0 - 2016-02-24
+* implemented Dijkstra's algorithm
+
 # 0.0.2 - 2016-02-21
 * new possibility to build a graph: adjacency matrix
 * added code of conduct

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at [cache.zero+abuelo@mailbox.org]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -71,4 +71,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abuelo (0.0.2)
+    abuelo (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
 # Abuelo
 [![Build Status](https://travis-ci.org/dirkholzapfel/abuelo.svg?branch=master)](https://travis-ci.org/dirkholzapfel/abuelo)
+[![ProjectTalk](http://www.projecttalk.io/images/gh_badge-3e578a9f437f841de7446bab9a49d103.svg?vsn=d)] (http://www.projecttalk.io/boards/dirkholzapfel%2Fabuelo?utm_campaign=gh-badge&utm_medium=badge&utm_source=github)
+[![Join the chat at https://gitter.im/dirkholzapfel/abuelo](https://badges.gitter.im/dirkholzapfel/abuelo.svg)](https://gitter.im/dirkholzapfel/abuelo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Abuelo is a graph theory library written in Ruby that allows you to build a representation of a graph.
 
@@ -87,9 +89,9 @@ Be aware that you have to provide all symmetric edges in an adjacency matrix for
 
 ```ruby
 adjacency_matrix = <<-matrix
-   0 42  0
-  42  0 23
-   0 23  0
+  0  42 0
+  42 0  23
+  0  23 0
   matrix
 
 # The above matrix corresponds to this internal representation
@@ -108,9 +110,9 @@ graph.find_edge(node_1, node_2).weight # => 42
 #### Directed graphs
 ```ruby
 adjacency_matrix = <<-matrix
-  0 42  0
-  0  0 23
-  0  0  0
+  0 42 0
+  0 0  23
+  0 0  0
   matrix
 
 # The above matrix corresponds to this internal representation
@@ -123,16 +125,40 @@ adjacency_matrix = <<-matrix
 
 graph = Abuelo::Graph.new(adjacency_matrix: adjacency_matrix, directed: true)
 ```
+## Algorithms
+### Dijkstra
+This is the example from https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
+
+<a title="By Ibmua (Work by uploader.) [Public domain], via Wikimedia Commons" href="https://commons.wikimedia.org/wiki/File%3ADijkstra_Animation.gif"><img width="256" alt="Dijkstra Animation" src="https://upload.wikimedia.org/wikipedia/commons/5/57/Dijkstra_Animation.gif"/></a>
+
+```ruby
+adjacency_matrix = <<-matrix
+  0  7  9  0  0 14
+  7  0  10 15 0 0
+  9  10 0  11 0 2
+  0  15 11 0  6 0
+  0  0  0  6  0 9
+  14 0  2  0  9 0
+matrix
+
+graph = Abuelo::Graph.new(adjacency_matrix: adjacency_matrix)
+start_node = graph.find_node_by_name('node 1')
+node_5 = graph.find_node_by_name('node 5')
+
+dijkstra = Abuelo::Algorithms::Dijkstra.new(graph, start_node)
+dijkstra.shortest_distance_to(node_5) # => 20
+dijkstra.shortest_path_to(node_5).map(&:to_s) # => ['node 1', 'node 3', 'node 6', 'node 5']
+```
 
 ## Documentation
-[YARD](http://yardoc.org) documentation is available at [rubydoc](http://www.rubydoc.info/gems/abuelo).
+[YARD](http://yardoc.org) documentation is available at [rubydoc](http://www.rubydoc.info/github/dirkholzapfel/abuelo).
 
 ## Future
 * Implement graph algorithms
   * [Kruskal's algorithm](https://en.wikipedia.org/wiki/Kruskal%27s_algorithm)
   * [Prim's algorithm](https://en.wikipedia.org/wiki/Prim%27s_algorithm)
-  * [Dijkstra's algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm)
 * Implement visualization of graph
+* Add priority queue to Dijkstra's algorithm implementation
 
 ## Installation
 Abuelo is a gem which you can install with:
@@ -146,7 +172,7 @@ gem 'abuelo'
 ```
 
 ## Credits
-Dirk Holzapfel
+Dirk Holzapfel ([@cachezero](https://twitter.com/cachezero))
 
 [cachezero.net](http://cachezero.net)
 

data/abuelo.gemspec

@@ -4,7 +4,6 @@ require 'abuelo/version'
 Gem::Specification.new do |spec|
   spec.name        = 'abuelo'
   spec.version     = Abuelo::VERSION
-  spec.date        = '2016-01-10'
   spec.summary     = 'Abuelo'
   spec.description = 'Abuelo is a graph theory library.'
   spec.authors     = ['Dirk Holzapfel']

data/lib/abuelo.rb

@@ -1,4 +1,5 @@
 require 'abuelo/graph'
 require 'abuelo/node'
 require 'abuelo/edge'
+require 'abuelo/algorithms/dijkstra'
 require 'abuelo/exceptions/exceptions'

data/lib/abuelo/algorithms/dijkstra.rb

@@ -0,0 +1,96 @@
+module Abuelo
+  module Algorithms
+    #
+    # Class Dijkstra implements Dijkstra's algorithm for finding shortest paths between
+    # nodes in a graph.
+    #
+    # See https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
+    #
+    # Possible improvement: use a priority queue to improve runtime.
+    #
+    # @author Dirk Holzapfel <cache.zero@mailbox.org>
+    #
+    class Dijkstra
+      #
+      # @param [Abuelo::Graph] graph
+      # @param [Abuelo::Node] start_node
+      #
+      # @raise [Abuelo::Exceptions::NoNodeError] if the start_node is
+      #   not a Abuelo::Node
+      #
+      def initialize(graph, start_node)
+        if !start_node.is_a?(Abuelo::Node)
+          raise Abuelo::Exceptions::NoNodeError.new('start_node is not a Abuelo::Node')
+        end
+
+        @graph          = graph
+        @start_node     = start_node
+        @distances      = {}
+        @previous_nodes = {}
+        init
+        process
+      end
+
+      #
+      # Calculates the shortest distance from the start_node to the given node.
+      #
+      # @param [Abuelo::Node] node
+      #
+      # @return [Numeric, nil] the distance to the node or nil if node is unreachable
+      #
+      def shortest_distance_to(node)
+        @distances[node]
+      end
+
+      #
+      # Calculates the shortest path from the start_node to the given node.
+      #
+      # @param [Abuelo::Node] node
+      #
+      # @return [Array<Abuelo::Node>, nil] list of nodes from start_node to the given node
+      #  that are a possible solution for the shortest path. Nil if node is unreachable.
+      #
+      def shortest_path_to(node)
+        return nil if @previous_nodes[node].nil?
+
+        nodes = [node]
+        while previous_node = @previous_nodes[nodes[0]] do
+          nodes.unshift(previous_node)
+        end
+
+        nodes
+      end
+
+
+      private
+
+      def init
+        @graph.nodes.each do |node|
+          @distances[node] = Float::INFINITY
+          @previous_nodes[node] = nil
+        end
+
+        @distances[@start_node] = 0
+      end
+
+      def process
+        unvisited_nodes = @graph.nodes
+
+        until unvisited_nodes.empty? do
+          node = unvisited_nodes.min_by { |node| @distances[node] }
+          unvisited_nodes.delete(node)
+
+          unvisited_neighbours = unvisited_nodes & node.neighbours
+          unvisited_neighbours.each do |neighbour|
+            new_edge_weight = @graph.find_edge(node, neighbour).weight
+            alternative_distance = @distances[node] + new_edge_weight
+            if alternative_distance < @distances[neighbour]
+              @distances[neighbour] = alternative_distance
+              @previous_nodes[neighbour] = node
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abuelo/exceptions/exceptions.rb

@@ -5,5 +5,8 @@ module Abuelo
 
     class EdgeAlreadyExistsError < StandardError
     end
+
+    class NoNodeError < StandardError
+    end
   end
 end

data/lib/abuelo/graph.rb

@@ -1,6 +1,6 @@
 module Abuelo
   #
-  # Class Graph provides a representation of a directed graph.
+  # Class Graph provides a representation of a graph.
   #
   # A graph consists of nodes (= vertices, points) and edges (= lines, arcs).
   # The graph may be undirected or directed. For the sake of simplicity Abuelo sticks

data/lib/abuelo/version.rb

@@ -1,3 +1,3 @@
 module Abuelo
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/spec/algorithms/dijkstra_spec.rb

@@ -0,0 +1,252 @@
+require 'spec_helper'
+
+RSpec.describe Abuelo::Algorithms::Dijkstra do
+  describe '#initialize(graph, start_node)' do
+    it 'raises an error if the start_node is not a Abuelo::Node' do
+      expect do
+        described_class.new(Abuelo::Graph.new, 'foo')
+      end.to raise_error(Abuelo::Exceptions::NoNodeError)
+    end
+  end
+
+  context 'undirected graph' do
+    # This is the example from https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
+    adjacency_matrix = <<-matrix
+      0  7  9  0  0 14
+      7  0  10 15 0 0
+      9  10 0  11 0 2
+      0  15 11 0  6 0
+      0  0  0  6  0 9
+      14 0  2  0  9 0
+    matrix
+    
+    let(:undirected_graph) do
+      Abuelo::Graph.new(adjacency_matrix: adjacency_matrix)
+    end
+    let(:start_node) { undirected_graph.find_node_by_name('node 1') }
+    let(:dijkstra)   { described_class.new(undirected_graph, start_node) }
+
+    describe '#shortest_distance_to(node)' do
+      it 'is 0 for the start node' do
+        expect(dijkstra.shortest_distance_to(start_node)).to eq 0
+      end
+
+      it 'is Float::INFINITY for an unreachable node' do
+        unreachable_node = Abuelo::Node.new('unreachable node')
+        undirected_graph.add_node(unreachable_node)
+        expect(dijkstra.shortest_distance_to(unreachable_node)).to eq Float::INFINITY
+      end
+
+      it 'is nil when the node is not part of the graph' do
+        unknown_node = Abuelo::Node.new('foo')
+        expect(dijkstra.shortest_distance_to(unknown_node)).to be nil
+      end
+
+      context 'wikipedia example' do
+        it 'is 0 for node 1' do
+          node = undirected_graph.find_node_by_name('node 1')
+          expect(dijkstra.shortest_distance_to(node)).to eq 0
+        end
+
+        it 'is 7 for node 2' do
+          node = undirected_graph.find_node_by_name('node 2')
+          expect(dijkstra.shortest_distance_to(node)).to eq 7
+        end
+
+        it 'is 9 for node 3' do
+          node = undirected_graph.find_node_by_name('node 3')
+          expect(dijkstra.shortest_distance_to(node)).to eq 9
+        end
+
+        it 'is 20 for node 4' do
+          node = undirected_graph.find_node_by_name('node 4')
+          expect(dijkstra.shortest_distance_to(node)).to eq 20
+        end
+
+        it 'is 20 for node 5' do
+          node = undirected_graph.find_node_by_name('node 5')
+          expect(dijkstra.shortest_distance_to(node)).to eq 20
+        end
+
+        it 'is 11 for node 6' do
+          node = undirected_graph.find_node_by_name('node 6')
+          expect(dijkstra.shortest_distance_to(node)).to eq 11
+        end
+      end
+    end
+
+    describe '#shortest_path_to(node)' do
+      it 'is nil for the start node' do
+        expect(dijkstra.shortest_path_to(start_node)).to be nil
+      end
+
+      it 'is nil for an unreachable node' do
+        unreachable_node = Abuelo::Node.new('unreachable node')
+        undirected_graph.add_node(unreachable_node)
+        expect(dijkstra.shortest_path_to(unreachable_node)).to be nil
+      end
+
+      it 'is nil when the node is not part of the graph' do
+        unknown_node = Abuelo::Node.new('foo')
+        expect(dijkstra.shortest_path_to(unknown_node)).to be nil
+      end
+
+      context 'wikipedia example' do
+        it 'solves the problem for node 1' do
+          node = undirected_graph.find_node_by_name('node 1')
+          expect(dijkstra.shortest_path_to(node)).to be nil
+        end
+
+        it 'solves the problem for node 2' do
+          node = undirected_graph.find_node_by_name('node 2')
+          shortest_path = ['node 1', 'node 2']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 3' do
+          node = undirected_graph.find_node_by_name('node 3')
+          shortest_path = ['node 1', 'node 3']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 4' do
+          node = undirected_graph.find_node_by_name('node 4')
+          shortest_path = ['node 1', 'node 3', 'node 4']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 5' do
+          node = undirected_graph.find_node_by_name('node 5')
+          shortest_path = ['node 1', 'node 3', 'node 6', 'node 5']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 6' do
+          node = undirected_graph.find_node_by_name('node 6')
+          shortest_path = ['node 1', 'node 3', 'node 6']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+      end
+    end
+  end
+
+  context 'directed graph' do
+    adjacency_matrix = <<-matrix
+      0  7 0  0  0 0
+      0  0 10 15 0 0
+      9  0 0  11 0 2
+      0  0 11 0  6 0
+      0  0 0  0  0 0
+      14 0 0  0  9 0
+    matrix
+    
+    let(:directed_graph) do
+      Abuelo::Graph.new(adjacency_matrix: adjacency_matrix, directed: true)
+    end
+    let(:start_node) { directed_graph.find_node_by_name('node 1') }
+    let(:dijkstra)   { described_class.new(directed_graph, start_node) }
+
+    describe '#shortest_distance_to(node)' do
+      it 'is 0 for the start node' do
+        expect(dijkstra.shortest_distance_to(start_node)).to eq 0
+      end
+
+      it 'is Float::INFINITY for an unreachable node' do
+        unreachable_node = Abuelo::Node.new('unreachable node')
+        directed_graph.add_node(unreachable_node)
+        expect(dijkstra.shortest_distance_to(unreachable_node)).to eq Float::INFINITY
+      end
+
+      it 'is nil when the node is not part of the graph' do
+        unknown_node = Abuelo::Node.new('foo')
+        expect(dijkstra.shortest_distance_to(unknown_node)).to be nil
+      end
+
+      context 'example' do
+        it 'is 0 for node 1' do
+          node = directed_graph.find_node_by_name('node 1')
+          expect(dijkstra.shortest_distance_to(node)).to eq 0
+        end
+
+        it 'is 7 for node 2' do
+          node = directed_graph.find_node_by_name('node 2')
+          expect(dijkstra.shortest_distance_to(node)).to eq 7
+        end
+
+        it 'is 9 for node 3' do
+          node = directed_graph.find_node_by_name('node 3')
+          expect(dijkstra.shortest_distance_to(node)).to eq 17
+        end
+
+        it 'is 20 for node 4' do
+          node = directed_graph.find_node_by_name('node 4')
+          expect(dijkstra.shortest_distance_to(node)).to eq 22
+        end
+
+        it 'is 20 for node 5' do
+          node = directed_graph.find_node_by_name('node 5')
+          expect(dijkstra.shortest_distance_to(node)).to eq 28
+        end
+
+        it 'is 11 for node 6' do
+          node = directed_graph.find_node_by_name('node 6')
+          expect(dijkstra.shortest_distance_to(node)).to eq 19
+        end
+      end
+    end
+
+    describe '#shortest_path_to(node)' do
+      it 'is nil for the start node' do
+        expect(dijkstra.shortest_path_to(start_node)).to be nil
+      end
+
+      it 'is nil for an unreachable node' do
+        unreachable_node = Abuelo::Node.new('unreachable node')
+        directed_graph.add_node(unreachable_node)
+        expect(dijkstra.shortest_path_to(unreachable_node)).to be nil
+      end
+
+      it 'is nil when the node is not part of the graph' do
+        unknown_node = Abuelo::Node.new('foo')
+        expect(dijkstra.shortest_path_to(unknown_node)).to be nil
+      end
+
+      context 'example' do
+        it 'solves the problem for node 1' do
+          node = directed_graph.find_node_by_name('node 1')
+          expect(dijkstra.shortest_path_to(node)).to be nil
+        end
+
+        it 'solves the problem for node 2' do
+          node = directed_graph.find_node_by_name('node 2')
+          shortest_path = ['node 1', 'node 2']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 3' do
+          node = directed_graph.find_node_by_name('node 3')
+          shortest_path = ['node 1', 'node 2', 'node 3']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 4' do
+          node = directed_graph.find_node_by_name('node 4')
+          shortest_path = ['node 1', 'node 2', 'node 4']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 5' do
+          node = directed_graph.find_node_by_name('node 5')
+          shortest_path = ['node 1', 'node 2', 'node 3', 'node 6', 'node 5']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+
+        it 'solves the problem for node 6' do
+          node = directed_graph.find_node_by_name('node 6')
+          shortest_path = ['node 1', 'node 2', 'node 3', 'node 6']
+          expect(dijkstra.shortest_path_to(node).map(&:to_s)).to eq shortest_path
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abuelo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Dirk Holzapfel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,11 +83,13 @@ files:
 - Rakefile
 - abuelo.gemspec
 - lib/abuelo.rb
+- lib/abuelo/algorithms/dijkstra.rb
 - lib/abuelo/edge.rb
 - lib/abuelo/exceptions/exceptions.rb
 - lib/abuelo/graph.rb
 - lib/abuelo/node.rb
 - lib/abuelo/version.rb
+- spec/algorithms/dijkstra_spec.rb
 - spec/edge_spec.rb
 - spec/graph_spec.rb
 - spec/node_spec.rb
@@ -117,6 +119,7 @@ signing_key:
 specification_version: 4
 summary: Abuelo
 test_files:
+- spec/algorithms/dijkstra_spec.rb
 - spec/edge_spec.rb
 - spec/graph_spec.rb
 - spec/node_spec.rb