algorithms 0.2.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cee1c06e078dc124212a3462d765d26ce5fbe16dd6b31ca6392388d8f51644c
+  data.tar.gz: 491e3540ee5567752d208bb7b8502d1ee998b55e9664c66b5cf5fc17394e10e7
+SHA512:
+  metadata.gz: a4a533a2053ae799f87df22b51ff93744e8128e0982239f3d6717bfb6f8ee8817d9c6ebffd6b4a2b478694a3f2f742fc4465eba242e5d2d0d23bfc0c881c1daa
+  data.tar.gz: 4ffaed30fc92fca18dd258102a702f8fceb1a77594ac6b086c627e1a3ab8ae1ad6650295acd0fb423a6ce441b6b7ab686bb56ae9ff937448d031f319d937a427

data/{History.txt → CHANGELOG.markdown}

@@ -1,3 +1,28 @@
+=== January 22, 2013
+    
+    * JRuby support
+
+=== April 15, 2012
+
+    * Use long instead of int for string methods
+    * Use VALUE instead of int for comparison vars
+    * Now compiles without warnings (OS X 10.7)
+
+=== April 19, 2012
+
+    * Pulled in fix for ruby 1.9 compilation error (sorry!!)
+    * Fix specs that broke with new rspec
+    * Migration to rubygems.org
+    * 0.4.0 release
+
+=== Jan 3, 2009
+
+    * Levenshtein distance in C
+
+=== April 3, 2009
+
+	* Finished C refactorization of SplayTree
+
 === March 28, 2009
 
 	* Implemented SplayTree in C

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+    gem "rspec"
+    gem "rake-compiler"
+end
+

data/Manifest

@@ -1,17 +1,25 @@
+CHANGELOG.markdown
+Manifest
+README.markdown
+Rakefile
 algorithms.gemspec
 benchmarks/deque.rb
 benchmarks/sorts.rb
 benchmarks/treemaps.rb
+ext/algorithms/string/extconf.rb
+ext/algorithms/string/string.c
+ext/containers/bst/bst.c
+ext/containers/bst/extconf.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
-History.txt
+lib/algorithms.rb
 lib/algorithms/search.rb
 lib/algorithms/sort.rb
-lib/algorithms.rb
+lib/algorithms/string.rb
 lib/containers/deque.rb
 lib/containers/heap.rb
 lib/containers/kd_tree.rb
@@ -22,20 +30,22 @@ lib/containers/splay_tree_map.rb
 lib/containers/stack.rb
 lib/containers/suffix_array.rb
 lib/containers/trie.rb
-Manifest
-Rakefile
-README.markdown
+spec/bst_gc_mark_spec.rb
+spec/bst_spec.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_gc_mark_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/string_spec.rb
 spec/suffix_array_spec.rb
 spec/trie_spec.rb

data/README.markdown

@@ -1,7 +1,6 @@
-# algorithms
+# algorithms [![Build Status](https://travis-ci.org/kanwei/algorithms.png)](https://travis-ci.org/kanwei/algorithms)
 
-* Official homes are here on github, and at [rubyforge](http://rubyforge.org/projects/algorithms/)
-* Documentation: [http://algorithms.rubyforge.org/](http://algorithms.rubyforge.org/)
+[API Documentation](http://kanwei.github.io/algorithms/)
 
 ## DESCRIPTION:
 
@@ -9,7 +8,9 @@ Started as a [Google Summer of Code 2008](http://code.google.com/soc/2008/ruby/a
 
 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
+### 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
@@ -18,75 +19,48 @@ 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
-
-		* 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
+## COMPLETED:
+
+    * Heaps              Containers::Heap, Containers::MaxHeap, Containers::MinHeap
+    * Priority Queue     Containers::PriorityQueue
+    * Deque              Containers::Deque, Containers::CDeque (C ext)
+    * Stack              Containers::Stack
+    * Queue              Containers::Queue
+    * Red-Black Trees    Containers::RBTreeMap, Containers::CRBTreeMap (C ext)
+    * Splay Trees        Containers::SplayTreeMap, Containers::CSplayTreeMap (C ext)
+    * Tries              Containers::Trie
+    * Suffix Array       Containers::SuffixArray
+
+    * Search algorithms
+      - Binary Search            Algorithms::Search.binary_search
+      - Knuth-Morris-Pratt       Algorithms::Search.kmp_search
+    * Sorting 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
+      - Dual-Pivot Quicksort     Algorithms::Sort.dualpivotquicksort
 
 ## 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
-
+    require 'rubygems'
+    require 'algorithms'
 
-## REQUIREMENTS:
+    max_heap = Containers::MaxHeap.new
 
-* Ruby 1.8 compatible Ruby, or Ruby 1.9
-* C compiler for C extensions (optional, but very much recommended for vast performance benefits)
+    # To not have to type "Containers::" before each class, use:
+    include Containers
+    max_heap = MaxHeap.new
 
-## INSTALL:
+## REQUIREMENTS:
 
-* sudo gem install algorithms
+* Ruby 1.8, Ruby 1.9, JRuby
+* C extensions (optional, but very much recommended for vast performance benefits)
 
 ## 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.
+See [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -1,31 +1,22 @@
 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.2.0"
-  p.runtime_dependencies = []
-end
-
-task :default => :spec
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
-task :spec do
-  sh "spec spec/*.rb --color"
-end
+Rake::ExtensionTask.new('algorithms/string')        { |ext| ext.name = "CString" }
+Rake::ExtensionTask.new('containers/deque')         { |ext| ext.name = "CDeque" }
+Rake::ExtensionTask.new('containers/bst')           { |ext| ext.name = "CBst" }
+Rake::ExtensionTask.new('containers/rbtree_map')    { |ext| ext.name = "CRBTreeMap" }
+Rake::ExtensionTask.new('containers/splaytree_map') { |ext| ext.name = "CSplayTreeMap" }
 
-task :push do
-  sh "git push"    # Rubyforge
-  sh "git push --tags"    # Rubyforge
-  sh "git push gh" # Github
-  sh "git push gh --tags" # Github
-end
+RSpec::Core::RakeTask.new
 
-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"
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  task :default => [:spec]
+else
+  task :default => [:compile, :spec]
 end
 
+task :rdoc do
+    `rdoc -f hanna --main algorithms.rb -t "Ruby Algorithms and Containers Documentation"`
+end

data/algorithms.gemspec

@@ -1,32 +1,22 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{algorithms}
-  s.version = "0.2.0"
+  s.name = "algorithms"
+  s.version = "1.0.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kanwei Li"]
-  s.date = %q{2009-03-29}
-  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 = ["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/search.rb", "lib/algorithms/sort.rb", "lib/algorithms.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", "README.markdown"]
-  s.files = ["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", "History.txt", "lib/algorithms/search.rb", "lib/algorithms/sort.rb", "lib/algorithms.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", "Manifest", "Rakefile", "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", "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
+  s.email = "kanwei@gmail.com"
+  s.license = 'MIT'
+  s.date = "2021-04-04"
+  s.summary = "Useful algorithms and data structures for Ruby. Optional C extensions."
+  s.description = "Heap, Priority Queue, Deque, Stack, Queue, Red-Black Trees, Splay Trees, sorting algorithms, and more"
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    s.platform = "java"
   else
+    s.extensions = ["ext/algorithms/string/extconf.rb", "ext/containers/bst/extconf.rb", "ext/containers/deque/extconf.rb", "ext/containers/rbtree_map/extconf.rb", "ext/containers/splaytree_map/extconf.rb"]
   end
+  s.files = ["Gemfile", "CHANGELOG.markdown", "Manifest", "README.markdown", "Rakefile", "algorithms.gemspec", "benchmarks/deque.rb", "benchmarks/sorts.rb", "benchmarks/treemaps.rb", "ext/algorithms/string/extconf.rb", "ext/algorithms/string/string.c", "ext/containers/bst/bst.c", "ext/containers/bst/extconf.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/algorithms/string.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/bst_gc_mark_spec.rb", "spec/bst_spec.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/string_spec.rb", "spec/suffix_array_spec.rb", "spec/trie_spec.rb"]
+  s.homepage = "https://github.com/kanwei/algorithms"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Algorithms", "--main", "README.markdown"]
+  s.require_paths = ["lib", "ext"]
 end

data/benchmarks/treemaps.rb

@@ -1,20 +1,19 @@
 $: << File.join(File.expand_path(File.dirname(__FILE__)), '../lib')
 require 'algorithms'
-include Algorithms
+include Containers
 
 require 'rubygems'
 require 'rbench'
 
-RBench.run(10) do
+RBench.run(2) do
   trees = %w(hash rbtree splaytree)
   trees.each { |tree| self.send(:column, tree.intern) }
   
-  rbtree = Containers::RBTreeMap.new
-  splaytree = Containers::SplayTreeMap.new
+  rbtree = RBTreeMap.new
+  splaytree = SplayTreeMap.new
   hash = Hash.new
   
-  random_array = Array.new(10000) { |i| rand(i) }
-  num = 1000
+  random_array = Array.new(300000) { |i| rand(i) }
   
   report "Insertion" do
     rbtree { random_array.each_with_index  { |x,index| rbtree[index] = x } }
@@ -22,15 +21,31 @@ RBench.run(10) do
     hash { random_array.each_with_index  { |x,index| hash[index] = x } }
   end
   
-  report "has_key?" do
-    rbtree { num.times { |n| rbtree.has_key?(n) } }
-    splaytree { num.times { |n| splaytree.has_key?(n) } }
-    hash { num.times { |n| hash.has_key?(n) } }
+  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

data/ext/algorithms/string/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+extension_name = "CString"
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/algorithms/string/string.c

@@ -0,0 +1,68 @@
+#include "ruby.h"
+
+long min_three(long a, long b, long c) {
+	long min = a;
+	if (b < min)
+		min = b;
+	if( c < min)
+		min = c;
+	return min;
+}
+
+long levenshtein_distance(VALUE str1, VALUE str2) {
+	long i, j, s1_len, s2_len, *d;
+	char * s = RSTRING_PTR(str1);
+	char * t = RSTRING_PTR(str2);
+	s1_len = RSTRING_LEN(str1);
+	s2_len = RSTRING_LEN(str2);
+	
+	if (s1_len == 0) {
+		return s2_len;
+	} else if (s2_len == 0) {
+		return s1_len;
+	}
+	
+	// We need one extra col and row for the matrix for starting values
+	s1_len++;
+	s2_len++;
+	
+	d = xmalloc(sizeof(typeof(d)) * s1_len * s2_len);
+	
+	for (i = 0; i < s1_len; i++) {
+		d[i] = i; // d[i, 0] = i
+	}
+	for (j = 0; j < s2_len; j++) {
+		d[j*s1_len] = j; // d[0, j] = j
+	}
+	
+	for (i = 1; i < s1_len; i++) {
+		for (j = 1; j < s2_len; j++) {
+			if (s[i-1] == t[j-1]) {
+				d[j * s1_len + i] = d[(j-1) * s1_len + (i-1)];
+			} else {
+				d[j * s1_len + i] = 1 + min_three(
+					d[j * s1_len + (i-1)],
+					d[(j-1) * s1_len + i],
+					d[(j-1) * s1_len + (i-1)]
+				);
+			}
+		}
+	}
+	i = d[s1_len * s2_len -1];
+	xfree(d);
+	return i;
+}
+
+static VALUE lev_dist(VALUE self, VALUE str1, VALUE str2) {
+	return LONG2FIX(levenshtein_distance( str1, str2 ));
+}
+
+static VALUE mAlgorithms;
+static VALUE mString;
+
+void Init_CString() {	
+	mAlgorithms = rb_define_module("Algorithms");
+	mString = rb_define_module_under(mAlgorithms, "String");
+	rb_define_singleton_method(mString, "levenshtein_dist", lev_dist, 2);
+}
+