graphunk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fbceaea640b3b555fba08b526a211d0078a3dfd
-  data.tar.gz: 63fd21c8a5e0bf2b5f90de2cc9c848780f7e520a
+  metadata.gz: 5c8b58585a2175ae4116953c6f823d0bd3887efc
+  data.tar.gz: af62b1d472c236cabcb03b7e1dc1ab44967e89b8
 SHA512:
-  metadata.gz: ffd51fc13f3a6c5d9e24ed05ed97f5958c53921b4f28099a924c40fc03006e0fa1a8d618f870fad83e6600ca0975f992b6a343d7d66ec3facc0e5d69114ff99f
-  data.tar.gz: 91a642dc7941b6697855302dcb5a8924f6864d7401d1b6ad44de9a7a3f5eb89c2bf9a4a5f2fa2998ed0604df706341e6134cccda09c92e60735ada49103abd5f
+  metadata.gz: b40e4673e48bc00dcf9b39570da7318ceed67f0fa2308ba9d038820b4155e511144f083afe5ea01714c1d5138b7c4cafe810a69ffdcbfdfb3aa6ba034752d4e9
+  data.tar.gz: 15f2947ffea732b89b6f7f53e6963ef565f93bb99a4cd63b93fe2390dcbe988a47f1733b430410ce8a0316a95e2f142986b2f2658ebb63bd1827dfbd30158852

data/README.md

@@ -4,18 +4,18 @@ Graphunk defines simple and fully-tested graph classes in Ruby which you can use
 
 ## Defining a Graph
 
-There are two kinds of graphs supported by this system, directed graphs and undirected graphs.
+### Unweighted Graphs
 
-Graphs inherit from Hash, so you can define a graph in the same way you would define a Hash:
+Graphs are internally represented as a hash, so you can define a graph similarly to how you would define a Hash:
 
 ```
-UndirectedGraph[
+UndirectedGraph.new({
   'a' => ['b','c'],
   'b' => ['c', 'd', 'e'],
   'c' => ['d'],
   'd' => ['e'],
   'e' => []
-]
+})
 ```
 
 Each key is a string representing a vertex, and the value is a list
@@ -29,12 +29,12 @@ In a directed graph, the order in an edge matters. A construction of a directed
 might look like this:
 
 ```
-DirectedGraph[
+DirectedGraph.new({
   'a' => ['b','c'],
   'b' => ['a'],
   'c' => ['d'],
   'd' => []
-]
+})
 ```
 
 Graphs can also be built by individually adding edges and vertices.
@@ -46,6 +46,40 @@ graph.add_vertex('b')
 graph.add_edge('a','b')
 ```
 
+### Weighted Graphs
+
+Weighted graphs have an additional property: each edge must specify a numerical weight.
+
+To construct a weighted graph, you must pass in the vertex and edge information as well as the weights:
+
+```
+WeightedUndirectedGraph.new({
+  'a' => ['b','c'],
+  'b' => ['c', 'd', 'e'],
+  'c' => ['d'],
+  'd' => ['e'],
+  'e' => []
+},
+{
+  ['a','b'] => 2,
+  ['a','c'] => 4,
+  ['b','c'] => 1,
+  ['b','d'] => 4,
+  ['b','e'] => 7,
+  ['c','d'] => 4,
+  ['d','e'] => 3
+})
+```
+
+You can also build them by adding vertices and edges.
+```
+  graph = WeightedUndirectedGraph.new
+  graph.add_vertex('a')
+  graph.add_vertex('b')
+  graph.add_edge('a','b',3)
+```
+Now the edge 'a-b' will have a weight of 3.
+
 ## Testing
 
 To run the test suite simply execute:

data/lib/graphunk/directed_graph.rb

@@ -3,7 +3,7 @@ class DirectedGraph < Graph
     if edge_exists?(first_vertex, second_vertex)
       raise ArgumentError, "This edge already exists"
     elsif vertex_exists?(first_vertex) && vertex_exists?(second_vertex)
-      self[first_vertex] << second_vertex
+      @representation[first_vertex] << second_vertex
     else
       raise ArgumentError, "One of the vertices referenced does not exist in the graph"
     end
@@ -11,7 +11,7 @@ class DirectedGraph < Graph
 
   def remove_edge(first_vertex, second_vertex)
     if edge_exists?(first_vertex, second_vertex)
-      self[first_vertex].delete(second_vertex)
+      @representation[first_vertex].delete(second_vertex)
     else
       raise ArgumentError, "That edge does not exist in the graph"
     end
@@ -19,7 +19,7 @@ class DirectedGraph < Graph
 
   def neighbors_of_vertex(name)
     if vertex_exists?(name)
-      self[name]
+      @representation[name]
     else
       raise ArgumentError, "That vertex does not exist in the graph"
     end
@@ -53,9 +53,9 @@ class DirectedGraph < Graph
 
   def reachable_by_two_path(start)
     if vertex_exists?(start)
-      reached_vertices = self[start]
+      reached_vertices = @representation[start]
       reached_vertices.each do |vertex|
-        reached_vertices += self[vertex]
+        reached_vertices += @representation[vertex]
       end
       reached_vertices.uniq
     else

data/lib/graphunk/graph.rb

@@ -1,13 +1,17 @@
 # this class should not be invoked directly
-class Graph < Hash
+class Graph
+  def initialize(hash = {})
+    @representation = hash
+  end
+
   def vertices
-    keys
+    @representation.keys
   end
 
   def edges
     [].tap do |edge_constructor|
       vertices.each do |vertex|
-        self[vertex].each do |neighbor|
+        @representation[vertex].each do |neighbor|
           edge_constructor << [vertex, neighbor]
         end
       end
@@ -16,18 +20,26 @@ class Graph < Hash
 
   def add_vertex(name)
     unless vertex_exists?(name)
-      self[name] = []
+      @representation[name] = []
     else
       raise ArgumentError, "Vertex already exists"
     end
   end
 
+  def add_vertices(*names)
+    if (names & vertices).count == 0
+      names.each { |name| add_vertex(name) }
+    else
+      raise ArgumentError, "One or more of the given vertices already exists"
+    end
+  end
+
   def remove_vertex(name)
     if vertex_exists?(name)
       edges.each do |edge|
         remove_edge(edge.first, edge.last) if edge.include?(name)
       end
-      self.delete(name)
+      @representation.delete(name)
     else
       raise ArgumentError, "That vertex does not exist in the graph"
     end

data/lib/graphunk/undirected_graph.rb

@@ -6,7 +6,7 @@ class UndirectedGraph < Graph
       raise ArgumentError, "This edge already exists"
     elsif vertex_exists?(first_vertex) && vertex_exists?(second_vertex)
       ordered_vertices = order_vertices(first_vertex, second_vertex)
-      self[ordered_vertices.first] << ordered_vertices.last
+      @representation[ordered_vertices.first] << ordered_vertices.last
     else
       raise ArgumentError, "One of the vertices referenced does not exist in the graph"
     end
@@ -15,7 +15,7 @@ class UndirectedGraph < Graph
   def remove_edge(first_vertex, second_vertex)
     if edge_exists?(first_vertex, second_vertex)
       ordered_vertices = order_vertices(first_vertex, second_vertex)
-      self[ordered_vertices.first].delete(ordered_vertices.last)
+      @representation[ordered_vertices.first].delete(ordered_vertices.last)
     else
       raise ArgumentError, "That edge does not exist in the graph"
     end

data/lib/graphunk/weighted_graph.rb

@@ -1,10 +1,10 @@
 #this class should not be invoked directly
 class WeightedGraph < Graph
 
-  attr_accessor :weights
+  attr_reader :weights
 
-  def initialize
-    super
-    @weights = {}
+  def initialize(hash = {}, weights = {})
+    @representation = hash
+    @weights = weights
   end
 end

data/lib/graphunk/weighted_undirected_graph.rb

@@ -5,8 +5,8 @@ class WeightedUndirectedGraph < WeightedGraph
       raise ArgumentError, "This edge already exists"
     elsif vertex_exists?(v) && vertex_exists?(u)
       ordered_vertices = order_vertices(v, u)
-      self[ordered_vertices.first] << ordered_vertices.last
-      weights[ordered_vertices] = w
+      @representation[ordered_vertices.first] << ordered_vertices.last
+      @weights[ordered_vertices] = w
     else
       raise ArgumentError, "One of the vertices referenced does not exist in the graph"
     end
@@ -15,16 +15,20 @@ class WeightedUndirectedGraph < WeightedGraph
   def remove_edge(v, u)
     if edge_exists?(v, u)
       ordered_vertices = order_vertices(v, u)
-      self[ordered_vertices.first].delete(ordered_vertices.last)
+      @representation[ordered_vertices.first].delete(ordered_vertices.last)
       remove_weight(v, u)
     else
       raise ArgumentError, "That edge does not exist in the graph"
     end
   end
 
+  def edge_weight(edge)
+    @weights[edge]
+  end
+
   def adjust_weight(v, u, w)
     if edge_exists?(v, u)
-      weights[[v,u]] = w
+      @weights[[v,u]] = w
     else
       raise ArgumentError, "That edge does not exist in the graph"
     end
@@ -54,6 +58,6 @@ class WeightedUndirectedGraph < WeightedGraph
   end
 
   def remove_weight(v, u)
-    weights.delete(order_vertices(v, u))
+    @weights.delete(order_vertices(v, u))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphunk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Evan Hemsley