mvgraph 0.0.1

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ruby-graphviz (0.9.21)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ruby-graphviz

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Daniel Vingo, Jonathan McKenzie
+
+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

@@ -0,0 +1,2 @@
+mvGraph is an implementation of the graph data structure in Ruby.  It was created to solve 
+some classic AI search problems; as such, it currently supports BFS, DFS, any user-defined heuristic search, as well as A*.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name         = "mvgraph"
+  s.summary      = "A generic graph implementation, useful for solving problems where some sort of search is needed."
+  s.description  = File.read(File.join(File.dirname(__FILE__), 'README'))
+  s.requirements = [ 'None' ]
+  s.version      = "0.0.1" 
+  s.author       = "Jon Mckenzie, Dan Vingo"
+  s.email        = "danvingo@gmail.com"
+  s.homepage     = ""
+  s.platform     = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9.2p180'
+  s.files        = Dir['**/**']
+  s.executables  = []
+  s.test_files   = Dir["test/test*.rb"]
+  s.has_rdoc     = false
+end
+Rake::GemPackageTask.new(spec).define
+
+task :default => [:test]
+
+task :test do
+  ruby "test/test_mvQueue.rb"
+  ruby "test/test_mvGraph.rb"
+end

data/doc/design.txt

@@ -0,0 +1,42 @@
+The graph is currently implemented in an undirected manner, such that
+adding an edge will add edges in both directions, this can easily be changed 
+for example to implement a directed graph, or if you desire the behavior to 
+explicitly set edges in both directions for two vertices.
+==============
+ New Features
+==============
+-Graph Visualization
+  -Output
+    -ASCII
+    -JSON
+    -OpenGL/WebGL
+    -Static image (png, jpeg, etc.)
+-Graph Methods
+  -Search
+    *-Breadth-first
+      *-Shortest-path
+    *-Depth-first
+      -Iterative Depth-first
+    *-Best-first
+    -Greedy
+    -A*
+-Database
+-Back-end representation
+  -Give the option to use adjacency list or adjacency matrix to use more memory but make the search faster
+-Sub/Supertypes
+  -Simple
+  -Directed
+  -Weighted-edges
+  -Hypergraph
+  -Toy implementations
+    -Slide puzzle
+    -Chess/checkers
+-Perfomance enhancements
+  -Hash function to compare states instead of nxn linear search of the grid size when testing equality.
+    
+======
+ TODO
+======
+- Add a README
+- Setup Rake tasks for testing with nPuzzle and mvGraph together.
+

data/lib/mvGraph.rb

@@ -0,0 +1,202 @@
+require_relative 'mvQueue.rb'
+class Graph
+  include Enumerable
+  def each
+    @adj_matrix.keys.each do |vertex|
+      yield vertex
+    end
+  end
+
+  def neighbors_of(vertex)
+    @adj_matrix[vertex].select { |v| has_edge?(vertex, v) }.keys
+  end
+  
+  def initialize
+    @adj_matrix = Hash.new 
+  end
+  
+  def add_vertex(v)
+    @adj_matrix[v] = Hash.new
+  end
+  
+  def vertex(v)
+    @adj_matrix.find { |vertex| vertex[0] == v }[0]
+  end
+  
+  def add_edge(v1, v2)
+    if @adj_matrix[v1].nil?
+      @adj_matrix[v1] = Hash.new
+    end
+    if @adj_matrix[v2].nil?
+      @adj_matrix[v2] = Hash.new
+    end
+      @adj_matrix[v2][v1] = 1
+      @adj_matrix[v1][v2] = 1
+  end
+
+  def update_vertex(v)
+    @adj_matrix[v] = @adj_matrix[vertex(v)]
+  end
+  
+  def has_edge?(v1, v2)
+    unless @adj_matrix[v1].nil? or @adj_matrix[v1][v2].nil?
+      @adj_matrix[v1][v2] == 1
+    end
+  end
+  
+  #
+  # queue_type is one of fifo or lifo
+  #
+  # Look into passing a hash of arguments
+  def search(start_vertex, queue_type, neighbor_function=nil, goal_state=nil, search_depth=nil)
+    set_vertex_color(start_vertex, "gray")
+    set_vertex_distance(start_vertex, 0)
+    queue = Queue.new(queue_type)
+    queue.enqueue(get_graph_vertex(start_vertex))
+    goal_not_reached = true
+    count = 0
+    return_goal_state = nil
+    while queue.length != 0 and goal_not_reached
+      current_vertex = queue.dequeue
+      count += 1
+      # Full BFS or DFS with no goal state
+      if neighbor_function.nil? and search_depth.nil? and goal_state.nil?
+        neighbors_of(current_vertex).each do |neighbor|
+	  if neighbor.color == "white"
+	    set_vertex_color(get_graph_vertex(neighbor), "gray")
+	    set_vertex_distance(get_graph_vertex(neighbor), get_vertex_distance(get_graph_vertex(current_vertex)) + 1)
+	    set_vertex_predecessor(get_graph_vertex(neighbor), get_graph_vertex(current_vertex))
+	    queue.enqueue(get_graph_vertex(neighbor))
+	  end
+	end
+	set_vertex_color(get_graph_vertex(current_vertex), "black")
+      # Search for goal_state with no distance limit
+      elsif !neighbor_function.nil? and !goal_state.nil? and search_depth.nil?
+	neighbors = get_graph_vertex(current_vertex).send(neighbor_function, goal_state)
+	neighbors.each do |neighbor|
+	  unless self.include? neighbor
+	    self.add_vertex(neighbor)
+	    self.add_edge(current_vertex, neighbor)
+	    if neighbor == goal_state
+              set_vertex_color(get_graph_vertex(neighbor), "gray")
+	      set_vertex_distance(get_graph_vertex(neighbor), get_vertex_distance(get_graph_vertex(current_vertex)) + 1)
+	      set_vertex_predecessor(get_graph_vertex(neighbor), get_graph_vertex(current_vertex))
+puts "	   a;dslfkj   #{return_goal_state} "
+	      return_goal_state = neighbor
+	      goal_not_reached = false
+	      break
+	    end
+	    if get_vertex_color(get_graph_vertex(neighbor)) == "white"
+	      set_vertex_color(get_graph_vertex(neighbor), "gray")
+	      set_vertex_distance(get_graph_vertex(neighbor), get_vertex_distance(get_graph_vertex(current_vertex)) + 1)
+	      set_vertex_predecessor(get_graph_vertex(neighbor), get_graph_vertex(current_vertex))
+	      queue.enqueue(get_graph_vertex(neighbor))
+	    end
+	    set_vertex_color(get_graph_vertex(current_vertex), "black")
+	  end
+	end
+      # Random walk to a given distance and no goal state
+      elsif !neighbor_function.nil? and goal_state.nil? and !search_depth.nil?
+	neighbors = get_graph_vertex(current_vertex).send(neighbor_function)
+	neighbors.each do |neighbor|
+	  unless self.include? neighbor
+	    self.add_vertex(neighbor)
+	    self.add_edge(current_vertex, neighbor)
+	    if count == search_depth
+	      return_goal_state = neighbor
+	      goal_not_reached = false
+	      break
+	    end
+	    if get_vertex_color(get_graph_vertex(neighbor)) == "white"
+	      set_vertex_color(get_graph_vertex(neighbor), "gray")
+	      set_vertex_distance(get_graph_vertex(neighbor), get_vertex_distance(get_graph_vertex(current_vertex)) + 1)
+	      set_vertex_predecessor(get_graph_vertex(neighbor), get_graph_vertex(current_vertex))
+	      queue.enqueue(get_graph_vertex(neighbor))
+	    end
+	    set_vertex_color(get_graph_vertex(current_vertex), "black")
+	  end
+	end
+      else
+	# Other possible prototypes
+      end	
+    end
+puts "return_goal_state: #{return_goal_state}"
+    return return_goal_state, count
+  end
+
+  # Performs depth-first search to the given depth, starting at the vertex start_state.
+  def walk_n_steps(start_state, neighbor_function, depth)
+    search(start_state, "lifo", neighbor_function, nil, depth)
+  end
+ 
+  # 
+  # Precondition: BFS has been run on the graph
+  #
+  def shortest_path(start_vertex, end_vertex)
+    @ret_array ||= []
+    predecessor = get_vertex_predecessor(get_graph_vertex(end_vertex))
+    if start_vertex == end_vertex
+      @ret_array << get_graph_vertex(start_vertex)
+    elsif predecessor.nil?
+      "No path."
+    else
+      shortest_path(get_graph_vertex(start_vertex), predecessor)
+      @ret_array << get_graph_vertex(end_vertex)
+    end
+  end
+
+  def set_vertex_color(v, color)
+    get_graph_vertex(v).color = color
+  end
+
+  def get_vertex_color(v)
+    get_graph_vertex(v).color
+  end
+  
+  def set_vertex_distance(v, distance)
+    get_graph_vertex(v).distance = distance
+  end
+
+  def get_vertex_distance(v)
+    get_graph_vertex(v).distance
+  end
+  
+  def set_vertex_predecessor(v, predecessor)
+    get_graph_vertex(v).predecessor = get_graph_vertex(predecessor) unless predecessor.nil?
+  end
+
+  def get_vertex_predecessor(v)
+    get_graph_vertex(v).predecessor
+  end
+  
+  private
+  def get_graph_vertex(v)
+    @adj_matrix.find { |vertex| vertex[0] == v }[0]
+  end
+end
+
+class Vertex
+  attr_accessor :id, :color, :distance, :predecessor
+  def initialize(id)
+    @id = id
+    @color = "white"
+    @distance = 2**32
+    @predecessor = nil
+  end
+  
+  def ==(other_vertex)
+    @id == other_vertex.id
+  end
+  
+  def eql?(other_vertex)
+    @id == other_vertex.id
+  end
+  
+  def hash
+    @id.hash
+  end
+
+  def to_s
+    "id: #{@id}, color: #{@color}, distance: #{@distance}, predecessor: \n\t\t #{@predecessor}"
+  end
+end

data/lib/mvQueue.rb

@@ -0,0 +1,29 @@
+class Queue < Array
+  def initialize(type)
+    super()
+    @type = type
+    @func_map = {"fi" => Proc.new{ |item| self.insert(0, item) }, "li" => Proc.new{ |item| self << item }, "fo" => Proc.new{ self.pop }, "lo" => Proc.new{ delete_at(0) }, 
+"be" => Proc.new do |item|
+   self.insert(0, item)
+   self.sort_by! { |state| state.score }
+ end
+ }
+  end
+  
+  def enqueue(item)
+    @func_map[@type[0..1]].call(item)
+  end
+
+  def dequeue
+    @func_map[@type[2..3]].call()
+  end
+  
+  def to_s
+    the_string = ""
+    self.each do |item|
+      the_string += item.to_s
+      the_string += ","
+    end
+    the_string[0..the_string.size()-2]
+  end
+end

data/test/test_mvGraph.rb

@@ -0,0 +1,183 @@
+require 'minitest/autorun'
+require_relative '../lib/mvGraph.rb'
+
+class TestGraph < MiniTest::Unit::TestCase
+  def setup
+    @graph = Graph.new
+    @vertex = Vertex.new(1)
+  end
+
+  def test_create_graph
+    assert @graph
+  end
+  
+  def test_create_vertex
+    assert @vertex
+  end
+  
+  def test_vertex_id
+    @vertex.id = 1
+    assert @vertex.id == 1
+  end
+  
+  def test_add_vertex
+    @graph.add_vertex(Vertex.new(1))
+    assert @graph.vertex(Vertex.new(1))
+  end
+  
+  def test_add_edge
+    vertex1 = Vertex.new(1)
+    @graph.add_vertex(vertex1)
+    @graph.add_vertex(Vertex.new(2))
+    @graph.add_edge(vertex1, Vertex.new(2))
+    assert @graph.has_edge?(Vertex.new(1), Vertex.new(2))
+    assert @graph.has_edge?(Vertex.new(2), Vertex.new(1))
+  end
+  
+  def test_no_edge
+    refute @graph.has_edge?(Vertex.new(3),Vertex.new(4))
+  end
+  
+  def test_add_multiple_vertices_and_edges
+    @graph.add_vertex(Vertex.new(1))
+    @graph.add_vertex(Vertex.new(2))
+    @graph.add_edge(Vertex.new(2),Vertex.new(1))
+    @graph.add_vertex(Vertex.new(3))
+    @graph.add_vertex(Vertex.new(4))
+    @graph.add_edge(Vertex.new(3),Vertex.new(4))
+    @graph.add_edge(Vertex.new(1),Vertex.new(4))
+    @graph.add_edge(Vertex.new(3),Vertex.new(2))
+    assert @graph.has_edge?(Vertex.new(1),Vertex.new(2))
+    assert @graph.has_edge?(Vertex.new(3),Vertex.new(4))
+    assert @graph.has_edge?(Vertex.new(4),Vertex.new(1))
+    assert @graph.has_edge?(Vertex.new(3),Vertex.new(2))
+  end
+  
+  def test_loop
+    @graph.add_vertex(Vertex.new(1))
+    @graph.add_edge(Vertex.new(1),Vertex.new(1))
+    assert @graph.has_edge?(Vertex.new(1),Vertex.new(1)), "@graph should have the edge just added."
+  end
+  
+  def test_vertex_equal
+    assert Vertex.new(1).eql? Vertex.new(1)
+    assert Vertex.new("12345").eql? Vertex.new("12345")
+  end
+  
+  def bfs_setup_hard
+    @bfs_graph = Graph.new
+    @bfs_graph.add_vertex(Vertex.new(1))
+    @bfs_graph.add_vertex(Vertex.new(2))
+    @bfs_graph.add_vertex(Vertex.new(3))
+    @bfs_graph.add_vertex(Vertex.new(4))
+    @bfs_graph.add_vertex(Vertex.new(5))
+    @bfs_graph.add_vertex(Vertex.new(6))
+    @bfs_graph.add_vertex(Vertex.new(7))
+    @bfs_graph.add_vertex(Vertex.new(8))
+    @bfs_graph.add_vertex(Vertex.new(9))
+    @bfs_graph.add_vertex(Vertex.new(10))
+    @bfs_graph.add_vertex(Vertex.new(11))
+
+    @bfs_graph.add_edge(Vertex.new(1),Vertex.new(2))
+    @bfs_graph.add_edge(Vertex.new(1),Vertex.new(3))
+    @bfs_graph.add_edge(Vertex.new(1),Vertex.new(4))
+    @bfs_graph.add_edge(Vertex.new(2),Vertex.new(5))
+    @bfs_graph.add_edge(Vertex.new(5),Vertex.new(6))
+    @bfs_graph.add_edge(Vertex.new(6),Vertex.new(7))
+    @bfs_graph.add_edge(Vertex.new(7),Vertex.new(8))
+    @bfs_graph.add_edge(Vertex.new(11),Vertex.new(8))
+    @bfs_graph.add_edge(Vertex.new(10),Vertex.new(5))
+    @bfs_graph.add_edge(Vertex.new(10),Vertex.new(9))
+    @bfs_graph.add_edge(Vertex.new(11),Vertex.new(9))
+  end
+  
+  def bfs_setup_easy
+    @bfs_graph = Graph.new
+    @bfs_graph.add_vertex(Vertex.new(1))
+    @bfs_graph.add_vertex(Vertex.new(2))
+    @bfs_graph.add_vertex(Vertex.new(3))
+    @bfs_graph.add_vertex(Vertex.new(4))
+    @bfs_graph.add_edge(Vertex.new(1), Vertex.new(2))
+    @bfs_graph.add_edge(Vertex.new(1), Vertex.new(3))
+    @bfs_graph.add_edge(Vertex.new(1), Vertex.new(4))
+  end
+  
+  #def test_bfs
+  #  bfs_setup_hard
+  #  assert @bfs_graph
+  #  @bfs_graph.search(Vertex.new(1), "fifo")
+  #  assert_equal "black", @bfs_graph.vertex(Vertex.new(1)).color
+  #  assert_equal 0, @bfs_graph.get_vertex_distance(Vertex.new(1))
+  #  assert_equal nil, @bfs_graph.get_vertex_predecessor(Vertex.new(1))
+  #  assert_equal @bfs_graph.get_vertex_color(Vertex.new(11)), "black"
+  #  assert @bfs_graph.get_vertex_distance(Vertex.new(11)) == 5
+  #  assert @bfs_graph.get_vertex_predecessor(Vertex.new(11)) == Vertex.new(9)
+  #end
+
+  #def test_shortest_path
+  #  bfs_setup_hard
+  #  assert @bfs_graph
+  #  @bfs_graph.search(Vertex.new(1), "fifo")
+  #  path = @bfs_graph.shortest_path(Vertex.new(1), Vertex.new(11))
+  #  assert path[0] == Vertex.new(1) 
+  #  assert path[1] == Vertex.new(2) 
+  #  assert path[2] == Vertex.new(5) 
+  #  assert path[3] == Vertex.new(10) 
+  #  assert path[4] == Vertex.new(9) 
+  #  assert path[5] == Vertex.new(11) 
+  #end
+
+  #def test_no_shortest_path
+  #  bfs_setup_hard
+  #  assert @bfs_graph
+    #@bfs_graph.add_vertex(Vertex.new(20))
+    #@bfs_graph.search(Vertex.new(1), "fifo")
+    #path = @bfs_graph.shortest_path(Vertex.new(1), Vertex.new(20))
+    #assert path == "No path."
+  #end
+  
+  def test_get_all_vertices
+    bfs_setup_easy
+    @bfs_graph.each { |vertex| assert vertex }
+  end
+
+  def test_neighbors_of
+    bfs_setup_easy
+    neighbors = @bfs_graph.neighbors_of(Vertex.new(1))
+    assert_equal 2, neighbors[0].id, "First neighbor should be 2."
+    assert_equal 3, neighbors[1].id, "Second neighbor should be 3."
+    assert_equal 4, neighbors[2].id, "Third neighbor should be 4."
+  end
+
+  def test_vertex_color
+    v = Vertex.new(1)
+    v.color = "gray"
+    @graph.add_vertex(v)
+    assert_equal "gray", @graph.vertex(Vertex.new(1)).color 
+  end
+  
+  def test_vertex_distance
+    v = Vertex.new(1)
+    v.distance = 100
+    @graph.add_vertex(v)
+    assert_equal 100, @graph.vertex(Vertex.new(1)).distance 
+  end
+  
+  def test_vertex_predecessor
+    @graph.add_vertex(Vertex.new(1))
+    @graph.vertex(Vertex.new(1)).predecessor = "5"
+    assert_equal "5", @graph.vertex(Vertex.new(1)).predecessor
+  end
+  
+  #def test_dfs
+  #  bfs_setup_hard
+  #  assert @bfs_graph
+  #  @bfs_graph.search(Vertex.new(1), "lifo")
+  #  assert_equal "black", @bfs_graph.vertex(Vertex.new(1)).color
+  #  assert_equal 0, @bfs_graph.vertex(Vertex.new(1)).distance
+  #  assert_equal nil, @bfs_graph.vertex(Vertex.new(1)).predecessor
+  #  assert_equal @bfs_graph.vertex(Vertex.new(11)).color, "black"
+  #  assert @bfs_graph.vertex(Vertex.new(11)).distance == 5
+  #  assert @bfs_graph.vertex(Vertex.new(11)).predecessor == Vertex.new(9)
+  #end
+end

data/test/test_mvQueue.rb

@@ -0,0 +1,46 @@
+require 'minitest/autorun'
+require_relative '../lib/mvQueue.rb'
+
+class TestQueue < MiniTest::Unit::TestCase
+  def setup
+    @queue = Queue.new("fifo")
+  end
+
+  def iterate_setup(type)
+    @queue = Queue.new(type)
+    @queue.enqueue(1)
+    @queue.enqueue(2)
+    @queue.enqueue(3)
+    @queue.enqueue(4)
+    @queue.enqueue(5)
+  end
+
+  def test_enqueue_dequeue
+    @queue.enqueue("x")
+    assert_equal @queue.dequeue, "x"
+  end
+
+  def test_queue_accessor_is_private
+    refute @queue.respond_to? :queue
+  end
+
+  def test_iterate_queue
+    iterate_setup("fifo")
+    assert_equal 1, @queue.dequeue
+    assert_equal 2, @queue.dequeue
+    assert_equal 3, @queue.dequeue
+    assert_equal 4, @queue.dequeue
+    assert_equal 5, @queue.dequeue
+    assert @queue.empty?
+  end
+  
+  def test_to_string
+    iterate_setup("fifo")
+    assert_equal "5,4,3,2,1", @queue.to_s
+  end
+  
+  def test_to_string_stack
+    iterate_setup("lifo")
+    assert_equal "1,2,3,4,5", @queue.to_s
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: mvgraph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Mckenzie, Dan Vingo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-17 00:00:00.000000000 -04:00
+default_executable: 
+dependencies: []
+description: ! "mvGraph is an implementation of the graph data structure in Ruby.
+  \ It was created to solve \nsome classic AI search problems; as such, it currently
+  supports BFS, DFS, any user-defined heuristic search, as well as A*.\n"
+email: danvingo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE.txt
+- test/test_mvGraph.rb
+- test/test_mvQueue.rb
+- Gemfile.lock
+- Gemfile
+- README
+- doc/design.txt
+- lib/mvQueue.rb
+- lib/mvGraph.rb
+- Rakefile
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2p180
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- None
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A generic graph implementation, useful for solving problems where some sort
+  of search is needed.
+test_files:
+- test/test_mvGraph.rb
+- test/test_mvQueue.rb