doubly_linkedlist 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fe67884195d2f09260a6a101925e79f8c1623866484e4b4de63d47e420b8f90
-  data.tar.gz: b6f40e44fcc95f1506198f9d5f97e285b841b5e522c6f31f40d14081fa4dade9
+  metadata.gz: 47ad35ba5b5fce866c46f143f8d1adc8cd9230fb477ce3af85cc862c2f22d5e1
+  data.tar.gz: 2ef37aa5fc4465ea04328d3e8b1b091cfb1a79a8c421619ba65aa349832cf2f9
 SHA512:
-  metadata.gz: 631816dbbab742313398e44be5a8fe77ddab8dec76152ce3ab6059f7809ac3932283bd27a4fe3ff58476a15f795fda65a6daa45cfbef8386d4771d6803e6794c
-  data.tar.gz: a43529f9173dcea56fda8f5322f07f9b44ebd5897ead5e9dc113c482d11fa792a89b886baabaf85b29beb957d4b3ebf274d157fea01344961efbca898994b20e
+  metadata.gz: c2555a7110da1148d3e0e141b9aacf62c8c1d981bac0278d8ea86ff3032fdecdfcee08dd953edc12e701966e7834e1f1533f264d32697d83892d649e6a451216
+  data.tar.gz: 7ef1c47806d9165fd861d626949b471e9e266b2ed3ea56dcf7b12098345c81a63ebfb2484ffafe734e019ab51b3735ded134c61e0f9b4203a5374c06f964be1b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doubly_linkedlist (0.1.0)
+    doubly_linkedlist (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,31 +20,183 @@ Or install it yourself as:
 
 ## Usage
 
-#### Initialization
+### Initialization
 
-There are two different ways to initialize a linkedlist including one which converting an array into a list by calling `to_list` method on the array object.
+There are different ways to initialize a linkedlist including the one which converting an array into a list by calling `to_list` method on the array object.
 
 You can find the examples below.
 
 ```ruby
-    # You can pass an array as argument which
-    # will be the created list's node values.
-    list = DoublyLinkedlist.new([obj1, obj2, ...])
+# You can pass an array as argument whose elements will be the created list's node values.
+list = DoublyLinkedlist::List.new([obj1, obj2, ...])
 
-    # Argument is optional. If not given,
-    # a empty list is created.
-    list1 = DoublyLinkedlist.new
+# Argument is optional. If not given, a empty list with no nodes is created.
+empty_list = DoublyLinkedlist::List.new
+
+# You can also use `to_list` method on an array object to create a new list object.
+another_list = [obj1, obj2, ...].to_list
+
+another_list.class # => DoublyLinkedlist::List
+```
+
+### Methods
+
+#### General methods
+
+##### #count
+
+Returns the number of nodes in the list.
+
+Examples are shown below,
+
+```ruby
+empty_list = DoublyLinkedlist::List.new
+
+empty_list.count # => 0
+
+another_list = [10, 20, 40, 30].to_list
+
+another_list.count # => 4
 ```
-#### Methods
+
+##### #head (also: #first)
+
+Returns the value at the head of the list if present, `nil` otherwise.
 
 ```ruby
-    list.count # => returns the number of nodes in the list
+list = [10, 20, 40, 50].to_list
 
-    list.head # => returns the node value at the list's head. (Alias: first)
+list.head # => 10
+list.first # => 10
 
-    list.tail # => returns the node value at the list's tail. (Alias: last)
+empty_list = DoublyLinkedlist::List.new
+
+empty_list.head # => nil
 ```
 
+##### #tail (also: #last)
+
+Returns the value at the tail of the list if present, `nil` otherwise.
+
+```ruby
+list = [10, 20, 40, 50].to_list
+
+list.tail # => 50
+list.last # => 50
+
+empty_list = DoublyLinkedlist::List.new
+
+empty_list.tail # => nil
+```
+
+##### #find_at(index)
+
+Returns the node object at the given index if present, `nil` otherwise.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100]
+
+list.find_at(1) # => "Some object"
+list.find_at(4) # => nil
+```
+
+##### #index(value) and #rindex(value)
+
+Returns the leftmost(`#index`)/rightmost(`#rindex`) index of the value present in the list, 
+`nil` if not present.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.index(40) # => 2
+list.rindex(40) # => 4
+
+list.index(200) # => nil
+```
+
+##### #delete_at(index)
+
+Deletes the node at a given index and returns the value present in the
+deleted node. Returns `nil` if the given index is out of range.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+list.count # => 5
+
+list.delete_at(1) # => "Some object"
+list # => [1, 40, 100, 40]
+list.count # => 4
+
+list.delete_at(6) # => nil
+list.count # => 4
+```
+
+##### #to_a
+
+Converts the list object into an array object with all the node values.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+arr = list.to_a
+arr.class # => Array
+arr # => [1, "Some object", 40, 100, 40]
+```
+
+#### Stack Operations
+
+##### #push(obj)
+
+Inserts a node with the given value into the head of the list,
+increments and returns the count of nodes.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.push(25) # => 6
+list # => [25, 1, "Some object", 40, 100, 40]
+```
+
+##### #pop
+
+Deletes and returns the node value at the head of the list.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.pop # => 1
+list.count # => 4
+list # => ["Some object", 40, 100, 40]
+```
+
+#### Queue Operations
+
+##### #enqueue(obj)
+
+Appends a node with the given value into tail of the list,
+increments and returns the count of nodes.
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.enqueue(25) # => 6
+list # => [1, "Some object", 40, 100, 40, 25]
+```
+
+##### #deque
+
+Deletes and returns the node value at the head of the list. (Same as `#pop`)
+
+```ruby
+list = DoublyLinkedlist::List.new [1, "Some object", 40, 100, 40]
+
+list.deque # => 1
+list.count # => 4
+list # => ["Some object", 40, 100, 40]
+```
+
+Refer [documentation](https://rubydoc.info/gems/doubly_linkedlist/DoublyLinkedlist/) for more information.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.

data/lib/doubly_linkedlist/list.rb

@@ -40,7 +40,7 @@ module DoublyLinkedlist
     # @param index [Integer] the index where to look up.
     # @return [Object, Nil] the value at the given index, or nil if index is out of range.
     def find_at(index)
-      return if (index + 1) > count
+      return if (index + 1) > count || index < 0
 
       item = @head
       index.times { item = item.next }
@@ -53,7 +53,7 @@ module DoublyLinkedlist
     # @param value [Object] the node value for which to be looked up.
     # @return [Integer, Nil] the index of the value passed in, or nil if value is not present.
     def index(value)
-      find_index(0, @head, :next, 1)
+      find_index(value, 0, @head, :next, 1)
     end
 
     # Returns the rightmost index of value present in the list.
@@ -62,7 +62,7 @@ module DoublyLinkedlist
     # @param value [Object] the node value for which to be looked up.
     # @return [Integer, Nil] the index of the value passed in, or nil if value is not present.
     def rindex(value)
-      find_index(count - 1, @tail, :prev, -1)
+      find_index(value, count - 1, @tail, :prev, -1)
     end
 
     # Inserts a node with the given value into the head of the list,
@@ -102,7 +102,7 @@ module DoublyLinkedlist
     # @param index [Integer] the index at which node has to be deleted.
     # @return [Object] the deleted node value.
     def delete_at(index)
-      return if (index + 1) > count
+      return if (index + 1) > count || index < 0
 
       if index.zero?
         deleted = @head
@@ -161,7 +161,7 @@ module DoublyLinkedlist
       values.each { |v| enqueue(v) }
     end
 
-    def find_index(start_index, start_item, item_iterator_name, step)
+    def find_index(value, start_index, start_item, item_iterator_name, step)
       i = start_index
       item = start_item
 

data/lib/doubly_linkedlist/version.rb

@@ -1,4 +1,4 @@
 module DoublyLinkedlist
   # Gem version
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doubly_linkedlist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Anshab M K