stakach-algorithms 1.0.0

data/README.markdown

@@ -0,0 +1,97 @@
+# 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              Algorithms::Containers::Heap, Containers::MaxHeap, Containers::MinHeap
+		* Priority Queue     Algorithms::Containers::PriorityQueue
+		* Deque              Algorithms::Containers::Deque, Containers::CDeque (C extension), Containers::RubyDeque
+		* Stack              Algorithms::Containers::Stack (uses Deque)
+		* Queue              Algorithms::Containers::Queue (uses Deque)
+		* Red-Black Trees    Algorithms::Containers::RBTreeMap, Containers::CRBTreeMap (C extension), Containers::RubyRBTreeMap
+		* Splay Trees        Algorithms::Containers::SplayTreeMap, Containers::CSplayTreeMap (C extension), Containers::RubySplayTreeMap
+		* Tries              Algorithms::Containers::Trie
+		* Suffix Array       Algorithms::Containers::SuffixArray
+		* kd Tree            Algorithms::Containers::KDTree
+
+		* Search algorithms
+		  - Binary Search            Algorithms::Algorithms::Search.binary_search
+		  - Knuth-Morris-Pratt       Algorithms::Algorithms::Search.kmp_search
+		* Sort algorithms           
+		  - Bubble sort              Algorithms::Algorithms::Sort.bubble_sort
+		  - Comb sort                Algorithms::Algorithms::Sort.comb_sort
+		  - Selection sort           Algorithms::Algorithms::Sort.selection_sort
+		  - Heapsort                 Algorithms::Algorithms::Sort.heapsort
+		  - Insertion sort           Algorithms::Algorithms::Sort.insertion_sort
+		  - Shell sort               Algorithms::Algorithms::Sort.shell_sort
+		  - Quicksort                Algorithms::Algorithms::Sort.quicksort
+		  - Mergesort                Algorithms::Algorithms::Sort.mergesort
+
+## SYNOPSIS:
+
+		require 'rubygems'
+		require 'algorithms'
+		max_heap = Algorithms::Containers::MaxHeap.new
+		
+		# To not have to type "Algorithms::" before each class, use:
+		include 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,27 @@
+require 'echoe'
+require "rake/clean"
+OBJ = FileList['**/*.rbc']
+CLEAN.include(OBJ)
+ 
+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 :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/ext/containers/deque/deque.c

@@ -0,0 +1,249 @@
+#include "ruby.h"
+
+#define FALSE 0
+#define TRUE 1
+
+typedef struct struct_deque_node {
+	VALUE obj;
+	struct struct_deque_node *left;
+	struct struct_deque_node *right;
+} deque_node;
+
+typedef struct {
+	unsigned int size;
+	deque_node *front;
+	deque_node *back;
+} deque;
+
+void free_nodes(deque_node *node) {
+	deque_node *next;
+	while(node) {
+		next = node->right;
+		free(node);
+		node = next;
+	}
+	return;
+}
+
+void clear_deque(deque *a_deque) {
+	if(a_deque->front)
+		free_nodes(a_deque->front);
+	a_deque->size = 0;
+	a_deque->front = NULL;
+	a_deque->back = NULL;
+	return;
+}
+
+static deque* get_deque_from_self(VALUE self) {
+	deque *a_deque;
+	Data_Get_Struct(self, deque, a_deque);
+	return a_deque;
+}
+
+static deque* create_deque() {
+	deque *a_deque = ALLOC(deque);
+	a_deque->size = 0;
+	a_deque->front = NULL;
+	a_deque->back = NULL;
+	return a_deque;
+}
+
+static deque_node* create_node(VALUE obj) {
+	deque_node *node = ALLOC(deque_node);
+	node->obj = obj;
+	node->left = NULL;
+	node->right = NULL;
+	return node;
+}
+
+static void deque_mark(void *ptr) {
+  if (ptr) {
+		deque *deque = ptr;
+		deque_node *node = deque->front;
+		while(node) {
+			rb_gc_mark(node->obj);
+			node = node->right;
+		}
+	}
+}
+
+static void deque_free(void *ptr) {
+	if (ptr) {
+		deque *deque = ptr;
+		free_nodes(deque->front);
+		free(deque);
+	}
+}
+
+static VALUE deque_alloc(VALUE klass) {
+	deque *deque = create_deque();
+	return Data_Wrap_Struct(klass, deque_mark, deque_free, deque);
+}
+
+static VALUE deque_push_front(VALUE self, VALUE obj) {
+	deque *deque = get_deque_from_self(self);
+	deque_node *node = create_node(obj);
+	if(deque->front) {
+		node->right = deque->front;
+		deque->front->left = node;
+		deque->front = node; 
+	}
+	else {
+		deque->front = node;
+		deque->back = node;
+	}
+	deque->size++;
+	return obj;
+}
+
+static VALUE deque_push_back(VALUE self, VALUE obj) {
+	deque *deque = get_deque_from_self(self);
+	deque_node *node = create_node(obj);
+	if(deque->back) {
+		node->left = deque->back;
+		deque->back->right = node;
+		deque->back = node; 
+	}
+	else {
+		deque->front = node;
+		deque->back = node;
+	}
+	deque->size++;
+	return obj;
+}
+
+static VALUE deque_pop_front(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	VALUE obj;
+	if(!deque->front)
+		return Qnil;
+	deque_node *node = deque->front;
+	obj = node->obj;
+	if(deque->size == 1) {
+		clear_deque(deque);
+		return obj;
+	}
+	deque->front->right->left = NULL;
+	deque->front = deque->front->right;
+	deque->size--;
+	return obj;
+}
+
+static VALUE deque_front(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	if(deque->front)
+		return deque->front->obj;
+	
+	return Qnil;
+}
+
+static VALUE deque_back(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	if(deque->back)
+		return deque->back->obj;
+	
+	return Qnil;
+}
+
+static VALUE deque_pop_back(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	VALUE obj;
+	if(!deque->back)
+		return Qnil;
+	deque_node *node = deque->back;
+	obj = node->obj;
+	if(deque->size == 1) {
+		clear_deque(deque);
+		return obj;
+	}
+	deque->back->left->right = NULL;
+	deque->back = deque->back->left;
+	deque->size--;
+	return obj;
+}
+
+static VALUE deque_clear(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	clear_deque(deque);
+	return Qnil;
+}
+
+static VALUE deque_size(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	return INT2NUM(deque->size);
+}
+
+static VALUE deque_is_empty(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	return (deque->size == 0) ? Qtrue : Qfalse;
+}
+
+static VALUE deque_each_forward(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	deque_node *node = deque->front;
+	while(node) {
+		rb_yield(node->obj);
+		node = node->right;
+	}
+	return self;
+}
+
+static VALUE deque_each_backward(VALUE self) {
+	deque *deque = get_deque_from_self(self);
+	deque_node *node = deque->back;
+	while(node) {
+		rb_yield(node->obj);
+		node = node->left;
+	}
+	return self;
+}
+
+static VALUE deque_init(int argc, VALUE *argv, VALUE self)
+{
+	int len, i;
+	VALUE ary;
+	
+	if(argc == 0) {
+		return self;
+	}
+	else if(argc > 1) {
+		rb_raise(rb_eArgError, "wrong number of arguments");
+	}
+	else {
+		ary = rb_check_array_type(argv[0]);
+		if(!NIL_P(ary)) {
+			len = RARRAY_LEN(ary);
+			for (i = 0; i < len; i++) {
+				deque_push_back(self, RARRAY_PTR(ary)[i]);
+			}
+		}
+	}
+	return self;
+}
+
+static VALUE cDeque;
+static VALUE mContainers;
+static VALUE namespace;
+
+void Init_CDeque() {
+	namespace = rb_define_module("Algorithms");
+	mContainers = rb_define_module_under(namespace,"Containers");
+	cDeque = rb_define_class_under(mContainers, "CDeque", rb_cObject);
+	rb_define_alloc_func(cDeque, deque_alloc);
+	rb_define_method(cDeque, "initialize", deque_init, -1);
+	rb_define_method(cDeque, "push_front", deque_push_front, 1);
+	rb_define_method(cDeque, "push_back", deque_push_back, 1);
+	rb_define_method(cDeque, "clear", deque_clear, 0);
+	rb_define_method(cDeque, "front", deque_front, 0);
+	rb_define_method(cDeque, "back", deque_back, 0);
+	rb_define_method(cDeque, "pop_front", deque_pop_front, 0);
+	rb_define_method(cDeque, "pop_back", deque_pop_back, 0);
+	rb_define_method(cDeque, "size", deque_size, 0);
+	rb_define_alias(cDeque, "length", "size");
+	rb_define_method(cDeque, "empty?", deque_is_empty, 0);
+	rb_define_method(cDeque, "each_forward", deque_each_forward, 0);
+	rb_define_method(cDeque, "each_backward", deque_each_backward, 0);
+	rb_define_alias(cDeque, "each", "each_forward");
+	rb_define_alias(cDeque, "reverse_each", "each_backward");
+	rb_include_module(cDeque, rb_eval_string("Enumerable"));
+}

data/ext/containers/deque/extconf.rb

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

data/ext/containers/rbtree_map/extconf.rb

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