PriorityQueue 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.1.2
+  * Repaired benchmark
+  * Added c_priority_queue wrapper, such that one can now require versions
+    explicitly using:
+        require "priority_queue/(c|ruby|poor)_priority_queue"
+  * Improved README
+
 0.1.1
   * Removed debug cruft
   * Added more documentation and examples

data/README

@@ -3,9 +3,9 @@
 ## Description
 This is a fibonacci-heap priority-queue implementation. That means
 
-insert:                      O(1)
-decrease_priority: Amortized O(1)
-delete_min:        Amortized O(log n)
+    insert:                      O(1)
+    decrease_priority: Amortized O(1)
+    delete_min:        Amortized O(log n)
 
 This project is different from K. Kodamas PQueue in that it allows a decrease
 key operation.  That makes PriorityQueue usable for algorithms like dijkstras
@@ -29,17 +29,24 @@ guarantee it will work for you.
 
 ## Installation
 
+### Installing from source
+
 De-compress archive and enter its top directory.
 Then type:
 
    ($ su)
-    $ ruby setup.rb
+    # ruby setup.rb
 
 These simple step installs this program under the default
 location of Ruby libraries.  You can also install files into
 your favorite directory by supplying setup.rb some options.
 Try "ruby setup.rb --help".
 
+### Installing a ruby gem
+
+   ($ su)
+    # gem install PriorityQueue
+
 ## Usage
 
 In this priority queue implementation the queue behaves similarly to a hash
@@ -81,5 +88,46 @@ that maps objects onto priorities.
 for more exmples look into the documentation, the unit tests and the benchmark
 suite.
 
-# Todo
+### Dijkstras shortest path algorithm
+    def dijkstra(start_node)
+      # Nodes that may have neighbours wich can be relaxed further
+      active = PriorityQueue.new         
+      # Best distances found so far
+      distances = Hash.new { 1.0 / 0.0 } 
+      # Parent pointers describing shortest paths for all nodes
+      parents = Hash.new                 
+
+      # Initialize with start node
+      active[start_node] = 0
+      until active.empty?
+	u, distance = active.delete_min
+	distances[u] = distance
+	d = distance + 1
+	u.neighbours.each do | v |
+	  next unless d < distances[v] # we can't relax this one
+	  active[v] = distances[v] = d
+	  parents[v] = u
+	end    
+      end
+      parents
+    end
+
+## Performance
+The benchmark directory contains an example where a random graph is created and
+the shortests paths from a random node in this graph to all other nodes are
+calculated with dijkstras shortests path algorithm. The algorithm is used to
+compare the three different priority queue implementations in this package.
+
+  * PoorPriorityQueue: A minimal priority queue implementation wich has
+    delete_min in O(n).
+  * RubyPriorityQueue: An efficent implementation in pure ruby.
+  * CPriorityQueue: The same efficent implementation as a c extension.
+  
+The results are shown here
+
+![Runtime for graphs of up to 8_000 Nodes](doc/compare_small.png "Runtime for graphs of up to 8_000 Nodes")
+
+![Runtime for graphs of up to 600_000 Nodes](doc/compare_big.png "Runtime for graphs of up to 600_000 Nodes")
+
+## Todo
   * Only write documentation once

data/benchmark/dijkstra.rb

@@ -1,7 +1,7 @@
-require 'PriorityQueue/RubyPriorityQueue'
-require 'PriorityQueue/PoorPriorityQueue'
-require 'PriorityQueue/CPriorityQueue'
-require 'pqueue'
+$:.unshift "~/lib/ruby"
+require 'priority_queue/ruby_priority_queue'
+require 'priority_queue/poor_priority_queue'
+require 'priority_queue/c_priority_queue'
 require 'benchmark'
 
 class Node
@@ -79,6 +79,7 @@ degrees = [2, 4, 16]
 degrees = [4, 16]
 degrees = [16]
 queues = [  CPriorityQueue,  PoorPriorityQueue,  RubyPriorityQueue ]
+queues = [  CPriorityQueue,  RubyPriorityQueue ]
 
 max_time = 400
 ignore = Hash.new
@@ -96,8 +97,9 @@ results = Hash.new { | h, k | h[k] =
 Benchmark.bm(30) do | b |
   sizes.each do | size |
     break if !ignore.empty? and ignore.values.inject(true) { | r, v | r and v }
+    puts
+    puts "Testing with graphs of size #{size}"
     degrees.each do | degree |
-      p ignore
       repeats.times do | r |
 	nodes = make_graph(size, degree)
 	queues.each do | queue |      

data/doc/compare_big.gp

@@ -0,0 +1,14 @@
+set term png
+set out 'compare_big.png'
+set xlabel 'Number of nodes'
+set ylabel 'Time in seconds (real)'
+set yrange [0:240]
+set ytics 30
+set grid ytics mytics
+set mytics 2
+#set logscale xy
+set title 'Dijkstras Shortest Path Algorithm using different PQ Implementations'
+plot \
+  'results.csv' using 1:2 with lines title "CPriorityQueue (Graph of Degree: 4)",\
+  'results.csv' using 1:4 with lines title "RubyPriorityQueue (Graph of Degree: 4)", \
+  'results.csv' using 1:3 with lines title "PoorPriorityQueue (Graph of Degree: 4)"

data/doc/compare_small.gp

@@ -0,0 +1,15 @@
+set term png
+set out 'compare_small.png'
+set xlabel 'Number of nodes'
+set ylabel 'Time in seconds (real)'
+set yrange [0:60]
+set xrange [0:8000]
+set ytics 15
+set grid ytics mytics
+set mytics 3
+#set logscale xy
+set title 'Dijkstras Shortest Path Algorithm using different PQ Implementations'
+plot \
+  'results.csv' using 1:2 with lines title "CPriorityQueue (Graph of Degree: 4)",\
+  'results.csv' using 1:4 with lines title "RubyPriorityQueue (Graph of Degree: 4)", \
+  'results.csv' using 1:3 with lines title "PoorPriorityQueue (Graph of Degree: 4)"

data/doc/results.csv

@@ -0,0 +1,37 @@
+size	"CPriorityQueue (Graph of Degree: 4)"	"PoorPriorityQueue (Graph of Degree: 4)"	"RubyPriorityQueue (Graph of Degree: 4)"
+100	0.00224618911743164	0.00624475479125977	0.00999178886413574
+200	0.00454645156860352	0.0206499099731445	0.0216238498687744
+300	0.00689601898193359	0.0456759929656982	0.0333521842956543
+400	0.00930037498474121	0.0799281597137451	0.0460003852844238
+500	0.0121791362762451	0.120535612106323	0.0602848052978516
+600	0.0147404193878174	0.175632238388062	0.0720498085021973
+700	0.017409610748291	0.239475774765015	0.0866350173950195
+800	0.019864559173584	0.308732604980469	0.0979691028594971
+900	0.0226212501525879	0.394028520584106	0.11493763923645
+1000	0.0251464366912842	0.487221813201904	0.125885772705078
+2000	0.0565140247344971	2.28050599098206	0.276543807983398
+3000	0.085650634765625	6.21102161407471	0.448645544052124
+4000	0.10867018699646	8.67334637641907	0.573670101165771
+5000	0.138333988189697	14.8025764465332	0.749224042892456
+6000	0.188258218765259	23.5921889781952	0.926058626174927
+7000	0.22198920249939	35.1978524208069	1.12497220039368
+8000	0.253745651245117	51.36594581604	1.34597997665405
+9000	0.261373472213745	48.2841837882996	1.37383661270142
+10000	0.296752548217773	63.1833290576935	1.60117835998535
+20000	0.624662017822266	277.677141237259	3.37345514297485
+30000	1.0169261932373	733.016969585419	5.47739477157593
+40000	1.29656438827515	''	7.03887400627136
+50000	1.84444799423218	''	9.04675197601318
+60000	2.16575860977173	''	11.4338163852692
+70000	2.34671788215637	''	12.989319562912
+80000	2.91462659835815	''	14.7507841110229
+90000	3.36594500541687	''	17.4672434329987
+100000	3.74284019470215	''	19.7872510433197
+200000	8.33274736404419	''	44.0830686569214
+300000	15.3942915916443	''	75.2278475284576
+400000	22.4600916385651	''	109.477935791016
+500000	29.9784585952759	''	150.160971403122
+600000	37.4891954421997	''	192.808595132828
+700000	''	''	''
+800000	''	''	''
+900000	''	''	''

data/ext/priority_queue/priority_queue.c

@@ -762,7 +762,6 @@ VALUE pq_length(VALUE self) {
   return INT2NUM(q->length);
 }
 
-/*
 /* call-seq:
  *    delete(key) -> [key, priority]
  *    delete(key) -> nil

data/lib/priority_queue/c_priority_queue.rb

@@ -0,0 +1 @@
+require "priority_queue/CPriorityQueue"

metadata

@@ -1,67 +1,75 @@
-!ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification 
 rubygems_version: 0.8.11
 specification_version: 1
 name: PriorityQueue
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2005-10-26 00:00:00 +02:00
+  version: 0.1.2
+date: 2005-10-30 00:00:00 +02:00
 summary: This is a fibonacci-heap priority-queue implementation
 require_paths: 
-- lib
-- lib
-- ext
+  - lib
+  - lib
+  - ext
 email: priority_queue@brian-schroeder.de
 homepage: http://ruby.brian-schroeder.de/priority_queue
 rubyforge_project: 
-description: "This is a fibonacci-heap priority-queue implementation. That means  insert:                      O(1) decrease_priority: Amortized O(1) delete_min:        Amortized O(log n)  This project is different from K. Kodamas PQueue in that it allows a decrease key operation.  That makes PriorityQueue usable for algorithms like dijkstras shortest path algorithm, while PQueue is more suitable for Heapsort and the like."
+description: "This is a fibonacci-heap priority-queue implementation. That means  insert:     
+  O(1) decrease_priority: Amortized O(1) delete_min:        Amortized O(log n) 
+  This project is different from K. Kodamas PQueue in that it allows a decrease
+  key operation.  That makes PriorityQueue usable for algorithms like dijkstras
+  shortest path algorithm, while PQueue is more suitable for Heapsort and the
+  like."
 autorequire: priority_queue.rb
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-- Brian Schroeder
+  - Brian Schroeder
 files: 
-- t.rb
-- Makefile
-- priority_queue.so
-- README
-- priority_queue.o
-- compare_comments.rb
-- CHANGELOG
-- setup.rb
-- ext
-- lib
-- test
-- benchmark
-- ext/priority_queue
-- ext/priority_queue/extconf.rb
-- ext/priority_queue/priority_queue.c
-- lib/priority_queue.rb
-- lib/priority_queue
-- lib/priority_queue/poor_priority_queue.rb
-- lib/priority_queue/ruby_priority_queue.rb
-- test/priority_queue_test.rb
-- benchmark/dijkstra.rb
-test_files: []
-
+  - Makefile
+  - priority_queue.so
+  - README
+  - priority_queue.o
+  - compare_comments.rb
+  - CHANGELOG
+  - setup.rb
+  - doc
+  - ext
+  - lib
+  - test
+  - benchmark
+  - doc/compare_big.gp
+  - doc/compare_big.png
+  - doc/compare_small.gp
+  - doc/compare_small.png
+  - doc/results.csv
+  - doc/c-vs-rb.png
+  - ext/priority_queue
+  - ext/priority_queue/extconf.rb
+  - ext/priority_queue/priority_queue.c
+  - lib/priority_queue.rb
+  - lib/priority_queue
+  - lib/priority_queue/c_priority_queue.rb
+  - lib/priority_queue/poor_priority_queue.rb
+  - lib/priority_queue/ruby_priority_queue.rb
+  - test/priority_queue_test.rb
+  - benchmark/dijkstra.rb
+test_files: 
+  - test/priority_queue_test.rb
 rdoc_options: []
-
 extra_rdoc_files: []
-
 executables: []
-
 extensions: 
-- ext/priority_queue/extconf.rb
+  - ext/priority_queue/extconf.rb
 requirements: []
-
-dependencies: []
-
+dependencies: []

data/t.rb

@@ -1,18 +0,0 @@
-class T
-  def initialize
-    begin
-      raise "T"
-    rescue => e
-      e1 = e
-    end
-    begin
-      raise "T"
-    rescue => e
-      e2 = e
-    end
-    r1 = 12 rescue Object => e
-    p [e1, e2, e, r1]
-  end
-end
-
-T.new