RubyDataStructures 0.0.2 → 0.0.3

data/RELEASE_NOTES

@@ -1,3 +1,28 @@
+= Announce: Ruby DataStructures Release 0.0.3
+Date Mar 5, 2011
+Release 0.0.3 adds new features.
+
+New features:
+
+* DoublyLinkedList
+
+Deprecation Notices:
+
+* None
+
+Bugs Fixed:
+
+* None
+
+Other Changes Include:
+
+* Fixed typo: sentinal => sentinel
+
+== Thanks
+
+-- Satyaram B V
+
+===========================================
 = Announce: Ruby DataStructures Release 0.0.2
 Date Mar 5, 2011
 Release 0.0.2 adds new features.

data/lib/RubyDataStructures/doubly_linked_list/element.rb

@@ -0,0 +1,3 @@
+class RubyDataStructures::DoublyLinkedList::Element < RubyDataStructures::SinglyLinkedList::Element
+  attr_accessor :previous
+end

data/lib/RubyDataStructures/doubly_linked_list.rb

@@ -0,0 +1,44 @@
+class RubyDataStructures::DoublyLinkedList < RubyDataStructures::SinglyLinkedList
+
+  # Overrides the +initialize+ method in SinglyLinkedList
+  # Initializes the DoublyLinkedList
+  def initialize
+    @sentinel = RubyDataStructures::DoublyLinkedList::Element.new(self, nil)
+    self.reset
+  end
+
+  # Extends the +reset+ method in SinglyLinkedList to also set +previous+
+  # attribute to the sentinel
+  def reset
+    super
+    @sentinel.previous = @sentinel
+  end
+
+  # Returns the last element of the linked list
+  def tail
+    @sentinel.previous
+  end
+
+  # Overrides the +insert+ method in SinglyLinkedList to also set/update
+  #  +previous+ attributes to the elements
+  def insert(item)
+    element = RubyDataStructures::DoublyLinkedList::Element.new(self, item)
+    element.next = @sentinel.next
+    @sentinel.next = element
+    element.next.previous = element
+    element.previous = @sentinel
+  end
+
+  # Overrides the +delete+ method in SinglyLinkedList to optimize the 
+  # implementation.
+  def delete(key)
+    element = search(key)
+    
+    if element == @sentinel
+      raise "Argument Error - No element with the key found"
+    else
+      element.previous.next = element.next
+      element.next.previous = element.previous
+    end
+  end
+end

data/lib/RubyDataStructures/singly_linked_list/element.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 class RubyDataStructures::SinglyLinkedList::Element
   attr_accessor :key
   attr_accessor :next

data/lib/RubyDataStructures/singly_linked_list.rb

@@ -1,20 +1,20 @@
-class RubyDataStructures::SinglyLinkedList  
+class RubyDataStructures::SinglyLinkedList
   # Initializes the SinglyLinkedList
   def initialize
-    @sentinal = RubyDataStructures::SinglyLinkedList::Element.new(self, nil)
+    @sentinel = RubyDataStructures::SinglyLinkedList::Element.new(self, nil)
     self.reset
   end
 
   def head
-    @sentinal.next
+    @sentinel.next
   end
 
   def empty?
-    self.head == @sentinal
+    self.head == @sentinel
   end
 
   def reset
-    @sentinal.next = @sentinal
+    @sentinel.next = @sentinel
   end
 
   # Splices an element onto the front of the linked list
@@ -22,8 +22,8 @@ class RubyDataStructures::SinglyLinkedList
   # *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
+    element.next = @sentinel.next
+    @sentinel.next = element
   end
 
   # Returns the first element with a given key
@@ -31,7 +31,7 @@ class RubyDataStructures::SinglyLinkedList
   # *key* => Key of the element to be searched for
   def search(key)
     element = self.head
-    while (element != @sentinal) && (element.key != key)
+    while (element != @sentinel) && (element.key != key)
       element = element.next
     end
 
@@ -43,14 +43,14 @@ class RubyDataStructures::SinglyLinkedList
   # *key* => Key of the element to be removed
   def delete(key)
     element = self.head
-    prev_element = @sentinal
+    prev_element = @sentinel
     
-    while (element != @sentinal) && (element.key != key)
+    while (element != @sentinel) && (element.key != key)
       prev_element = element
       element = element.next
     end
 
-    if element == @sentinal
+    if element == @sentinel
       raise "Argument Error - No element with the key found"
     else
       prev_element.next = element.next

data/lib/RubyDataStructures/version.rb

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

data/lib/RubyDataStructures.rb

@@ -6,4 +6,6 @@ require 'RubyDataStructures/multi_dimensional_array'
 require 'RubyDataStructures/stack_as_array'
 require 'RubyDataStructures/queue_as_array'
 require 'RubyDataStructures/singly_linked_list'
-require 'RubyDataStructures/singly_linked_list/element'
+require 'RubyDataStructures/singly_linked_list/element'
+require 'RubyDataStructures/doubly_linked_list'
+require 'RubyDataStructures/doubly_linked_list/element'

data/test/RubyDataStructureTest.rb

@@ -8,4 +8,6 @@ require 'test/multi_dimensional_array_test'
 require 'test/stack_as_array_test'
 require 'test/queue_as_array_test'
 require 'test/singly_linked_list_test'
-require 'test/singly_linked_list_element_test'
+require 'test/singly_linked_list_element_test'
+require 'test/doubly_linked_list_test'
+require 'test/doubly_linked_list_element_test'

data/test/doubly_linked_list_element_test.rb

@@ -0,0 +1,39 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class DoublyLinkedListElementTest < 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/doubly_linked_list_test.rb

@@ -0,0 +1,61 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class DoublyLinkedListTest < Test::Unit::TestCase
+  def setup
+    @list = RubyDataStructures::DoublyLinkedList.new
+  end
+  
+  def test_initialize
+    assert_nil @list.head.key
+    assert_nil @list.tail.key
+    assert @list.empty?
+  end
+
+  def test_singly_linked_list
+    assert @list.empty?
+    assert_nil @list.head.key
+    assert_nil @list.tail.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.tail.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.tail.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_equal 9, @list.tail.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_equal 9, @list.tail.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.tail.key
+    assert_nil @list.search(7).key
+    assert_nil @list.search(9).key
+  end
+end

data/test/multi_dimensional_array_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'

data/test/queue_as_array_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'

data/test/singly_linked_list_element_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'

data/test/singly_linked_list_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'
@@ -16,16 +13,6 @@ class SinglyLinkedListTest < Test::Unit::TestCase
     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

data/test/stack_as_array_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: RubyDataStructures
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Satyaram B V
@@ -37,6 +37,8 @@ files:
 - Rakefile
 - RubyDataStructures.gemspec
 - lib/RubyDataStructures.rb
+- lib/RubyDataStructures/doubly_linked_list.rb
+- lib/RubyDataStructures/doubly_linked_list/element.rb
 - lib/RubyDataStructures/multi_dimensional_array.rb
 - lib/RubyDataStructures/queue_as_array.rb
 - lib/RubyDataStructures/ruby_data_structures.rb
@@ -45,6 +47,8 @@ files:
 - lib/RubyDataStructures/stack_as_array.rb
 - lib/RubyDataStructures/version.rb
 - test/RubyDataStructureTest.rb
+- test/doubly_linked_list_element_test.rb
+- test/doubly_linked_list_test.rb
 - test/multi_dimensional_array_test.rb
 - test/queue_as_array_test.rb
 - test/singly_linked_list_element_test.rb