abstract_graph 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a6bbd7d12e215a907b79ebaef777d9282f4e283
+  data.tar.gz: 8207dfe01745e9a6c50a75bc59f79a2f1248045f
+SHA512:
+  metadata.gz: f7c6d5082e389a24a6db96e4c103825803ecfd8ebc1f41117192093a349dfe7104329d14d7c7b1098f04a783f225cfbbffd25242514a0cad5e2b569e61564e3c
+  data.tar.gz: 406b2b87218d98b9832fe479791192c38098ca7453a8e9fcb3bb68e9a7050ffee51aa4a4a2fdc97a7a7ab84d268ec1ee80fe35faeca8a1d9745cc90633911e06

data/.gitignore

@@ -4,6 +4,8 @@
 .bundle
 .config
 .yardoc
+.ruby-gemset
+.ruby-version
 Gemfile.lock
 InstalledFiles
 _yardoc

data/lib/abstract_graph/composition/uniquenamecollection/dup.rb

@@ -7,7 +7,7 @@ module AbstractGraph
       # does a deep copy of the object, in otherwords
       #   copies every object in the collection
       def dup
-        other = UniqueNameCollection.new
+        other = self.class.new
         # copy each object in our collection over
         @collection.each_value do |o|
           other.add o

data/lib/abstract_graph/composition/uniquenamecollection/rename.rb

@@ -0,0 +1,28 @@
+# required in "abstract_graph/composition/uniquenamecollection"
+
+module AbstractGraph
+  module Composition
+    class UniqueNameCollection
+
+      # Change the name of a vertex in our graph
+      # p: String oldname represents the current vertex's name
+      #    String newname represents the new name of our vertex
+      # note: the object needs to implement #name=
+      def rename( oldname, newname )
+        return nil if @collection[oldname].nil?
+
+        @otherUnique.each do |unc|
+          throw Exception if unc[newname]
+        end
+
+        # rename the object itself
+        @collection[oldname].name = newname
+        # remap the name
+        @collection[newname] = @collection[oldname]
+        # clear the old name
+        @collection.delete oldname
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/composition/uniquenamecollection.rb

@@ -19,3 +19,4 @@ require "abstract_graph/composition/uniquenamecollection/add"
 require "abstract_graph/composition/uniquenamecollection/dup"
 require "abstract_graph/composition/uniquenamecollection/method_missing"
 require "abstract_graph/composition/uniquenamecollection/link"
+require "abstract_graph/composition/uniquenamecollection/rename"

data/lib/abstract_graph/graph/add_edge.rb

@@ -12,14 +12,14 @@ module AbstractGraph
       v1 = @vertices[v1] or return nil
       v2 = @vertices[v2] or return nil
 
-      raise Exception if v1 == v2
+      raise Exception.new( "AddEdge: Same vertices passed, #{v1.name}" ) if v1 == v2
 
       # create the edge
       edge = Edge.new s, v1, v2
 
       # check if it's an multiple edge
       @edges.each_value do |e|
-        raise Exception if e.is_coincident? edge
+        raise Exception.new( "AddEdge: Multiple edge being added between #{v1.name}, #{v2.name}" ) if e.is_coincident? edge
       end
 
       @edges.add edge

data/lib/abstract_graph/graph/adjacency_list.rb

@@ -0,0 +1,28 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # return the adjacent vertices in of a vertex
+    # p: String s represents the name of the query vertex
+    def adjacency_list( s )
+      # this collects all the edges at first
+      result = @edges.collect do |id,e|
+        e.vertices.collect do |v|
+          v.name
+        end - [s]
+      end.delete_if do |adj|
+        # and deletes the ones with only one remaining tracked
+        adj.size == 2
+      end.flatten
+
+      # return nil if result is empty
+      if result.size == 0
+        return nil
+      else
+        return result
+      end
+    end
+
+  end
+end

data/lib/abstract_graph/graph/change_edge_name.rb

@@ -0,0 +1,15 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # changes an edge name to another valid name
+    # p: String s represents the current edge we want to rename
+    #    String snew is what we want to rename the edge to
+    def change_edge_name( s, snew )
+      return nil if @edges.rename(s, snew).nil?
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/change_vertex_name.rb

@@ -0,0 +1,15 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # changes a vertex name to another valid name
+    # p: String s represents the current vertex we want to rename
+    #    String snew is what we want to rename the vertex to
+    def change_vertex_name( s, snew )
+      return nil if @vertices.rename(s, snew).nil?
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/dup.rb

@@ -5,8 +5,15 @@ module AbstractGraph
 
     # does a deep copy of the graph
     def dup
-      other = Graph.new
-      other.vertices = @vertices.dup
+      other = self.class.new
+      # cannot call UniqueNameCollection#dup because we'll lose
+      # link data
+      @vertices.each_value do |v|
+        other.vertices.add v
+      end
+      @edges.each_value do |e|
+        other.edges.add e
+      end
       other
     end
 

data/lib/abstract_graph/graph/get_edge_name.rb

@@ -0,0 +1,24 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns the edge connecting v1 and v2, if there is no
+    #   edge, then it returns nil
+    # p: String v1, v2 represents the names of the vertices
+    def get_edge_name( v1, v2 )
+      vertices = [v1, v2].sort!
+
+      @edges.each_value do |e|
+        eVertices = e.vertices.map do |v|
+          v.name
+        end.sort
+
+        return e.name if eVertices == vertices
+      end
+
+      nil
+    end
+
+  end
+end

data/lib/abstract_graph/graph/is_adjacent.rb

@@ -0,0 +1,20 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns whether or not v1 and v2 are joined by an edge
+    # p: String v1, v2 represents the names of the vertices
+    def is_adjacent?( v1, v2 )
+      vertices = [v1, v2].sort!
+
+      ( @edges.each_value.find do |e|
+        vertices == e.vertices.map do |v|
+          v.name
+        end.sort
+      end && true ) || false
+
+    end
+
+  end
+end

data/lib/abstract_graph/graph/merge_vertices.rb

@@ -0,0 +1,84 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns a replicated graph where the vertices with names
+    #   v1 and v2 merge together to a vertex named vmerged and
+    #   the edges that were adjacent to v1 and v2 are now
+    #   adjacent to vmerged
+    # p: (Array, String)
+    #      array is the string names of vertices to merge together
+    #      string is the name of the final vertex
+    #    (String, String, String)
+    #      first two strings are the vertices to merge together
+    #      last string is the name of the merged vertex
+    # e: the edges prioritize v1 to v2 if there are any conflicts
+    def merge_vertices( *args )
+      other = self.dup
+      other.merge_vertices!( *args )
+    end
+
+    # same as before except operates on the current graph
+    def merge_vertices!( *args )
+
+      # create a list of vertices we want to merge
+      mergeV = []
+      if args[0].class == Array
+        mergeV = args[0]
+      else
+        mergeV << args[0] << args[1]
+      end
+
+      # first construct an array of edges in between vertices
+      edgesInBetween = []
+      if ( args.size == 3 )
+        # do not need to go through the array of vertices
+        edgesInBetween << get_edge_name( args[0], args[1] )
+      else
+        edgesInBetween = @edges.values.collect do |e|
+          e.name if ( e.vertices.map do |v|
+            v.name
+          end & mergeV ).count == 2
+        end
+      end
+
+      # delete the edges in between vertices
+      edgesInBetween.each do |e|
+        delete_edge!( e ) if e
+      end
+
+      # get the list of connections we want vmerged to be merged with
+      finalConnections = {}
+      mergeV.reverse.each do |vCheck|
+        @edges.each do |name, e|
+          [0,1].each do |edgeVId|
+
+            # check if the edge contains our vertex
+            if e.vertices[edgeVId].name == vCheck
+              otherVertex = e.vertices[(edgeVId+1)%2].name
+              # track the vertex with the edge name
+              finalConnections[otherVertex] = name
+              delete_edge! name
+            end
+
+          end
+        end
+      end
+
+      # delete the vertices we want to merge
+      mergeV.each do |v|
+        delete_vertex! v
+      end
+
+      # add vmerged and connect it to adjacent vertices
+      add_vertex args.last
+      finalConnections.each do | vertexName, name |
+        add_edge name, vertexName, args.last
+      end
+
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/split_vertex.rb

@@ -0,0 +1,40 @@
+# required in "abstract_graph/graph"
+
+module AbstractGraph
+  class Graph
+
+    # returns a replicated graph where all the vertices are the same but one
+    #   gets split and all it's adjacent vertices are now connected to two replaced vertices
+    # p: String s the name of the vertex that will be split into vertexName-1 and vertexName-2
+    #     all adjacent edges will also be split and adjacent to the correct vertex
+    def split_vertex( s )
+      other = self.dup
+      other.split_vertex!( s )
+      other
+    end
+
+    # same as before except operates on the current graph
+    def split_vertex!( s )
+      adjacentVertices = @edges.dup.keep_if do |id, e|
+        e.vertices.collect(&:name).include? s
+      end.collect do |id, e|
+        [id, ( e.vertices.collect(&:name) - [s] )[0] ]
+      end
+
+      delete_vertex! s
+      adjacentVertices.each do |e|
+        delete_edge! e[0]
+      end
+
+      add_vertex "#{s}-1"
+      add_vertex "#{s}-2"
+      adjacentVertices.each do |e|
+        add_edge "#{e[0]}-1",  "#{s}-1", e[1]
+        add_edge "#{e[0]}-2",  "#{s}-2", e[1]
+      end
+
+      self
+    end
+
+  end
+end

data/lib/abstract_graph/graph/templates/complete_bipartite_graph.rb

@@ -0,0 +1,40 @@
+# required in "abstract_graph/graph/template"
+
+module AbstractGraph
+  class Graph
+    class << self
+
+      # create a connected graph with two sets of vertices where
+      #   the two sets only have vertices adjacent to the other set
+      # p: the number of vertices in the two sets. the first set has
+      #   n vertices from 2**(0..n-1) and the second set has m
+      #   vertices from 2**(n**m+n-1)
+      def complete_bipartite_graph n, m
+        result = new
+
+        # add the vertices to the graph
+        vertexN = (0..n-1).map do |i|
+          vName = 2**i
+          result.add_vertex "v#{vName}"
+          vName
+        end
+        vertexM = (0..m-1).map do |i|
+          vName = 2**(n+i)
+          result.add_vertex "v#{vName}"
+          vName
+        end
+
+        # add the edges to the graph, and make sure they're
+        # connected to the other set
+        vertexN.each do |vn|
+          vertexM.each do |vm|
+            result.add_edge "e#{vn + vm}", "v#{vn}", "v#{vm}"
+          end
+        end
+
+        result
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/graph/templates/complete_graph.rb

@@ -0,0 +1,25 @@
+# required in "abstract_graph/graph/template"
+
+module AbstractGraph
+  class Graph
+    class << self
+
+      # create a variabled sized complete graph
+      #   that is, a graph where every vertex is adjacent
+      #   to every other vertex
+      # p: the number of vertices in the desired complete graph
+      def complete_graph n
+        result = new
+        vertexNames = n.times.collect { |i| 2**i }
+        vertexNames.each do |i|
+          result.add_vertex "v#{i}"
+        end
+        vertexNames.combination(2).each do |i|
+          result.add_edge( "e#{i[0]+i[1]}", "v#{i[0]}", "v#{i[1]}" )
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/graph/templates/cycle_graph.rb

@@ -0,0 +1,34 @@
+# required in "abstract_graph/graph/template"
+
+module AbstractGraph
+  class Graph
+    class << self
+
+      # create a variabled sized cycle graph,
+      #   ie, a connected graph such that every vertex has
+      #   exactly two distinct paths to every other vertex
+      # p: the number of vertices in the cycle graph
+      #    coincidently, also the number of edges
+      def cycle_graph n
+        result = new
+        vertexNames = (n-1).times.collect { |i| 2**(i + 1) }
+        lastVertex  = 2**(n-1)
+
+        # insert first vertex
+        result.add_vertex "v1"
+        vertexNames.each do |i|
+          # insert the rest of the vertices
+          result.add_vertex "v#{i}"
+          # insert the edge with the previous vertex
+          result.add_edge "e#{i + i/2}", "v#{i}", "v#{i/2}"
+        end
+
+        #insert the closing loop
+        result.add_edge "e#{1 + lastVertex}", "v1", "v#{lastVertex}"
+
+        result
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/graph/templates/path_graph.rb

@@ -0,0 +1,28 @@
+# required in "abstract_graph/graph/template"
+
+module AbstractGraph
+  class Graph
+    class << self
+
+      # create a variable sized path graph,
+      #   ie, a connected graph with 2 end vertices and n-2 connector
+      #   vertices. Each connector vertex has two adjacent vertices
+      # p: the number of vertices in the path, n-1 edges
+      def path_graph n
+        result = new
+
+        # add the first vertex
+        result.add_vertex "v1"
+        (1..n-1).each do |i|
+          # add the rest of them
+          result.add_vertex "v#{2**i}"
+          result.add_edge "e#{2**i + 2**(i-1)}", "v#{2**i}", "v#{2**(i-1)}"
+        end
+
+        result
+      end
+
+    end
+  end
+end
+

data/lib/abstract_graph/graph/templates/petersen_graph.rb

@@ -0,0 +1,36 @@
+# required in "abstract_graph/graph/template"
+
+module AbstractGraph
+  class Graph
+    class << self
+
+      # create a petersen graph.
+      # ie, a 3 regular graph with 10 vertices and 15 edges
+      def petersen_graph
+        result = new
+
+        vertexNames = []
+        # add all the vertices
+        10.times do |i|
+          vName = 2**i
+          vertexNames << vName
+          result.add_vertex "v#{vName}"
+        end
+
+        specifiedEdges = [
+        [0, 1], [0, 5], [0, 4],
+        [1, 2], [2, 3], [3, 4],
+        [1, 6], [2, 7], [3, 8],
+        [4, 9], [5, 8], [5, 7],
+        [6, 9], [7, 9], [6, 8]]
+
+        specifiedEdges.each do |edgePair|
+          result.add_edge "e#{vertexNames[edgePair[0]] + vertexNames[edgePair[1]]}", "v#{vertexNames[edgePair[0]]}", "v#{vertexNames[edgePair[1]]}"
+        end
+
+        result
+      end
+
+    end
+  end
+end

data/lib/abstract_graph/graph/templates.rb

@@ -0,0 +1,15 @@
+# required in "abstract_graph/graph"
+
+# Define a bunch of pre-constructed graphs
+
+module Abstractgraph
+  class Graph
+
+  end
+end
+
+require "abstract_graph/graph/templates/complete_graph"
+require "abstract_graph/graph/templates/cycle_graph"
+require "abstract_graph/graph/templates/path_graph"
+require "abstract_graph/graph/templates/complete_bipartite_graph"
+require "abstract_graph/graph/templates/petersen_graph"

data/lib/abstract_graph/graph.rb

@@ -23,3 +23,11 @@ require "abstract_graph/graph/delete_vertex"
 require "abstract_graph/graph/add_edge"
 require "abstract_graph/graph/has_edge"
 require "abstract_graph/graph/delete_edge"
+require "abstract_graph/graph/change_vertex_name"
+require "abstract_graph/graph/change_edge_name"
+require "abstract_graph/graph/is_adjacent"
+require "abstract_graph/graph/adjacency_list"
+require "abstract_graph/graph/merge_vertices"
+require "abstract_graph/graph/get_edge_name"
+require "abstract_graph/graph/templates"
+require "abstract_graph/graph/split_vertex"

data/lib/abstract_graph/version.rb

@@ -1,5 +1,5 @@
 # required in "abstract_graph"
 
 module AbstractGraph
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/abstract_graph/composition/uniquenamecollection/rename_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module AbstractGraph
+  module Composition
+    describe UniqueNameCollection do
+
+      before :all do
+        @name = "name"
+        @newname = "newname"
+      end
+
+      before :each do
+        @collection = UniqueNameCollection.new
+        @dummy = Dummy.new
+        @dummy.name = @name
+        @collection.add @dummy
+      end
+
+      describe "#rename(String,String)" do
+
+        it "removes the original name from the hash" do
+          @collection.rename @name, @newname
+          @collection[@name].should be_nil
+        end
+
+        it "renames the dummy object" do
+          @collection.rename @name, @newname
+          @dummy.name.should == @newname
+        end
+
+        it "throws an exception if the new name exists" do
+          @dummy = Dummy.new
+          @dummy.name = @newname
+          @collection.add @dummy
+          expect { @collection.rename @name, @newname }.to raise_error
+        end
+
+      end
+
+    end
+  end
+end

data/spec/abstract_graph/graph/adjacency_list_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module AbstractGraph
+  describe Graph do
+
+    before :all do
+      @vertex1 = "Vertex1"
+      @vertex2 = "Vertex2"
+      @vertex3 = "Vertex3"
+      @vertex4 = "Vertex4"
+      @edge1 = "Edge1"
+      @edge2 = "Edge2"
+    end
+
+    before :each do
+      @graph = Graph.new
+      @graph.add_vertex @vertex1
+      @graph.add_vertex @vertex2
+      @graph.add_vertex @vertex3
+      @graph.add_vertex @vertex4
+      @graph.add_edge @edge1, @vertex1, @vertex2
+      @graph.add_edge @edge2, @vertex2, @vertex3
+    end
+
+    describe "#adjacency_list(String)" do
+
+      it "returns an array if there are adjacent vertices" do
+        @graph.adjacency_list( @vertex1 ).should be_an_instance_of(Array)
+      end
+
+      it "returns nil if there are no adjacent vertices" do
+        @graph.adjacency_list( @vertex4).should be_nil
+      end
+
+      it "returns the vertices that are connected with edges" do
+        @graph.adjacency_list( @vertex2 ).should include(@vertex1)
+        @graph.adjacency_list( @vertex2 ).should include(@vertex3)
+        @graph.adjacency_list( @vertex1 ).should include(@vertex2)
+      end
+
+    end
+
+  end
+end

data/spec/abstract_graph/graph/change_edge_name_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module AbstractGraph
+  describe Graph do
+
+    before :all do
+      @vertex1 = "Vertex1"
+      @vertex2 = "Vertex2"
+      @vertex3 = "Vertex3"
+      @edge = "MyEdge"
+      @edgechanged = "MyChangedName"
+    end
+
+    before :each do
+      @graph = Graph.new
+      @graph.add_vertex @vertex1
+      @graph.add_vertex @vertex2
+      @graph.add_vertex @vertex3
+      @graph.add_edge @edge, @vertex1, @vertex2
+    end
+
+    describe "#change_edge_name(String,String)" do
+
+      it "returns an object of class Graph" do
+        @graph.change_edge_name( @edge, @edgechanged ).should be_an_instance_of(Graph)
+      end
+
+      it "changes the name of the vertex" do
+        @graph.change_edge_name @edge, @edgechanged
+        @graph.has_edge?( @edge ).should be_false
+        @graph.has_edge?( @edgechanged ).should be_true
+      end
+
+      it "throws an exception if the name has already been taken" do
+        @graph.add_edge @edgechanged, @vertex2, @vertex3
+        expect { @graph.change_edge_name( @edge, @edgechanged ) }.to raise_error
+      end
+
+    end
+
+  end
+end