algorithms 0.5.0 → 0.6.1

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+=== January 22, 2013
+    
+    * JRuby support
+
 === April 15, 2012
 
     * Use long instead of int for string methods

data/Gemfile

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

data/README.markdown

@@ -1,7 +1,4 @@
-# algorithms
-
-* Official homes are here on github, and at [rubyforge](http://rubyforge.org/projects/algorithms/)
-* Documentation: [http://algorithms.rubyforge.org/](http://algorithms.rubyforge.org/)
+# algorithms [![Build Status](https://travis-ci.org/kanwei/algorithms.png)](https://travis-ci.org/kanwei/algorithms)
 
 ## DESCRIPTION:
 
@@ -9,7 +6,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,60 +17,52 @@ 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
+## 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
 
 ## 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'
 
+    max_heap = Containers::MaxHeap.new
 
-## REQUIREMENTS:
+    # To not have to type "Containers::" before each class, use:
+    include Containers
+    max_heap = 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)
-
-## 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
+Ruby 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

data/Rakefile

@@ -1,13 +1,18 @@
 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 data structures (containers).'
-  p.url                  = 'https://rubygems.org/gems/algorithms'
-  p.version              = "0.5.0"
-  p.retain_gemspec       = true
-  p.runtime_dependencies = []
-  p.development_dependencies = ["rspec", "echoe"]
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+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" }
+
+RSpec::Core::RakeTask.new
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  task :default => [:spec]
+else
+  task :default => [:compile, :spec]
 end

data/algorithms.gemspec

@@ -2,35 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = "algorithms"
-  s.version = "0.5.0"
+  s.version = "0.6.1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kanwei Li"]
-  s.date = "2012-04-25"
-  s.description = "A library of algorithms and data structures (containers)."
   s.email = "kanwei@gmail.com"
-  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"]
-  s.extra_rdoc_files = ["CHANGELOG.markdown", "README.markdown", "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"]
-  s.files = ["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://rubygems.org/gems/algorithms"
+  s.license = 'MIT'
+  s.date = "2013-01-22"
+  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"]
   s.rubyforge_project = "algorithms"
-  s.rubygems_version = "1.8.15"
-  s.summary = "A library of algorithms and data structures (containers)."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<echoe>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-  end
 end

data/lib/algorithms/string.rb

@@ -5,4 +5,5 @@
 
 begin
   require 'CString'
+rescue LoadError
 end

data/lib/containers/trie.rb

@@ -13,7 +13,7 @@ class Containers::Trie
   #
   #   t = Containers::Trie.new
   #   t["hello"] = "world"
-  #   t["hello] #=> "world"
+  #   t["hello"] #=> "world"
   def initialize
     @root = nil
   end

data/spec/map_gc_mark_spec.rb

@@ -1,27 +1,29 @@
 $: << File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
 require 'algorithms'
 
-describe "map gc mark test" 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
+if !(defined? RUBY_ENGINE && RUBY_ENGINE == 'jruby')
+  describe "map gc mark test" 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
+      @rbtree = Containers::RBTreeMap.new
+      @splaytree = Containers::SplayTreeMap.new
+      100.times { |x| 
+        @rbtree[anon_key_class.new(x)] = anon_val_class.new
+        @splaytree[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(200)
+      ObjectSpace.each_object(anon_val_class) { |x| count += 1 }
+      count.should eql(400)
     end
-    anon_val_class = Class.new
-    @rbtree = Containers::CRBTreeMap.new
-    @splaytree = Containers::CSplayTreeMap.new
-    100.times { |x| 
-      @rbtree[anon_key_class.new(x)] = anon_val_class.new
-      @splaytree[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(200)
-    ObjectSpace.each_object(anon_val_class) { |x| count += 1 }
-    count.should eql(400)
   end
 end

data/spec/string_spec.rb

@@ -1,13 +1,15 @@
 $: << File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
 require 'algorithms'
 
-describe "string algorithms" do
-  it "should do levenshtein distance" do    
-    Algorithms::String.levenshtein_dist("Hello", "Hel").should eql(2)
-    Algorithms::String.levenshtein_dist("Hello", "").should eql(5)
-    Algorithms::String.levenshtein_dist("", "Hello").should eql(5)
-    Algorithms::String.levenshtein_dist("Hello", "Hello").should eql(0)
-    Algorithms::String.levenshtein_dist("Hello", "ello").should eql(1)
-    Algorithms::String.levenshtein_dist("Hello", "Mello").should eql(1)
+if defined? Algorithms::String
+  describe "string algorithms" do
+    it "should do levenshtein distance" do    
+      Algorithms::String.levenshtein_dist("Hello", "Hel").should eql(2)
+      Algorithms::String.levenshtein_dist("Hello", "").should eql(5)
+      Algorithms::String.levenshtein_dist("", "Hello").should eql(5)
+      Algorithms::String.levenshtein_dist("Hello", "Hello").should eql(0)
+      Algorithms::String.levenshtein_dist("Hello", "ello").should eql(1)
+      Algorithms::String.levenshtein_dist("Hello", "Mello").should eql(1)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algorithms
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,31 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70163289605640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70163289605640
-- !ruby/object:Gem::Dependency
-  name: echoe
-  requirement: &70163289605060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70163289605060
-description: A library of algorithms and data structures (containers).
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies: []
+description: Heap, Priority Queue, Deque, Stack, Queue, Red-Black Trees, Splay Trees,
+  sorting algorithms, and more
 email: kanwei@gmail.com
 executables: []
 extensions:
@@ -42,34 +21,9 @@ extensions:
 - ext/containers/deque/extconf.rb
 - ext/containers/rbtree_map/extconf.rb
 - ext/containers/splaytree_map/extconf.rb
-extra_rdoc_files:
-- CHANGELOG.markdown
-- README.markdown
-- 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
+extra_rdoc_files: []
 files:
+- Gemfile
 - CHANGELOG.markdown
 - Manifest
 - README.markdown
@@ -121,8 +75,9 @@ files:
 - spec/string_spec.rb
 - spec/suffix_array_spec.rb
 - spec/trie_spec.rb
-homepage: https://rubygems.org/gems/algorithms
-licenses: []
+homepage: https://github.com/kanwei/algorithms
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --line-numbers
@@ -145,11 +100,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '1.2'
+      version: '0'
 requirements: []
 rubyforge_project: algorithms
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A library of algorithms and data structures (containers).
+summary: Useful algorithms and data structures for Ruby. Optional C extensions.
 test_files: []