RubyDataStructures 0.0.1 → 0.0.2

data/RELEASE_NOTES

@@ -1,5 +1,31 @@
-= Announce: RubyDatStructures Release 0.0.1
+= Announce: Ruby DataStructures Release 0.0.2
+Date Mar 5, 2011
+Release 0.0.2 adds new features.
+
+New features:
+
+* SinglyLinkedList
+
+Deprecation Notices:
 
+* None
+
+Bugs Fixed:
+
+* None
+
+Other Changes Include:
+
+* None
+
+== Thanks
+
+-- Satyaram B V
+
+===========================================
+
+= Announce: RubyDatStructures Release 0.0.1
+Date: Mar 4, 2011
 Release 0.0.1 makes the project public.
 
  $ gem install RubyDataStructures

data/lib/RubyDataStructures/multi_dimensional_array.rb

@@ -21,9 +21,8 @@ class RubyDataStructures::MultiDimensionalArray
     offset = 0
 
     (0..(@dimensions.length - 1)).each do |i|
-      if indices[i] < 0 || indices[i] >= @dimensions[i]
-        raise IndexError
-      end
+      
+      raise IndexError if indices[i] < 0 || indices[i] >= @dimensions[i]
 
       offset += @factors[i]*indices[i]
     end

data/lib/RubyDataStructures/queue_as_array.rb

@@ -1,4 +1,4 @@
-class QueueAsArray
+class RubyDataStructures::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+
@@ -19,9 +19,7 @@ class QueueAsArray
 
   # The queue is enqueued with +element+
   def enqueue(element)
-    if self.full?
-      raise "Queue Overflow - The queue is full"
-    end
+    raise "Queue Overflow - The queue is full" if self.full?
 
     @array[@tail] = element
 
@@ -38,9 +36,7 @@ class QueueAsArray
 
   # The queue is dequeued
   def dequeue
-    if self.empty?
-      raise "Queue Underflow - The queue is empty"
-    end
+    raise "Queue Underflow - The queue is empty" if self.empty?
     
     x = @array[@head]
 

data/lib/RubyDataStructures/singly_linked_list/element.rb

@@ -0,0 +1,16 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+class RubyDataStructures::SinglyLinkedList::Element
+  attr_accessor :key
+  attr_accessor :next
+
+  # Initializes an Element of SinglyLinkedList
+  # Arguments:
+  # *list* => Instance of SinglyLinkedList to which the element belongs to
+  # *key*  => Value to be stored in the element.
+  def initialize(list, key)
+    @list = list
+    @key = key
+  end
+end

data/lib/RubyDataStructures/singly_linked_list.rb

@@ -0,0 +1,59 @@
+class RubyDataStructures::SinglyLinkedList  
+  # Initializes the SinglyLinkedList
+  def initialize
+    @sentinal = RubyDataStructures::SinglyLinkedList::Element.new(self, nil)
+    self.reset
+  end
+
+  def head
+    @sentinal.next
+  end
+
+  def empty?
+    self.head == @sentinal
+  end
+
+  def reset
+    @sentinal.next = @sentinal
+  end
+
+  # Splices an element onto the front of the linked list
+  # Arguments:
+  # *item* => Value to store in the element to be inserted
+  def insert(item)
+    element = RubyDataStructures::SinglyLinkedList::Element.new(self, item)
+    element.next = @sentinal.next
+    @sentinal.next = element
+  end
+
+  # Returns the first element with a given key
+  # Arguments:
+  # *key* => Key of the element to be searched for
+  def search(key)
+    element = self.head
+    while (element != @sentinal) && (element.key != key)
+      element = element.next
+    end
+
+    return element
+  end
+
+  # Removes the first element with a given key from the linked list
+  # Arguments:
+  # *key* => Key of the element to be removed
+  def delete(key)
+    element = self.head
+    prev_element = @sentinal
+    
+    while (element != @sentinal) && (element.key != key)
+      prev_element = element
+      element = element.next
+    end
+
+    if element == @sentinal
+      raise "Argument Error - No element with the key found"
+    else
+      prev_element.next = element.next
+    end
+  end
+end

data/lib/RubyDataStructures/stack_as_array.rb

@@ -1,4 +1,4 @@
-class StackAsArray
+class RubyDataStructures::StackAsArray
   # Initializes a stack of size +size+
   # The value of +top+ for an empty stack is +nil+
   def initialize(size = 1)
@@ -22,9 +22,8 @@ class StackAsArray
 
   # Pushes an element +element+ into the stack
   def push(element)
-    if self.full?
-      raise "Stack Overflow - The stack is full"
-    end
+    
+    raise "Stack Overflow - The stack is full" if self.full?
 
     if self.empty?
       @top = 0
@@ -37,9 +36,7 @@ class StackAsArray
 
   # Pops the stack
   def pop
-    if self.empty?
-      raise "Stack Underflow - The stack is empty"
-    end
+    raise "Stack Underflow - The stack is empty" if self.empty?
 
     x = @array[@top]
     if self.singleton?

data/lib/RubyDataStructures/version.rb

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

data/lib/RubyDataStructures.rb

@@ -4,4 +4,6 @@ require 'RubyDataStructures/ruby_data_structures'
 # All RubyDataStructures
 require 'RubyDataStructures/multi_dimensional_array'
 require 'RubyDataStructures/stack_as_array'
-require 'RubyDataStructures/queue_as_array'
+require 'RubyDataStructures/queue_as_array'
+require 'RubyDataStructures/singly_linked_list'
+require 'RubyDataStructures/singly_linked_list/element'

data/test/RubyDataStructureTest.rb

@@ -6,4 +6,6 @@ require 'ruby-debug'
 
 require 'test/multi_dimensional_array_test'
 require 'test/stack_as_array_test'
-require 'test/queue_as_array_test'
+require 'test/queue_as_array_test'
+require 'test/singly_linked_list_test'
+require 'test/singly_linked_list_element_test'

data/test/singly_linked_list_element_test.rb

@@ -0,0 +1,42 @@
+# 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 SinglyLinkedListElementTest < Test::Unit::TestCase
+  def setup
+    @list = RubyDataStructures::SinglyLinkedList.new
+    @element = RubyDataStructures::SinglyLinkedList::Element.new(@list, 9)
+  end
+
+  def test_initialize
+    assert_equal 9, @element.key
+    assert_nil @element.next
+  end
+
+  def test_key
+    assert_equal 9, @element.key
+
+    @element.key = 3
+    assert_equal 3, @element.key
+  end
+
+  def test_next
+    e1 = @element
+    e2 = RubyDataStructures::SinglyLinkedList::Element.new(@list, 9)
+    assert_nil e1.next
+    assert_nil e2.next
+
+    e1.next = e2
+    assert_equal e2, e1.next
+    assert_nil e2.next
+
+    e2.next = e1
+    assert_equal e2, e1.next
+    assert_equal e1, e2.next
+
+  end
+end

data/test/singly_linked_list_test.rb

@@ -0,0 +1,67 @@
+# 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 SinglyLinkedListTest < Test::Unit::TestCase
+  def setup
+    @list = RubyDataStructures::SinglyLinkedList.new
+  end
+  
+  def test_initialize
+    assert_nil @list.head.key
+    assert @list.empty?
+  end
+
+  def test_insert
+    assert_nil @list.head.key
+
+    @list.insert(7)
+    assert_equal 7, @list.head.key
+
+    @list.insert(9)
+    assert_equal 9, @list.head.key
+  end
+
+  def test_singly_linked_list
+    assert @list.empty?
+    assert_nil @list.head.key
+    assert_nil @list.search(7).key
+    assert_nil @list.search(9).key
+
+    @list.insert(7)
+    assert !@list.empty?
+    assert_equal 7, @list.head.key
+    assert_equal 7, @list.search(7).key
+    assert_nil @list.search(9).key
+
+    @list.insert(9)
+    assert !@list.empty?
+    assert_equal 9, @list.head.key
+    assert_equal 7, @list.search(7).key
+    assert_equal 9, @list.search(9).key
+
+    @list.delete(7)
+    assert !@list.empty?
+    assert_equal 9, @list.head.key
+    assert_nil @list.search(7).key
+    assert_equal 9, @list.search(9).key
+
+    assert_raise RuntimeError, "Argument Error - No element with the key found" do
+      @list.delete(7)
+    end
+    assert !@list.empty?
+    assert_equal 9, @list.head.key
+    assert_nil @list.search(7).key
+    assert_equal 9, @list.search(9).key
+
+    @list.reset
+    assert @list.empty?
+    assert_nil @list.head.key
+    assert_nil @list.search(7).key
+    assert_nil @list.search(9).key
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: RubyDataStructures
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Satyaram B V
@@ -40,11 +40,15 @@ files:
 - lib/RubyDataStructures/multi_dimensional_array.rb
 - lib/RubyDataStructures/queue_as_array.rb
 - lib/RubyDataStructures/ruby_data_structures.rb
+- lib/RubyDataStructures/singly_linked_list.rb
+- lib/RubyDataStructures/singly_linked_list/element.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/singly_linked_list_element_test.rb
+- test/singly_linked_list_test.rb
 - test/stack_as_array_test.rb
 has_rdoc: true
 homepage: http://bvsatyaram.com