rankable_graph 0.1.0 → 0.2.0

data/.gitignore

@@ -24,3 +24,4 @@ ext/*.o
 lib/*.bundle
 lib/*.o
 **/*/*.gem
+**/*/*.log

data/README.rdoc

@@ -34,6 +34,36 @@ Which outputs
   Node 8888 rank is 0.0375000014901161
 
 This ranks represent the probabilities that a certain node will be visited.
+
+If you want to calculate the rank of another graph is recommended to call the clear method and reuse the RankableGraph instance as this frees the used memory without relying in the Ruby garbage collector.
+So instead of:
+
+  rankable_graph = RankableGraph.new
+
+  rankable_graph.link(0, 1)
+  rankable_graph.link(1, 2)
+  rankable_graph.rank(0.85, 0.0001){ |identifier, rank| puts "Node #{identifier} rank for graph1 is #{rank}" }
+
+  rankable_graph = RankableGraph.new
+
+  rankable_graph.link(0, 1)
+  rankable_graph.link(2, 1)
+  rankable_graph.rank(0.85, 0.0001){ |identifier, rank| puts "Node #{identifier} rank for graph2 is #{rank}" }
+
+It's better if you do:
+
+  rankable_graph = RankableGraph.new
+
+  rankable_graph.link(0, 1)
+  rankable_graph.link(1, 2)
+  rankable_graph.rank(0.85, 0.0001){ |identifier, rank| puts "Node #{identifier} rank for graph1 is #{rank}" }
+
+  rankable_graph.clear
+
+  rankable_graph.link(0, 1)
+  rankable_graph.link(2, 1)
+  rankable_graph.rank(0.85, 0.0001){ |identifier, rank| puts "Node #{identifier} rank for graph2 is #{rank}" }
+
 For more examples please refer to the tests.
 
 == Requirements

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/benchmark.rb

@@ -1,6 +1,4 @@
-#require 'rubygems'
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'ext'))
-
+#Not a benchmark, just a very unscientific test
 require 'ext/rankable_graph'
 
 require "benchmark"
@@ -8,23 +6,21 @@ include Benchmark
 
 n = 1000000
 bmbm(12) do |test|
-    r = RankableGraph.new
+  r = RankableGraph.new
+  test.report("c:")    do
     srand(5)
     (0..(n-1)).map do |i|
       #each node has an average of 30 links
       rand(60).times do
         j = rand(n)
-        #first three nodes are more linked to than the rest
+        #first three nodes have more links than the rest
         r.link(i, (j > 800000 ? rand(3) : j))
       end
     end
-
-  test.report("c:")    do
     result = []
     r.rank(0.85, 0.001){|key, val| result << [key, val]}
     puts "7 first values are #{result[0..6].map{|(k,v)| "[#{k}]=#{"%.4f" % (v * 100)}, "}}"
+
+    r.clear
   end
 end
-
-
-

data/ext/rankable_graph.c

@@ -213,6 +213,19 @@ static VALUE rankable_graph_init_copy(VALUE copy, VALUE orig){
   return copy;
 }
 
+static VALUE clear(VALUE self){
+  RNStruct* rn;
+  Data_Get_Struct(self, RNStruct, rn);
+
+  rn->current_available_index = -1;
+  g_hash_table_remove_all(rn->index_to_key);
+  g_hash_table_remove_all(rn->key_to_index);
+  g_ptr_array_set_size(rn->number_out_links, 0);
+  g_ptr_array_set_size(rn->in_links, 0);
+
+  return Qnil;
+}
+
 static VALUE rb_cRankableGraph;
 
 void Init_rankable_graph(){
@@ -221,6 +234,7 @@ void Init_rankable_graph(){
   rb_define_method(rb_cRankableGraph, "initialize", init, 0);
   rb_define_method(rb_cRankableGraph, "initialize_copy", rankable_graph_init_copy, 1);
   rb_define_method(rb_cRankableGraph, "link", link, 2);
+  rb_define_method(rb_cRankableGraph, "clear", clear, 0);
   rb_define_method(rb_cRankableGraph, "rank", rank, 2);
 }
 

data/rankable_graph.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rankable_graph}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Cadenas"]
-  s.date = %q{2010-02-01}
+  s.date = %q{2010-02-05}
   s.description = %q{A Ruby Pagerank implementation}
   s.email = %q{dev@cuboxsa.com}
   s.extensions = ["ext/extconf.rb"]
@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
      "benchmark.rb",
      "ext/Makefile",
      "ext/extconf.rb",
-     "ext/mkmf.log",
      "ext/rankable_graph.c",
      "rankable_graph.gemspec",
      "spec/rankable_graph_spec.rb",

data/spec/rankable_graph_spec.rb

@@ -12,6 +12,30 @@ def assert_rank(rankable_graph, expected_rank)
 end
 
 describe RankableGraph do
+  it "should be possible to recalculate the ranks after a new link is added" do
+    rankable_graph = RankableGraph.new
+    rankable_graph.link(0, 1)
+    assert_rank(rankable_graph, { 0 => 35.1, 1 => 64.9 })
+    rankable_graph.link(1, 2)
+    assert_rank(rankable_graph, { 0 => 18.4, 1 => 34.1, 2 => 47.4 })
+  end
+
+  it "should be possible to clear the graph" do
+    rankable_graph = RankableGraph.new
+    rankable_graph.link(0, 1)
+    rankable_graph.link(1, 2)
+    rankable_graph.clear
+    rankable_graph.link(0, 1)
+    assert_rank(rankable_graph, { 0 => 35.1, 1 => 64.9 })
+  end
+
+  it "should not raise an exception when calculating the rank of an empty graph" do
+    rankable_graph = RankableGraph.new
+    lambda do
+      rankable_graph.rank(0.85, 0.0001){|label, rank| raise "This should not be raised!" }
+    end.should_not raise_error
+  end
+
   it "should return correct results when having a dangling node" do
     rankable_graph = RankableGraph.new
     #node 2 is a dangling node because it has no outbound links

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'ext'))
-require 'ext/rankable_graph'
+require 'rankable_graph'
 require 'spec'
 require 'spec/autorun'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rankable_graph
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Cadenas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 -02:00
+date: 2010-02-05 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,6 @@ files:
 - benchmark.rb
 - ext/Makefile
 - ext/extconf.rb
-- ext/mkmf.log
 - ext/rankable_graph.c
 - rankable_graph.gemspec
 - spec/rankable_graph_spec.rb

data/ext/mkmf.log

@@ -1,5 +0,0 @@
-package configuration for glib-2.0
-cflags: -I/opt/local/include/glib-2.0 -I/opt/local/lib/glib-2.0/include -I/opt/local/include  
-ldflags: -L/opt/local/lib
-libs: -lglib-2.0 -lintl -liconv  
-