RubyDataStructures 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+nbproject
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in RubyDataStructures.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,3 @@
+== RubyDataStructures
+
+Put appropriate LICENSE for your project here.

data/README

@@ -0,0 +1,3 @@
+== RubyDataStructures
+
+Implementation of standard data structures in Ruby.

data/RELEASE_NOTES

@@ -0,0 +1,27 @@
+= Announce: RubyDatStructures Release 0.0.1
+
+Release 0.0.1 makes the project public.
+
+ $ gem install RubyDataStructures
+
+New features:
+
+* MultiDimensionalArray
+* StackAsArray
+* QueueAsArray
+
+Deprecation Notices:
+
+* None
+
+Bugs Fixed:
+
+* None
+
+Other Changes Include:
+
+* None
+
+== Thanks
+
+-- Satyaram B V

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/RubyDataStructures.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "RubyDataStructures/version"
+
+Gem::Specification.new do |s|
+  s.name        = "RubyDataStructures"
+  s.version     = Rubydatastructures::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Satyaram B V"]
+  s.email       = ["bvsatyaramATgmailDOTcom"]
+  s.homepage    = "http://bvsatyaram.com"
+  s.summary     = %q{Implementation of standard data structures in Ruby}
+  s.description = %q{Implementation of standard data structures in Ruby}
+
+  s.rubyforge_project = "RubyDataStructures"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/RubyDataStructures/multi_dimensional_array.rb

@@ -0,0 +1,42 @@
+class RubyDataStructures::MultiDimensionalArray
+  def initialize(*dimensions)
+    @dimensions = Array.new(dimensions.length)
+    @factors = Array.new(dimensions.length)
+    product = 1
+    i = dimensions.length - 1
+
+    while i >= 0
+      @dimensions[i] = dimensions[i]
+      @factors[i] = product
+      product *= dimensions[i]
+      i -= 1
+    end
+
+    @data = Array.new(product)
+  end
+
+  def get_offset(indices)
+    raise IndexError if indices.length != @dimensions.length
+
+    offset = 0
+
+    (0..(@dimensions.length - 1)).each do |i|
+      if indices[i] < 0 || indices[i] >= @dimensions[i]
+        raise IndexError
+      end
+
+      offset += @factors[i]*indices[i]
+    end
+
+    return offset
+  end
+
+  def [](*indices)
+    @data[self.get_offset(indices)]
+  end
+
+  def []=(*indices_and_value)
+    value = indices_and_value.pop
+    @data[self.get_offset(indices_and_value)] = value
+  end
+end

data/lib/RubyDataStructures/queue_as_array.rb

@@ -0,0 +1,66 @@
+class QueueAsArray
+  # Initializes a stack of size +size+
+  # The value of +head+ for a new stack is +nil+
+  # The value of +tail+ for a new stack is +0+
+  def initialize(size = 1)
+    @length = size
+    self.reset
+  end
+
+  # Returns +true+ if the queue is empty
+  def empty?
+    @head.nil?
+  end
+
+  # Returns +true+ if the queue is full
+  def full?
+    @head == @tail
+  end
+
+  # The queue is enqueued with +element+
+  def enqueue(element)
+    if self.full?
+      raise "Queue Overflow - The queue is full"
+    end
+
+    @array[@tail] = element
+
+    if @head.nil?
+      @head = 0
+    end
+
+    if @tail == @length - 1
+      @tail = 0
+    else
+      @tail = @tail + 1
+    end
+  end
+
+  # The queue is dequeued
+  def dequeue
+    if self.empty?
+      raise "Queue Underflow - The queue is empty"
+    end
+    
+    x = @array[@head]
+
+    if @head == @length - 1
+      @head = 0
+    else
+      @head = @head + 1
+    end
+
+    if @head == @tail
+      self.reset
+    end
+
+    return x
+  end
+
+  # Resets the queue
+  def reset
+    @array = Array.new(@length)
+    @head = nil
+    @tail = 0
+  end
+end

data/lib/RubyDataStructures/ruby_data_structures.rb

@@ -0,0 +1,3 @@
+class RubyDataStructures
+
+end

data/lib/RubyDataStructures/stack_as_array.rb

@@ -0,0 +1,61 @@
+class StackAsArray
+  # Initializes a stack of size +size+
+  # The value of +top+ for an empty stack is +nil+
+  def initialize(size = 1)
+    @length = size
+    self.reset
+  end
+
+  # Returns +true+ if the stack is empty
+  def empty?
+    @top.nil?
+  end
+
+  # Returns +true+ if the stack is full
+  def full?
+    @top == @length - 1
+  end
+
+  def singleton?
+    @top == 0
+  end
+
+  # Pushes an element +element+ into the stack
+  def push(element)
+    if self.full?
+      raise "Stack Overflow - The stack is full"
+    end
+
+    if self.empty?
+      @top = 0
+    else
+      @top = @top + 1
+    end
+
+    @array[@top] = element
+  end
+
+  # Pops the stack
+  def pop
+    if self.empty?
+      raise "Stack Underflow - The stack is empty"
+    end
+
+    x = @array[@top]
+    if self.singleton?
+      @top = nil
+    else
+      @top = @top - 1
+    end
+
+    return x
+  end
+
+  # Resets the stack
+  def reset
+    @array = Array.new(@length)
+    @top = nil
+  end
+
+  #TODO: Implement *each* method
+end

data/lib/RubyDataStructures/version.rb

@@ -0,0 +1,3 @@
+module Rubydatastructures
+  VERSION = "0.0.1"
+end

data/lib/RubyDataStructures.rb

@@ -0,0 +1,7 @@
+# Abstract RubyDataStructure
+require 'RubyDataStructures/ruby_data_structures'
+
+# All RubyDataStructures
+require 'RubyDataStructures/multi_dimensional_array'
+require 'RubyDataStructures/stack_as_array'
+require 'RubyDataStructures/queue_as_array'

data/test/RubyDataStructureTest.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'rubygems'
+require 'ruby-debug'
+
+# Individual Test Cases
+
+require 'test/multi_dimensional_array_test'
+require 'test/stack_as_array_test'
+require 'test/queue_as_array_test'

data/test/multi_dimensional_array_test.rb

@@ -0,0 +1,20 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class MultiDimensionalArrayTest < Test::Unit::TestCase
+  def setup
+    @mda = RubyDataStructures::MultiDimensionalArray.new(2,3,4)
+  end
+
+  def test_multi_dimensional_array
+    assert_equal nil, @mda[1,2,3]
+
+    @mda[1,2,3] = 5
+    assert_equal 5, @mda[1,2,3]
+  end
+end

data/test/queue_as_array_test.rb

@@ -0,0 +1,86 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class QueueAsArrayTest < Test::Unit::TestCase
+  def test_queue_as_array
+    queue = RubyDataStructures::QueueAsArray.new(3)
+
+    assert queue.empty?
+    assert !queue.full?
+
+    assert_raise RuntimeError, "Queue Underflow - The queue is empty" do
+      queue.dequeue
+    end
+
+    queue.enqueue(1)
+    assert !queue.empty?
+    assert !queue.full?
+
+    assert_equal 1, queue.dequeue
+    assert queue.empty?
+    assert !queue.full?
+
+    queue.enqueue(1)
+    assert !queue.empty?
+    assert !queue.full?
+
+    queue.enqueue(2)
+    assert !queue.empty?
+    assert !queue.full?
+
+    queue.enqueue(3)
+    assert !queue.empty?
+    assert queue.full?
+
+    assert_raise RuntimeError, "Queue Overflow - The queue is full" do
+      queue.enqueue(4)
+    end
+
+    assert_equal 1, queue.dequeue
+    assert !queue.empty?
+    assert !queue.full?
+
+    assert_equal 2, queue.dequeue
+    assert !queue.empty?
+    assert !queue.full?
+
+    queue.enqueue(7)
+    assert !queue.empty?
+    assert !queue.full?
+
+    assert_equal 3, queue.dequeue
+    assert !queue.empty?
+    assert !queue.full?
+
+    assert_equal 7, queue.dequeue
+    assert queue.empty?
+    assert !queue.full?
+
+    assert_raise RuntimeError, "Queue Underflow - The queue is empty" do
+      queue.dequeue
+    end
+  end
+
+  def test_queue_as_array_reset
+    queue = RubyDataStructures::QueueAsArray.new(3)
+
+    assert queue.empty?
+    assert !queue.full?
+
+    queue.enqueue(1)
+    queue.enqueue(2)
+
+    assert !queue.empty?
+    assert !queue.full?
+
+    queue.reset
+
+    assert queue.empty?
+    assert !queue.full?
+  end
+end

data/test/stack_as_array_test.rb

@@ -0,0 +1,88 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class StackAsArrayTest < Test::Unit::TestCase
+  def test_stack_as_array
+    stack = RubyDataStructures::StackAsArray.new(3)
+
+    assert stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    assert_raise RuntimeError, "Stack Underflow - The stack is empty" do
+      stack.pop
+    end
+
+    stack.push(1)
+    assert !stack.empty?
+    assert stack.singleton?
+    assert !stack.full?
+
+    stack.push(2)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    stack.push(3)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert stack.full?
+
+    assert_raise RuntimeError, "Stack Overflow - The stack is full" do
+      stack.push(4)
+    end
+
+    assert_equal 3, stack.pop
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    assert_equal 2, stack.pop
+    assert !stack.empty?
+    assert stack.singleton?
+    assert !stack.full?
+
+    stack.push(7)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    assert_equal 7, stack.pop
+    assert !stack.empty?
+    assert stack.singleton?
+    assert !stack.full?
+
+    assert_equal 1, stack.pop
+    assert stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    assert_raise RuntimeError, "Stack Underflow - The stack is empty" do
+      stack.pop
+    end
+  end
+
+  def test_stack_as_array_reset
+    stack = RubyDataStructures::StackAsArray.new(3)
+
+    assert stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+
+    stack.push(1)
+    stack.push(2)
+
+    assert !stack.empty?
+    assert !stack.full?
+
+    stack.reset
+
+    assert stack.empty?
+    assert !stack.full?
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: RubyDataStructures
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Satyaram B V
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-05 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Implementation of standard data structures in Ruby
+email: 
+- bvsatyaramATgmailDOTcom
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README
+- RELEASE_NOTES
+- Rakefile
+- RubyDataStructures.gemspec
+- lib/RubyDataStructures.rb
+- lib/RubyDataStructures/multi_dimensional_array.rb
+- lib/RubyDataStructures/queue_as_array.rb
+- lib/RubyDataStructures/ruby_data_structures.rb
+- lib/RubyDataStructures/stack_as_array.rb
+- lib/RubyDataStructures/version.rb
+- test/RubyDataStructureTest.rb
+- test/multi_dimensional_array_test.rb
+- test/queue_as_array_test.rb
+- test/stack_as_array_test.rb
+has_rdoc: true
+homepage: http://bvsatyaram.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: RubyDataStructures
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Implementation of standard data structures in Ruby
+test_files: []
+