usearchtree 0.1.0

data/lib/usearchtree.rb

@@ -0,0 +1,8 @@
+require 'usearchtree/search'
+require 'usearchtree/breadth'
+require 'usearchtree/depth'
+require 'usearchtree/edge'
+require 'usearchtree/graph'
+require 'usearchtree/graphloader'
+require 'usearchtree/node'
+require 'usearchtree/uniform'

data/lib/usearchtree/breadth.rb

@@ -0,0 +1,22 @@
+class BreadthFirstSearch < SearchAlgorithm
+    def search
+        @list = [@start]
+        until @list.empty?
+            @history << @list.clone
+            parent = @list.shift
+            @traversal << parent
+            @cache[parent.key] = parent
+            if parent == @goal
+                return
+            end
+            parent.edges.each do |edge|
+                child = edge.node
+                if @cache and not @cache.has_key?(child.key)
+                    @cache[child.key] = child
+                    @tree[child] = parent
+                    @list << child
+                end
+            end
+        end
+    end
+end

data/lib/usearchtree/depth.rb

@@ -0,0 +1,23 @@
+class DepthFirstSearch < SearchAlgorithm
+    def search
+        @list = [@start]
+        until @list.empty?
+            @history << @list.clone
+            parent_node = @list.pop
+            @traversal << parent_node
+            @cache[parent_node.key] = parent_node
+            if parent_node == @goal
+                return
+            end
+            parent_node.edges.reverse_each do |edge|
+                node = edge.node
+                cost = edge.cost
+                if not @cache or not @cache.has_key? node.key
+                    @cache[node.key] = node
+                    @tree[node] = parent_node
+                    @list.push node
+                end
+            end
+        end
+    end
+end

data/lib/usearchtree/graph.rb

@@ -0,0 +1,68 @@
+# Represents any weighted, directed graph.
+#
+# Author: Johnny Lee Othon
+class Graph
+
+    def initialize
+        @nodes = Array.new
+        @next_id = 0
+    end
+
+    # Returns the list of nodes
+    def to_s
+        @nodes.to_s
+    end
+
+    # Returns the graph as a list of adjacencies
+    def to_adjacency_lists
+        if @nodes.empty?
+            "Empty graph"
+        else
+            @nodes.collect{|node| node.to_adjacency_list}.join("\n")
+        end
+    end
+
+    def node key
+        if key.kind_of? Integer
+            @nodes[key]
+        else
+            @nodes.find{|n| n.name == key}
+        end
+    end
+
+    # Adds a node to the graph and optionally sets a name.
+    def add_node name=nil
+        @nodes << Node.new(self.next_id, name)
+    end
+
+    # Adds an edge from node i to node j. Where i and j can be an index or a
+    # name.
+    def add_edge i, j, cost
+        self.node(i).add_edge self.node(j), cost
+    end
+
+    # Labels a single node with index i. Fails if the node does not exist.
+    def label_node i, name
+        @nodes[i].name = name
+    end
+
+    # Gets the number of nodes in the graph
+    def length
+        @nodes.length
+    end
+
+    # Gets the cost from node at i to node at j.
+    def cost i, j
+        nodeI = (i.kind_of? Node) ? i : self.node(i)
+        nodeJ = (j.kind_of? Node) ? j : self.node(j)
+        nodeI.cost(nodeJ)
+    end
+
+    # Gets and increases the next id.
+    def next_id
+        id = @next_id
+        @next_id += 1
+        id
+    end
+
+end

data/lib/usearchtree/graphloader.rb

@@ -0,0 +1,41 @@
+# Consumes a node_labels.txt file
+# e.g. http://people.sc.fsu.edu/~jburkardt%20/data/graph_representation/mst_node_labels.txt
+def load_label_nodes graph, file
+    File.open(file, 'r') do |f|
+        f.lazy.reject do |line|
+            line.chomp.empty? or line.start_with? '#'
+        end.with_index do |line, i|
+            line.chomp!
+            if not line.empty? and not line.start_with? '#'
+                unless graph.length > i
+                    graph.add_node
+                end
+                graph.label_node(i, line)
+            end
+        end
+    end
+    return graph
+end
+
+# Loads a distance matrix. Rows correspond to source nodes and columns
+# correspond to destination nodes. -1 indicates a non-connection, 0 indicates
+# the same node, and positive values indicate an edge.
+def load_distance_matrix graph, file
+    File.open(file, 'r') do |f|
+        f.each.reject do |line|
+            line.empty? or line.start_with? '#'
+        end.each.with_index do |line, i|
+            costs = line.split
+            costs = costs.collect &:to_i
+            costs.each.with_index do |cost, j|
+                unless graph.length > j
+                    graph.add_node
+                end
+                unless cost.zero? or cost == -1
+                    graph.add_edge i, j, cost
+                end
+            end
+        end
+    end
+    return graph
+end

data/lib/usearchtree/node.rb

@@ -0,0 +1,66 @@
+# Represents to a node in the graph
+#
+# Author: Johnny Lee Othon
+class Node
+
+    attr_accessor :id, :name
+
+    include Comparable
+
+    def initialize id, name=nil
+        @name = name
+        @id = id
+        @edges = Array.new
+    end
+
+    # Returns the name of the node or its id as a string.
+    def to_s
+        @name or "#{@id}"
+    end
+
+    # Returns the name of the node or its id as a string.
+    def inspect
+        self.to_s
+    end
+
+    def <=> other
+        return @id <=> other.id
+    end
+
+    # Returns the node in the format <code><id:name></code>.
+    def to_adjacency_list
+        s = "#{name}"
+        unless @name.nil? or @name.empty?
+            s += "(#{@id})"
+        end
+        unless @edges.empty?
+            s += ": "
+        end
+        nodes = @edges.map do |edge|
+            "#{edge.node}=>#{edge.cost}"
+        end.join(", ")
+        s += nodes
+    end
+
+    def add_edge node, cost
+        @edges << Edge.new(node, cost)
+    end
+
+    def cost node
+        edge = @edges.find{|e| e.node == node}
+        if edge
+            edge.cost
+        end
+    end
+
+    # Gets the name if exists or the id
+    def key
+        @name or @id
+    end
+
+    # Gets an enumerator of the edges
+    def edges
+        return @edges.each
+    end
+
+end

data/lib/usearchtree/search.rb

@@ -0,0 +1,58 @@
+# Author: Johnny Lee Othon
+class SearchAlgorithm
+
+    attr_reader :goal, :history, :space, :start, :traversal, :tree
+
+    # Initializes a search algorithm.
+    # Parameters:
+    # [space] a graph
+    # [start] the id or name of the starting node
+    # [goal] the id or name of the goal node
+    # [cache] <code>true</code> a cache of visited nodes is desired
+    def initialize space, start, goal, caches=true
+        @space = space
+        @start = space.node(start)
+        @goal = space.node(goal)
+        # node.key => node
+        @cache = (Hash.new if caches)
+        # order in which the graph nodes were traversed
+        @traversal = Array.new
+        # parent => parent_node
+        @tree = {@start => nil}
+        # lazy list of nodes from start to goal
+        @path = Array.new
+        # lazy total of cost from start to goal
+        @cost = nil
+        # history to see the history of the stack
+        @history = Array.new
+    end
+
+    # Performs the search and populates <code>traversal</code> and
+    # <code>tree</code>
+    def search
+        throw "Unimplemented"
+    end
+
+    # Returns a list of all nodes in order from start to goal.
+    def path
+        return @path if @path.any?
+        node = @goal
+        @cost = 0
+        while node
+            parent = @tree[node]
+            @path.insert(0, node)
+            @cost += parent ? parent.cost(node) : 0
+            node = parent
+        end
+        return @path
+    end
+
+    # Retruns the total cost from start to goal following the path specifed in
+    # <code>SearchAlgorithm#Path</code>.
+    def cost
+        self.path if @path.empty?
+        return @cost
+    end
+
+
+end

data/lib/usearchtree/uniform.rb

@@ -0,0 +1,24 @@
+class UniformCostSearch < SearchAlgorithm
+    def search
+        @list = [[0, @start]]
+        until @list.empty?
+            @history << @list.clone
+            cost, parent_node = @list.shift
+            @cache[parent_node.key] = parent_node.key
+            @traversal << [cost, parent_node]
+            return if parent_node == @goal
+            pcost = cost
+            parent_node.edges.each do |edge|
+                node = edge.node
+                cost = edge.cost + pcost
+                if not @cache or not @cache.has_key? node.key
+                    @cache[node.key] = node
+                    unless @tree.has_key? node
+                        @tree[node] = parent_node
+                    end
+                    @list << [cost, node]
+                end
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: usearchtree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnny Lee Othon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-14 00:00:00.000000000 Z
+dependencies: []
+description: Uninformed search trees!
+email: jleeothon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/usearchtree.rb
+- lib/usearchtree/breadth.rb
+- lib/usearchtree/depth.rb
+- lib/usearchtree/graph.rb
+- lib/usearchtree/graphloader.rb
+- lib/usearchtree/node.rb
+- lib/usearchtree/search.rb
+- lib/usearchtree/uniform.rb
+homepage: https://github.com/jleeothon/usearchtree
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Uninformed search trees!
+test_files: []