algorithms 0.1.0 → 0.2.0

data/spec/priority_queue_spec.rb

@@ -1,75 +1,75 @@
 $: << File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
 require 'algorithms'
 
-describe "empty priority queue" do
+describe Containers::PriorityQueue do
   before(:each) do
     @q = Containers::PriorityQueue.new
   end
-
-  it "should return 0 for size and be empty" do
-    @q.size.should eql(0)
-    @q.should be_empty
-  end
-
-  it "should not return anything" do
-    @q.next.should be_nil
-    @q.pop.should be_nil
-    @q.delete(1).should be_nil
-    @q.has_priority?(1).should be_false
-  end
-
-  it "should give the correct size when adding items" do
-    20.times do |i|
-      @q.size.should eql(i)
-      @q.push(i, i)
+  
+  describe "(empty priority queue)" do
+    it "should return 0 for size and be empty" do
+      @q.size.should eql(0)
+      @q.should be_empty
     end
-    10.times do |i|
-      @q.size.should eql(20-i)
-      @q.pop
+    
+    it "should not return anything" do
+      @q.next.should be_nil
+      @q.pop.should be_nil
+      @q.delete(1).should be_nil
+      @q.has_priority?(1).should be_false
     end
-    10.times do |i|
-      @q.size.should eql(i+10)
-      @q.push(i, i)
+    
+    it "should give the correct size when adding items" do
+      20.times do |i|
+        @q.size.should eql(i)
+        @q.push(i, i)
+      end
+      10.times do |i|
+        @q.size.should eql(20-i)
+        @q.pop
+      end
+      10.times do |i|
+        @q.size.should eql(i+10)
+        @q.push(i, i)
+      end
+      @q.delete(5)
+      @q.size.should eql(19)
     end
-    @q.delete(5)
-    @q.size.should eql(19)
-  end
-end
-
-describe "non-empty priority queue" do
-  before(:each) do
-    @q = Containers::PriorityQueue.new
-    @q.push("Alaska", 50)
-    @q.push("Delaware", 30)
-    @q.push("Georgia", 35)
-  end
-
-  it "should next/pop the highest priority" do
-    @q.next.should eql("Alaska")
-    @q.size.should eql(3)
-    @q.pop.should eql("Alaska")
-    @q.size.should eql(2)
   end
-
-  it "should not be empty" do
-    @q.should_not be_empty
-  end
-
-  it "should has_priority? priorities it has" do
-    @q.has_priority?(50).should be_true
-    @q.has_priority?(10).should be_false
-  end      
-
-  it "should return nil after popping everything" do
-    3.times do 
-      @q.pop
+  
+  describe "(non-empty priority queue)" do
+    before(:each) do
+      @q.push("Alaska", 50)
+      @q.push("Delaware", 30)
+      @q.push("Georgia", 35)
+    end
+    
+    it "should next/pop the highest priority" do
+      @q.next.should eql("Alaska")
+      @q.size.should eql(3)
+      @q.pop.should eql("Alaska")
+      @q.size.should eql(2)
+    end
+    
+    it "should not be empty" do
+      @q.should_not be_empty
+    end
+    
+    it "should has_priority? priorities it has" do
+      @q.has_priority?(50).should be_true
+      @q.has_priority?(10).should be_false
+    end      
+    
+    it "should return nil after popping everything" do
+      3.times do 
+        @q.pop
+      end
+      @q.pop.should be_nil
+    end
+    
+    it "should delete things it has and not things it doesn't" do
+      @q.delete(50).should eql("Alaska")
+      @q.delete(10).should eql(nil)
     end
-    @q.pop.should be_nil
-  end
-
-  it "should delete things it has and not things it doesn't" do
-    @q.delete(50).should eql("Alaska")
-    @q.delete(10).should eql(nil)
   end
-
 end

data/spec/rb_tree_map_gc_mark_spec.rb

@@ -0,0 +1,25 @@
+$: << File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
+require 'algorithms'
+
+if defined? Containers::CRBTreeMap
+  describe "CRBTreeMap" do
+    it "should mark ruby object references" do
+      anon_key_class = Class.new do
+        attr :value
+        def initialize(x); @value = x; end
+        def <=>(other); value <=> other.value; end
+      end
+      anon_val_class = Class.new
+      @tree = Containers::CRBTreeMap.new
+      100.times { |x| @tree[anon_key_class.new(x)] = anon_val_class.new }
+      # Mark and sweep
+      ObjectSpace.garbage_collect
+      # Check if any instances were swept
+      count = 0
+      ObjectSpace.each_object(anon_key_class) { |x| count += 1 }
+      count.should eql(100)
+      ObjectSpace.each_object(anon_val_class) { |x| count += 1 }
+      count.should eql(200)
+    end
+  end
+end

data/spec/splay_tree_map_spec.rb

@@ -1,7 +1,7 @@
 $: << File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
 require 'algorithms'
   
-describe "(empty splay)", :shared => true do
+describe "empty splaytree", :shared => true do
   it "should let you push stuff in" do
     100.times { |x| @tree[x] = x }
     @tree.size.should eql(100)
@@ -21,7 +21,7 @@ describe "(empty splay)", :shared => true do
   end
 end
 
-describe "(non-empty splay)", :shared => true do
+describe "non-empty splaytree", :shared => true do
   before(:each) do
     @num_items = 100
     @random_array = []
@@ -69,34 +69,34 @@ describe "(non-empty splay)", :shared => true do
   end
 end
 
-# describe Containers::CRBTreeMap do
-#   describe "empty" do
-#     before(:each) do
-#       @tree = Containers::CRBTreeMap.new
-#     end
-#     it_should_behave_like "(empty)"
-#   end
-#   
-#   describe "full" do
-#     before(:each) do
-#       @tree = Containers::CRBTreeMap.new
-#     end
-#     it_should_behave_like "(non-empty)"
-#   end
-# end
+describe "empty splaytreemap" do
+  before(:each) do
+    @tree = Containers::RubySplayTreeMap.new
+  end
+  it_should_behave_like "empty splaytree"
+end
+
+describe "full splaytreemap" do
+  before(:each) do
+    @tree = Containers::RubySplayTreeMap.new
+  end
+  it_should_behave_like "non-empty splaytree"
+end
 
-# describe Containers::SplayTreeMap do
-  describe "empty splaytreemap" do
+begin
+  Containers::CSplayTreeMap
+  describe "empty csplaytreemap" do
     before(:each) do
-      @tree = Containers::SplayTreeMap.new
+      @tree = Containers::CSplayTreeMap.new
     end
-    it_should_behave_like "(empty splay)"
+    it_should_behave_like "empty splaytree"
   end
-  
-  describe "full splaytreemap" do
+
+  describe "full csplaytreemap" do
     before(:each) do
-      @tree = Containers::SplayTreeMap.new
+      @tree = Containers::CSplayTreeMap.new
     end
-    it_should_behave_like "(non-empty splay)"
+    it_should_behave_like "non-empty splaytree"
   end
-# end
+rescue Exception
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: algorithms
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kanwei Li
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-21 00:00:00 -05:00
+date: 2009-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -18,16 +18,16 @@ email: kanwei@gmail.com
 executables: []
 
 extensions: 
-- ext/containers/bst/extconf.rb
 - ext/containers/deque/extconf.rb
-- ext/containers/tree_map/extconf.rb
+- ext/containers/rbtree_map/extconf.rb
+- ext/containers/splaytree_map/extconf.rb
 extra_rdoc_files: 
-- ext/containers/bst/bst.c
-- ext/containers/bst/extconf.rb
 - ext/containers/deque/deque.c
 - ext/containers/deque/extconf.rb
-- ext/containers/tree_map/extconf.rb
-- ext/containers/tree_map/rbtree.c
+- ext/containers/rbtree_map/extconf.rb
+- ext/containers/rbtree_map/rbtree.c
+- ext/containers/splaytree_map/extconf.rb
+- ext/containers/splaytree_map/splaytree.c
 - lib/algorithms/search.rb
 - lib/algorithms/sort.rb
 - lib/algorithms.rb
@@ -41,24 +41,18 @@ extra_rdoc_files:
 - lib/containers/stack.rb
 - lib/containers/suffix_array.rb
 - lib/containers/trie.rb
-- lib/graphs/graph.rb
-- README
+- README.markdown
 files: 
 - algorithms.gemspec
-- benchmark.rb
-- benchmarks/rbench/column.rb
-- benchmarks/rbench/group.rb
-- benchmarks/rbench/report.rb
-- benchmarks/rbench/runner.rb
-- benchmarks/rbench/summary.rb
-- benchmarks/rbench.rb
+- benchmarks/deque.rb
 - benchmarks/sorts.rb
-- ext/containers/bst/bst.c
-- ext/containers/bst/extconf.rb
+- benchmarks/treemaps.rb
 - ext/containers/deque/deque.c
 - ext/containers/deque/extconf.rb
-- ext/containers/tree_map/extconf.rb
-- ext/containers/tree_map/rbtree.c
+- ext/containers/rbtree_map/extconf.rb
+- ext/containers/rbtree_map/rbtree.c
+- ext/containers/splaytree_map/extconf.rb
+- ext/containers/splaytree_map/splaytree.c
 - History.txt
 - lib/algorithms/search.rb
 - lib/algorithms/sort.rb
@@ -73,16 +67,16 @@ files:
 - lib/containers/stack.rb
 - lib/containers/suffix_array.rb
 - lib/containers/trie.rb
-- lib/graphs/graph.rb
 - Manifest
 - Rakefile
-- README
-- spec/bst_spec.rb
+- README.markdown
+- spec/deque_gc_mark_spec.rb
 - spec/deque_spec.rb
 - spec/heap_spec.rb
 - spec/kd_tree_spec.rb
 - spec/priority_queue_spec.rb
 - spec/queue_spec.rb
+- spec/rb_tree_map_gc_mark_spec.rb
 - spec/rb_tree_map_spec.rb
 - spec/search_spec.rb
 - spec/sort_spec.rb
@@ -99,7 +93,7 @@ rdoc_options:
 - --title
 - Algorithms
 - --main
-- README
+- README.markdown
 require_paths: 
 - lib
 - ext

data/README

@@ -1,90 +0,0 @@
-= algorithms
-
-* http://rubyforge.org/projects/algorithms/
-* Documentation: http://algorithms.rubyforge.org/
-
-== DESCRIPTION:
-
-This is a Google Summer of Code 2008 project
-
-Written by Kanwei Li, mentored by Austin Ziegler
-
-Using the right data structure or algorithm for the situation is an important
-aspect of programming. In computer science literature, many data structures
-and algorithms have been researched and extensively documented. However, there
-is still no standard library in Ruby implementing useful structures and
-algorithms like Red/Black Trees, tries, different sorting algorithms, etc.
-This project will create such a library with documentation on when to use a
-particular structure/algorithm. It will also come with a benchmark suite to
-compare performance in different situations.
-
-== FEATURES/PROBLEMS:
-
-Done so far:
-* Heaps           - Containers::Heap, Containers::MaxHeap, Containers::MinHeap
-* Priority Queue  - Containers::PriorityQueue
-* Stack           - Containers::Stack
-* Queue           - Containers::Queue
-* Deque           - Containers::Deque, Containers::CDeque (C extension), Containers::RubyDeque
-* Red-Black Trees - Containers::RBTreeMap, Containers::CRBTreeMap (C extension), Containers::RubyRBTreeMap
-* Splay Trees     - Containers::SplayTreeMap
-* Tries           - Containers::Trie
-* Suffix Array    - Containers::SuffixArray
-
-* Search algorithms
-  - Binary Search         - Algorithms::Search.binary_search
-  - Knuth-Morris-Pratt    - Algorithms::Search.kmp_search
-* Sort algorithms
-  - Bubble sort           - Algorithms::Sort.bubble_sort
-  - Comb sort             - Algorithms::Sort.comb_sort
-  - Selection sort        - Algorithms::Sort.selection_sort
-  - Heapsort              - Algorithms::Sort.heapsort
-  - Insertion sort        - Algorithms::Sort.insertion_sort
-  - Shell sort            - Algorithms::Sort.shell_sort
-  - Quicksort             - Algorithms::Sort.quicksort
-  - Mergesort             - Algorithms::Sort.mergesort
-
-== SYNOPSIS:
-
-  require 'rubygems'
-  require 'algorithms'
-  
-  max_heap = Containers::MaxHeap.new
-  
-  # To not have to type "Containers::" before each class, use:
-  include Containers
-  max_heap = MaxHeap.new
-
-== REQUIREMENTS:
-
-* Ruby 1.8 compatible Ruby, or Ruby 1.9
-* C compiler for extensions (optional)
-
-== INSTALL:
-
-* sudo gem install
-
-== LICENSE:
-
-(The MIT License)
-
-Algorithms and Containers project is Copyright (c) 2008 Kanwei Li
-
-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/benchmark.rb

@@ -1,51 +0,0 @@
-# :nodoc: all
-$: << File.join(File.expand_path(File.dirname(__FILE__)), 'lib')
-require 'algorithms'
-
-require 'benchmark'
-include Benchmark
-
-# Benchmark heap
-@random_array = []
-@num_items = 10000
-@num_items.times { |x| @random_array << rand(@num_items) }
-# @heap = Containers::MaxHeap.new(@random_array)
-# 
-# benchmark do |bench|
-#   bench.report("Array#max:\t ") do
-#     @num_items.times { @random_array.delete_at(@random_array.index(@random_array.max)) }
-#   end
-#   bench.report("MaxHeap:\t ") do
-#     @num_items.times { @heap.max! }
-#   end
-# end
-
-# Benchmark Deque
-deque = Containers::RubyDeque.new
-array = []
-benchmark do |bench|
-  bench.report("Array:\t ") { 1000000.times  { |x| array << x } }
-  bench.report("Deque:\t ") { 1000000.times  { |x| deque.push_back(x) } }
-end
-
-# Benchmark Search trees
-@rb_tree = Containers::RubyRBTreeMap.new
-@splay_tree = Containers::SplayTreeMap.new
-@hash = Hash.new
-
-benchmark do |bench|
-  puts "\nInsertion"
-  bench.report("RBTree: \t")    { @random_array.each  { |x| @rb_tree[x] = x } }
-  bench.report("SplayTree: \t") { @random_array.each  { |x| @splay_tree[x] = x } }
-  bench.report("Hash: \t\t")    { @hash.each          { |x| @hash[x] = x } }
-  
-  puts "\nTest has_key?" 
-  bench.report("RBTree: \t")    { @num_items.times { |n| @rb_tree.has_key?(n) } }
-  bench.report("SplayTree: \t") { @num_items.times { |n| @splay_tree.has_key?(n) } }
-  bench.report("Hash: \t\t")    { @num_items.times { |n| @hash.has_key?(n) } }
-  
-  puts "\nSorted order" 
-  bench.report("RBTree: \t")    { @rb_tree.each { |k, v| k } }
-  bench.report("SplayTree: \t") { @splay_tree.each { |k, v| k } }
-  bench.report("Hash: \t\t")    { @hash.sort.each { |k, v| k } }
-end