algorithms 0.3.0-jruby

data/History.txt

@@ -0,0 +1,172 @@
+=== April 3, 2009
+
+	* Finished C refactorization of SplayTree
+
+=== March 28, 2009
+
+	* Implemented SplayTree in C
+	* Made recursively_free_nodes methods static to fix a SEGFAULT
+	* Improved CBst
+	* Moved to Markdown for README
+	* 0.2.0 release
+
+=== January 19, 2009
+
+  * kd-tree for points in multi-dimensional space
+
+=== November 25, 2008
+
+  * Checked in gnufied's C BST
+  
+=== November 13, 2008
+
+  * Removed #each for Hash and Priority Queue (Feature)
+  
+=== September 15, 2008
+
+  * Added comb sort
+  * Benchmark work on sorting algorithms
+
+=== September 1, 2008
+
+  * Switched to Hanna rdoc template
+  * RBTree#isred now private
+
+=== August 20, 2008
+
+  * Implemented Knuth-Morris-Pratt substring algorithm
+  
+=== August 15, 2008
+
+  * Updated README to reflect progress
+
+=== August 10, 2008
+
+  * Implemented mergesort, insertion_sort, shell_sort, quicksort
+
+=== August 8, 2008
+
+  * Implemented bubble_sort, selection_sort, heapsort
+
+=== August 5, 2008
+
+  * Started Algorithms portion
+  * Implemented Search#binary_search
+
+=== July 20, 2008
+
+  * Iterate over trees iteratively instead of recursively
+  * Implemented Deque in C
+
+=== July 15, 2008
+
+  * Refactored namespaces, thank you Austin Ziegler!
+
+=== July 14, 2008
+
+  * Use alias_method instead of alias
+  * Found and fixed RBTree#delete bug (finally!)
+  * Refactored Trie, SuffixArray, SplayTreeMap
+
+=== July 13, 2008
+
+  * Refactored Deque
+  * Implemented Deque#reverse_each (like Array's)
+
+=== July 12, 2008
+
+  * Reformatted some specs to be more idiomatic (Thank you Federico Builes)
+
+=== July 10, 2008
+
+  * Added algorithm complexity information for all Containers
+  * Implemented Trie for string representation
+  * Implmented SuffixArray for fast substring search
+  * Fixed memory leak in CRBTree
+  * Updated Manifest and algorithms.rb to match progress
+
+=== July 9, 2008
+
+  * Implemented Deque
+  * Stack and Queue now use Deque
+  * Fixed issues with CRBTree's #empty? and delete methods
+
+=== July 8, 2008
+
+  * Can now iterate over a heap
+  * Renamed #contains_key -> has_key? since it's more idiomatic
+  * Implented #change_key and #delete for Heap
+  * Priority Queue is now implemented with the new Fibonacci Heap
+  * Removed old Priority Queue code as a result
+  * Heap: fixed #delete bug not checking if item exists, #has_key? bug 
+          for not returning boolean
+  * Heap: value field is now optional and defaults to the key if not specified
+  * More refactoring of RBTreeMap (both Ruby and C)
+  
+=== July 7, 2008
+
+  * Heap is now implemented with a Fibonacci Heap, not a binomial heap
+
+=== July 4, 2008
+
+  * Implemented SplayTreeMap
+  * Heap now uses kind_of? to check for other heaps when doing #merge
+  * Renamed some Heap methods for consistency with the rest of the library
+  * RBTreeMap#contains? -> contains_key?
+  * Refactored RBTreeMap to be more object-oriented
+  * More documentation for RBTreeMap
+
+=== July 3, 2008
+  
+  * Added documentation for Stack and Queue
+
+=== June 24, 2008
+  
+  * Imported Brian Amberg's priority queue implementation
+  * Now uses Echoe to build gem
+  * Gem builds for the first time
+
+=== June 18, 2008
+  
+  * Can now enumerate over RBTreeMap
+
+=== June 17, 2008
+
+  * RBTreemap#delete now returns deleted value
+  * Added delete method to C implementation
+
+=== June 16, 2008
+
+  * Implemented delete methods for RBTreeMap
+
+=== June 14, 2008
+
+  * Renamed the data structures module to "Containers"
+  * Removed dependence on stdbool.h
+  * Renamed RBTree to RBTreeMap
+
+=== June 13, 2008
+
+  * Implemented Sedgewick's Left Leaning Red Black Tree in C!
+
+=== June 12, 2008
+
+  * Implemented Sedgewick's Left Leaning Red Black Tree
+
+=== June 10, 2008
+
+  * Implemented merge! for other heaps and heap initialization from an array
+  * Implemented Queue
+
+=== June 9, 2008
+
+  * Finished binomial heap implementation
+
+=== June 8, 2008
+
+  * Added Stack
+  * Working on heap
+
+=== April 20
+
+  * Accepted to Google Summer of Code!

data/Manifest

@@ -0,0 +1,43 @@
+History.txt
+Manifest
+README.markdown
+Rakefile
+algorithms.gemspec
+benchmarks/deque.rb
+benchmarks/sorts.rb
+benchmarks/treemaps.rb
+ext/containers/deque/deque.c
+ext/containers/deque/extconf.rb
+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.rb
+lib/algorithms/search.rb
+lib/algorithms/sort.rb
+lib/containers/deque.rb
+lib/containers/heap.rb
+lib/containers/kd_tree.rb
+lib/containers/priority_queue.rb
+lib/containers/queue.rb
+lib/containers/rb_tree_map.rb
+lib/containers/splay_tree_map.rb
+lib/containers/stack.rb
+lib/containers/suffix_array.rb
+lib/containers/trie.rb
+spec/deque_gc_mark_spec.rb
+spec/deque_spec.rb
+spec/heap_spec.rb
+spec/kd_expected_out.txt
+spec/kd_test_in.txt
+spec/kd_tree_spec.rb
+spec/map_gc_mark_spec.rb
+spec/priority_queue_spec.rb
+spec/queue_spec.rb
+spec/rb_tree_map_spec.rb
+spec/search_spec.rb
+spec/sort_spec.rb
+spec/splay_tree_map_spec.rb
+spec/stack_spec.rb
+spec/suffix_array_spec.rb
+spec/trie_spec.rb

data/README.markdown

@@ -0,0 +1,93 @@
+# algorithms
+
+* Official homes are here on github, and at [rubyforge](http://rubyforge.org/projects/algorithms/)
+* Documentation: [http://algorithms.rubyforge.org/](http://algorithms.rubyforge.org/)
+
+## DESCRIPTION:
+
+Started as a [Google Summer of Code 2008](http://code.google.com/soc/2008/ruby/about.html) project
+
+Written by [Kanwei Li](http://kanwei.com/), mentored by Austin Ziegler
+
+Original Proposal: 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:
+
+Done so far:
+
+		* Heaps              Containers::Heap, Containers::MaxHeap, Containers::MinHeap
+		* Priority Queue     Containers::PriorityQueue
+		* Deque              Containers::Deque, Containers::CDeque (C extension), Containers::RubyDeque
+		* Stack              Containers::Stack (uses Deque)
+		* Queue              Containers::Queue (uses Deque)
+		* Red-Black Trees    Containers::RBTreeMap, Containers::CRBTreeMap (C extension), Containers::RubyRBTreeMap
+		* Splay Trees        Containers::SplayTreeMap, Containers::CSplayTreeMap (C extension), Containers::RubySplayTreeMap
+		* Tries              Containers::Trie
+		* Suffix Array       Containers::SuffixArray
+		* kd Tree   				 Containers::KDTree
+
+		* 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 C extensions (optional, but very much recommended for vast performance benefits)
+
+## INSTALL:
+
+* sudo gem install algorithms
+
+## LICENSE:
+
+(The MIT License)
+
+Algorithms and Containers project is Copyright (c) 2009 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/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'echoe'
+ 
+Echoe.new('algorithms') do |p|
+  p.author               = 'Kanwei Li'
+  p.email                = 'kanwei@gmail.com'
+  p.summary              = 'A library of algorithms and containers.'
+  p.url                  = 'http://rubyforge.org/projects/algorithms/'
+  p.version              = "0.3.0"
+  p.runtime_dependencies = []
+end
+
+task :default => :spec
+
+task :spec do
+  sh "spec spec/*.rb --color"
+end
+
+task :push do
+  sh "git push"    # Rubyforge
+  sh "git push --tags"    # Rubyforge
+  sh "git push gh" # Github
+  sh "git push gh --tags" # Github
+end
+
+task :hanna do
+  sh "rm -fr doc"
+  sh "hanna -SN lib/ -m Algorithms"
+  sh "scp -rq doc/* kanwei@rubyforge.org:/var/www/gforge-projects/algorithms"
+end
+

data/algorithms.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{algorithms}
+  s.version = "0.3.0"
+  s.platform = %q{jruby}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kanwei Li"]
+  s.date = %q{2009-11-16}
+  s.description = %q{A library of algorithms and containers.}
+  s.email = %q{kanwei@gmail.com}
+  s.extensions = ["ext/containers/deque/extconf.rb", "ext/containers/rbtree_map/extconf.rb", "ext/containers/splaytree_map/extconf.rb"]
+  s.extra_rdoc_files = ["README.markdown", "ext/containers/deque/deque.c", "ext/containers/deque/extconf.rb", "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.rb", "lib/algorithms/search.rb", "lib/algorithms/sort.rb", "lib/containers/deque.rb", "lib/containers/heap.rb", "lib/containers/kd_tree.rb", "lib/containers/priority_queue.rb", "lib/containers/queue.rb", "lib/containers/rb_tree_map.rb", "lib/containers/splay_tree_map.rb", "lib/containers/stack.rb", "lib/containers/suffix_array.rb", "lib/containers/trie.rb"]
+  s.files = ["History.txt", "Manifest", "README.markdown", "Rakefile", "algorithms.gemspec", "benchmarks/deque.rb", "benchmarks/sorts.rb", "benchmarks/treemaps.rb", "ext/containers/deque/deque.c", "ext/containers/deque/extconf.rb", "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.rb", "lib/algorithms/search.rb", "lib/algorithms/sort.rb", "lib/containers/deque.rb", "lib/containers/heap.rb", "lib/containers/kd_tree.rb", "lib/containers/priority_queue.rb", "lib/containers/queue.rb", "lib/containers/rb_tree_map.rb", "lib/containers/splay_tree_map.rb", "lib/containers/stack.rb", "lib/containers/suffix_array.rb", "lib/containers/trie.rb", "spec/deque_gc_mark_spec.rb", "spec/deque_spec.rb", "spec/heap_spec.rb", "spec/kd_expected_out.txt", "spec/kd_test_in.txt", "spec/kd_tree_spec.rb", "spec/map_gc_mark_spec.rb", "spec/priority_queue_spec.rb", "spec/queue_spec.rb", "spec/rb_tree_map_spec.rb", "spec/search_spec.rb", "spec/sort_spec.rb", "spec/splay_tree_map_spec.rb", "spec/stack_spec.rb", "spec/suffix_array_spec.rb", "spec/trie_spec.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://rubyforge.org/projects/algorithms/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Algorithms", "--main", "README.markdown"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{algorithms}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A library of algorithms and containers.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/benchmarks/deque.rb

@@ -0,0 +1,17 @@
+$: << File.join(File.expand_path(File.dirname(__FILE__)), '../lib')
+require 'algorithms'
+include Algorithms
+
+require 'rubygems'
+require 'rbench'
+
+RBench.run(2) do
+  %w(array deque).each { |s| self.send(:column, s.intern) }
+  deque = Containers::Deque.new
+  array = []
+  
+  report "Insertion at end" do
+    array { 1000000.times  { |x| array << x } }
+    deque { 1000000.times  { |x| deque.push_back(x) } }
+  end
+end

data/benchmarks/sorts.rb

@@ -0,0 +1,34 @@
+$: << File.join(File.expand_path(File.dirname(__FILE__)), '../lib')
+require 'algorithms'
+include Algorithms
+
+require 'rubygems'
+require 'rbench'
+
+RBench.run(5) do
+  
+  sorts = %w(ruby comb_sort heapsort insertion_sort shell_sort quicksort mergesort)
+  sorts.each { |sort| self.send(:column, sort.intern) }
+  
+  n = 1000
+  
+  proc = lambda { |scope, ary|
+    scope.ruby { ary.dup.sort }
+    scope.comb_sort { Sort.comb_sort(ary.dup) }
+    scope.heapsort { Sort.heapsort(ary.dup) }
+    scope.insertion_sort { Sort.insertion_sort(ary.dup) }
+    scope.shell_sort { Sort.shell_sort(ary.dup) }
+    scope.quicksort { Sort.quicksort(ary.dup) }
+    scope.mergesort { Sort.mergesort(ary.dup) }
+  }
+
+  report "Already sorted" do
+    sorted_array = Array.new(n) { rand(n) }.sort
+    proc.call(self, sorted_array)
+  end
+  
+  report "Random" do
+    random_array = Array.new(n) { rand(n) }
+    proc.call(self, random_array)
+  end
+end

data/benchmarks/treemaps.rb

@@ -0,0 +1,51 @@
+$: << File.join(File.expand_path(File.dirname(__FILE__)), '../lib')
+require 'algorithms'
+include Containers
+
+require 'rubygems'
+require 'rbench'
+
+RBench.run(2) do
+  trees = %w(hash rbtree splaytree)
+  trees.each { |tree| self.send(:column, tree.intern) }
+  
+  rbtree = RBTreeMap.new
+  splaytree = SplayTreeMap.new
+  hash = Hash.new
+  
+  random_array = Array.new(300000) { |i| rand(i) }
+  
+  report "Insertion" do
+    rbtree { random_array.each_with_index  { |x,index| rbtree[index] = x } }
+    splaytree { random_array.each_with_index  { |x,index| splaytree[index] = x } }
+    hash { random_array.each_with_index  { |x,index| hash[index] = x } }
+  end
+  
+  report "has_key? (linear order)" do
+    rbtree { random_array.each { |n| rbtree.has_key?(n) } }
+    splaytree { random_array.each { |n| splaytree.has_key?(n) } }
+    hash { random_array.each { |n| hash.has_key?(n) } }
+  end
+  
+  report "Lookup in sorted order" do
+    rbtree { rbtree.each { |k, v| k } }
+    splaytree { splaytree.each { |k, v| k } }
+    hash { hash.sort.each { |k, v| k } }
+    
+    # a1, a2, a3 = [], [], []
+    # rbtree.each { |k, v| a1 << k }
+    # splaytree.each { |k, v| a2 << k }
+    # hash.sort.each { |k, v| a3 << k }
+    # 
+    # puts "Lookup correct" if a1 == a2 && a1 == a3
+  end
+  
+  report "Random lookups in a smaller subset" do
+    select_subset = random_array[0..random_array.size/20] # 5%
+    size = select_subset.size
+    rbtree { 10000.times { rbtree[ select_subset[rand(size)] ] } }
+    splaytree { 10000.times { splaytree[ select_subset[rand(size)] ] } }
+    hash { 10000.times { hash[ select_subset[rand(size)] ] } }
+  end
+  
+end