pathing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff3d8c9d22d0eee8f8a4ee996b77e1a41a768339
+  data.tar.gz: 2086abcafcf1e8f00cd5e0b3b7620129f2192a29
+SHA512:
+  metadata.gz: fe8479732bb37702e52c7b4ad9b230ae95a76d9af7ec36b09be5b5b0a6f03259cdfe83dc64ac7724775d4c002d9322cd9bdaa68900e7afe8a3afcf945e2e3aca
+  data.tar.gz: d14ec4fb8c2ce9fdf604d3f09cfa25cc6458f720dbddc643bcb79775b35e81baba95b42408bcbd3f0ddfca58281e09d472fa8d7ffb735ae6c0d71fcb6a620021

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    pathing (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+    rake-compiler (0.9.5)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pathing!
+  rake-compiler

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nick Lowery
+
+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.md

@@ -0,0 +1,2 @@
+# pathing
+Dijkstra's algorithm pathfinding in Ruby

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new 'pathing'

data/ext/pathing/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+extension_name = 'pathing'
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/pathing/graph.c

@@ -0,0 +1,176 @@
+#include "graph.h"
+
+extern VALUE Pathing;
+extern VALUE Node;
+VALUE Graph = Qnil;
+
+void define_graph_stuff(void)
+{
+  Graph = rb_define_class_under(Pathing, "Graph", rb_cObject);
+  rb_define_method(Graph, "initialize", Graph_initialize, 1);
+  rb_define_method(Graph, "path", Graph_path, 2);
+}
+
+/*
+ * Creates a new Graph object with the given interface object.
+ */
+VALUE Graph_initialize(VALUE self, VALUE interface)
+{
+  if (!rb_respond_to(interface, rb_intern("neighbors_for")))
+  {
+    rb_raise(rb_eArgError, "interface must respond to \"neighbors_for\"");
+    return Qnil;
+  }
+ 
+  if (!rb_respond_to(interface, rb_intern("edge_cost_between")))
+  {
+    rb_raise(rb_eArgError, "interface must respond to \"edge_cost_between\"");
+    return Qnil;
+  }
+
+  rb_iv_set(self, "@interface", interface);
+
+  return self;
+}
+
+/*
+ * Returns the neighbors for a given node key as described by the interface.
+ */
+VALUE Graph_neighbors(VALUE interface, VALUE key)
+{
+  return rb_funcall(interface, rb_intern("neighbors_for"), 1, key);
+}
+
+/*
+ * Returns the edge cost between the two given node keys as described by the
+ * interface.
+ */
+VALUE Graph_edge_cost(VALUE interface, VALUE key1, VALUE key2)
+{
+  return rb_funcall(interface, rb_intern("edge_cost_between"), 2, key1, key2); 
+}
+
+/*
+ * Calculates a path from the key1 Node to the key2 node using Dijksta's
+ * algorithm. Returns an ordered array of the keys of each Node in the path.
+ */
+VALUE Graph_path(VALUE self, VALUE key1, VALUE key2)
+{
+  DPRINT("pathing from %s to %s\n", RSTRING_PTR(rb_inspect(key1)),
+    RSTRING_PTR(rb_inspect(key2)));
+  VALUE path = rb_ary_new();
+  VALUE interface = rb_iv_get(self, "@interface");
+
+  // beware: Dijksta's algorithm ahead
+
+  VALUE settled = rb_ary_new();
+  VALUE unsettled = rb_ary_new();
+  VALUE prev_nodes = rb_hash_new();
+  VALUE costs = rb_hash_new();
+  VALUE neighbors;
+  VALUE least;
+  VALUE args;
+  
+  // add start node to unsettled
+  rb_ary_push(unsettled, key1);
+  rb_hash_aset(costs, key1, DBL2NUM(0.0));
+
+  // pathfinding loop
+  while (RARRAY_LEN(unsettled) > 0)
+  {
+    // find least-cost unsettled node and move it to settled
+    least = rb_block_call(unsettled, rb_intern("min_by"), 0, NULL,
+      value_from_key, costs);
+    DPRINT("move %s to settled\n", RSTRING_PTR(rb_inspect(least)));
+    rb_ary_delete(unsettled, least);
+    if (least == key2) break;
+    rb_ary_push(settled, least);
+
+    // update cost for each neighbor of moved node if less than existing cost
+   
+   args = rb_ary_new();
+    rb_ary_push(args, interface);
+    rb_ary_push(args, least);
+    rb_ary_push(args, costs);
+    rb_ary_push(args, prev_nodes);
+    rb_ary_push(args, unsettled);
+    
+    neighbors = Graph_neighbors(interface, least);
+    if (neighbors == Qnil)
+    {
+      rb_raise(rb_eRuntimeError, "node %s neighbor collection is nil",
+        RSTRING_PTR(rb_inspect(least)));
+      return Qnil;
+    }
+
+    rb_block_call(neighbors,
+      rb_intern("each"), 0, NULL, update_neighbor_cost, args);
+  }
+
+  // build path from end to start
+  VALUE curr_node = key2;
+  while (curr_node != Qnil)
+  {
+    rb_ary_unshift(path, curr_node);
+    curr_node = rb_hash_aref(prev_nodes, curr_node);
+  }
+
+  return path;
+}
+
+/*
+ * Updates the cost to reach the given node neighbor to the other given node.
+ */
+VALUE update_neighbor_cost(VALUE neighbor, VALUE args)
+{
+  VALUE interface = rb_ary_entry(args, 0);
+  VALUE node = rb_ary_entry(args, 1);
+  VALUE costs = rb_ary_entry(args, 2);
+  VALUE prev_nodes = rb_ary_entry(args, 3);
+  VALUE unsettled = rb_ary_entry(args, 4);
+
+  float old_cost;
+  VALUE rb_old_cost = rb_hash_aref(costs, neighbor);
+  if (rb_old_cost != Qnil)
+    old_cost = (float) NUM2DBL(rb_old_cost);
+
+  VALUE rb_rel_cost = Graph_edge_cost(interface, node, neighbor);
+  if (rb_rel_cost == Qnil)
+  {
+    rb_raise(rb_eRuntimeError, "cost between nodes %s and %s is nil",
+      RSTRING_PTR(rb_inspect(node)), RSTRING_PTR(rb_inspect(neighbor)));
+    return Qnil;
+  }
+
+  // cost to start node + cost between start and neighbor node
+  float new_cost = (float) NUM2DBL(rb_hash_aref(costs, node)) +
+    (float) NUM2DBL(Graph_edge_cost(interface, node, neighbor));
+
+  if (rb_old_cost != Qnil)
+  {
+    old_cost = (float) NUM2DBL(rb_old_cost);
+    if (new_cost < old_cost)
+    {
+      rb_hash_aset(costs, neighbor, DBL2NUM(new_cost));
+      rb_hash_aset(prev_nodes, neighbor, node);
+      rb_ary_push(unsettled, neighbor);
+    }
+  }
+  else
+  {
+    rb_hash_aset(costs, neighbor, DBL2NUM(new_cost));
+    rb_hash_aset(prev_nodes, neighbor, node);
+    rb_ary_push(unsettled, neighbor);
+  }
+
+  return Qnil;
+}
+
+/*
+ * Returns the value in the given hash with the given key. Used as a callback
+ * for rb_block_call.
+ */
+VALUE value_from_key(VALUE key, VALUE hash)
+{
+  return rb_hash_aref(hash, key);
+}

data/ext/pathing/graph.h

@@ -0,0 +1,10 @@
+#include "ruby.h"
+#include "util.h"
+
+void define_graph_stuff(void);
+VALUE Graph_initialize(VALUE self, VALUE interface);
+VALUE Graph_neighbors(VALUE interface, VALUE key);
+VALUE Graph_edge_cost(VALUE interface, VALUE key1, VALUE key2);
+VALUE Graph_path(VALUE self, VALUE key1, VALUE key2);
+VALUE update_neighbor_cost(VALUE neighbor, VALUE args);
+VALUE value_from_key(VALUE key, VALUE hash);

data/ext/pathing/pathing.c

@@ -0,0 +1,10 @@
+#include "pathing.h"
+
+VALUE Pathing = Qnil;
+
+void Init_pathing(void)
+{
+  Pathing = rb_define_module("Pathing");
+  define_graph_stuff();
+}
+

data/ext/pathing/pathing.h

@@ -0,0 +1,4 @@
+#include "ruby.h"
+#include "graph.h"
+
+void Init_pathing(void);

data/ext/pathing/util.h

@@ -0,0 +1,8 @@
+#ifndef __PATHING_UTILS_H__
+#define __PATHING_UTILS_H__
+
+#define DPRINT(...)
+// uncomment the line below to print pathfinding debug information
+//#define DPRINT(...) (printf(__VA_ARGS__))
+
+#endif

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: pathing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Lowery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dijkstra's algorithm pathfinding
+email: nick.a.lowery@gmail.com
+executables: []
+extensions:
+- ext/pathing/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ext/pathing/extconf.rb
+- ext/pathing/graph.c
+- ext/pathing/graph.h
+- ext/pathing/pathing.c
+- ext/pathing/pathing.h
+- ext/pathing/util.h
+homepage: https://github.com/ClockVapor/pathing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Dijkstra's algorithm pathfinding
+test_files: []