diff --git a/lib/linked_list.rb b/lib/linked_list.rb index 501c60fb..f9e50cb1 100644 --- a/lib/linked_list.rb +++ b/lib/linked_list.rb @@ -12,152 +12,242 @@ def initialize(value, next_node = nil) # Defines the singly linked list class LinkedList - def initialize - @head = nil # keep the head private. Not accessible outside this class - end + def initialize + @head = nil # keep the head private. Not accessible outside this class + end - # method to add a new node with the specific data value in the linked list - # insert the new node at the beginning of the linked list - # Time Complexity: - # Space Complexity - def add_first(value) - raise NotImplementedError - end + # method to add a new node with the specific data value in the linked list + # insert the new node at the beginning of the linked list + # Time Complexity: O(1) + # Space Complexity: O(1) + def add_first(value) + new_node = Node.new(value) + new_node.next = @head + @head = new_node + return new_node.data + end - # method to find if the linked list contains a node with specified value - # returns true if found, false otherwise - # Time Complexity: - # Space Complexity - def search(value) - raise NotImplementedError - end + # method to find if the linked list contains a node with specified value + # returns true if found, false otherwise + # Time Complexity: + # Space Complexity + def search(value) + raise NotImplementedError + end - # method to return the max value in the linked list - # returns the data value and not the node - # Time Complexity: - # Space Complexity - def find_max - raise NotImplementedError + # method to return the max value in the linked list + # returns the data value and not the node + # Time Complexity: O(n) + # Space Complexity: O(1) + def find_max + return nil if @head.nil? + current = @head + max = current.data + + until current.next.nil? + current = current.next + if max < current.data + max = current.data + end end + return max + end - # method to return the min value in the linked list - # returns the data value and not the node - # Time Complexity: - # Space Complexity - def find_min - raise NotImplementedError + # method to return the min value in the linked list + # returns the data value and not the node + # Time Complexity: O(n) + # Space Complexity: O(1) + def find_min + return nil if @head.nil? + + return nil if @head.nil? + current = @head + min = current.data + + until current.next.nil? + current = current.next + if min > current.data + min = current.data + end end + return min + end + # method that returns the length of the singly linked list + # Time Complexity: O(n) + # Space Complexity: O(1) + def length + current = @head + return 0 if @head.nil? + return 1 if current.next.nil? - # method that returns the length of the singly linked list - # Time Complexity: - # Space Complexity - def length - raise NotImplementedError + count = 1 + until current.next.nil? + current = current.next + count += 1 end + return count + end - # method that returns the value at a given index in the linked list - # index count starts at 0 - # returns nil if there are fewer nodes in the linked list than the index value - # Time Complexity: - # Space Complexity - def get_at_index(index) - raise NotImplementedError - end + # method that returns the value at a given index in the linked list + # index count starts at 0 + # returns nil if there are fewer nodes in the linked list than the index value + # Time Complexity: O(n) + # Space Complexity: O(1) + def get_at_index(index) + return nil if index > (self.length - 1) - # method to print all the values in the linked list - # Time Complexity: - # Space Complexity - def visit - raise NotImplementedError + current = @head + until index == 0 + current = current.next + index -= 1 end - # method to delete the first node found with specified value - # Time Complexity: - # Space Complexity - def delete(value) - raise NotImplementedError - end + return current.data + end - # method to reverse the singly linked list - # note: the nodes should be moved and not just the values in the nodes - # Time Complexity: - # Space Complexity - def reverse - raise NotImplementedError + # method to print all the values in the linked list + # Time Complexity: + # Space Complexity + def visit + raise NotImplementedError + end + + # method to delete the first node found with specified value + # Time Complexity: O(n) + # Space Complexity: O(1) + def delete(value) + return 0 if @head.nil? + current = @head + previous = nil + + # if deleting from front + if current.data == value + @head = current.next + return + else # if deleting from somewhere in middle or end + until current.data == value + previous = current + current = current.next + end + previous.next = current.next end + end + # method to reverse the singly linked list + # note: the nodes should be moved and not just the values in the nodes + # Time Complexity: O(n) + # Space Complexity: O(1) + def reverse + previous = nil + current = @head - ## Advanced Exercises - # returns the value at the middle element in the singly linked list - # Time Complexity: - # Space Complexity - def find_middle_value - raise NotImplementedError + while current != nil + next_node = current.next + current.next = previous + previous = current + current = next_node end - # find the nth node from the end and return its value - # assume indexing starts at 0 while counting to n - # Time Complexity: - # Space Complexity - def find_nth_from_end(n) - raise NotImplementedError - end + @head = previous + end - # checks if the linked list has a cycle. A cycle exists if any node in the - # linked list links to a node already visited. - # returns true if a cycle is found, false otherwise. - # Time Complexity: - # Space Complexity - def has_cycle - raise NotImplementedError - end + ## Advanced Exercises + # returns the value at the middle element in the singly linked list + # Time Complexity: + # Space Complexity + def find_middle_value + raise NotImplementedError + end + # find the nth node from the end and return its value + # assume indexing starts at 0 while counting to n + # Time Complexity: + # Space Complexity + def find_nth_from_end(n) + return nil if n > self.length - 1 - # Additional Exercises - # returns the value in the first node - # returns nil if the list is empty - # Time Complexity: - # Space Complexity - def get_first - raise NotImplementedError - end + index = self.length - n - 1 - # method that inserts a given value as a new last node in the linked list - # Time Complexity: - # Space Complexity - def add_last(value) - raise NotImplementedError + i = 0 + current = @head + while i < index + current = current.next + i += 1 end - # method that returns the value of the last node in the linked list - # returns nil if the linked list is empty - # Time Complexity: - # Space Complexity - def get_last - raise NotImplementedError + return current.data + end + + # checks if the linked list has a cycle. A cycle exists if any node in the + # linked list links to a node already visited. + # returns true if a cycle is found, false otherwise. + # Time Complexity: + # Space Complexity + def has_cycle + raise NotImplementedError + end + + # Additional Exercises + # returns the value in the first node + # returns nil if the list is empty + # Time Complexity: + # Space Complexity + def get_first + return @head.nil? ? nil : @head.data + end + + # method that inserts a given value as a new last node in the linked list + # Time Complexity: + # Space Complexity + def add_last(value) + new_node = Node.new(value) + if self.length == 0 + @head = new_node + else + last = @head + until last.next.nil? + last = last.next + end + last.next = new_node end + end + + # method that returns the value of the last node in the linked list + # returns nil if the linked list is empty + # Time Complexity: + # Space Complexity + def get_last + return nil if @head.nil? - # method to insert a new node with specific data value, assuming the linked - # list is sorted in ascending order - # Time Complexity: - # Space Complexity - def insert_ascending(value) - raise NotImplementedError + current = @head + until current.next.nil? + current = current.next end - # Helper method for tests - # Creates a cycle in the linked list for testing purposes - # Assumes the linked list has at least one node - def create_cycle - return if @head == nil # don't do anything if the linked list is empty + return current.data + end - # navigate to last node - current = @head - while current.next != nil - current = current.next - end + # method to insert a new node with specific data value, assuming the linked + # list is sorted in ascending order + # Time Complexity: + # Space Complexity + def insert_ascending(value) + raise NotImplementedError + end + + # Helper method for tests + # Creates a cycle in the linked list for testing purposes + # Assumes the linked list has at least one node + def create_cycle + return if @head == nil # don't do anything if the linked list is empty - current.next = @head # make the last node link to first node + # navigate to last node + current = @head + while current.next != nil + current = current.next end + + current.next = @head # make the last node link to first node + end end diff --git a/test/linked_list_test.rb b/test/linked_list_test.rb index 8311c439..08254271 100644 --- a/test/linked_list_test.rb +++ b/test/linked_list_test.rb @@ -1,236 +1,235 @@ -require 'minitest/autorun' -require 'minitest/reporters' -require 'minitest/skip_dsl' - -require_relative 'test_helper' +require "minitest/autorun" +require "minitest/reporters" +require "minitest/skip_dsl" +require_relative "test_helper" Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new describe LinkedList do - # Arrange - before do - @list = LinkedList.new - end - - describe 'initialize' do - it 'can be created' do - - # Assert - expect(@list).must_be_kind_of LinkedList - end - end - - describe 'add_first & get_first' do - it 'can add values to an empty list' do - # Act - @list.add_first(3) - - # Assert - expect(@list.get_first).must_equal 3 - end - - it 'will put the last added item to the front of the list' do - # Act - @list.add_first(1) - @list.add_first(2) - - # Assert - expect(@list.get_first).must_equal 2 - - # Act again - @list.add_first(3) - - # Assert - expect(@list.get_first).must_equal 3 - end - - it 'will return `nil` for `getFirst` if the list is empty' do - # Act-Assert - expect(@list.get_first).must_be_nil - end - end - - describe "length" do - it "will return 0 for an empty list" do - # Act-Assert - expect(@list.length).must_equal 0 - end - - it "will return the length for nonempty lists" do - # Arrange - count = 0 - while count < 5 - @list.add_first(count) - count += 1 - # Act-Assert - expect(@list.length).must_equal count - end - end - end - - describe "addLast & getLast" do - it "will add to the front if the list is empty" do - # Arrange - @list.add_last(1) - # Act-Assert - expect(@list.get_first).must_equal 1 - end - - it "will put new items to the rear of the list" do - # Arrange - @list.add_last(2) - # Act-Assert - expect(@list.length).must_equal 1 - expect(@list.get_last).must_equal 2 - - # Arrange - @list.add_last(3) - # Act-Assert - expect(@list.get_first).must_equal 2 - expect(@list.get_last).must_equal 3 - expect(@list.length).must_equal 2 - - @list.add_last(4) - expect(@list.get_first).must_equal 2 - expect(@list.get_last).must_equal 4 - expect(@list.length).must_equal 3 - end - end - - describe 'get_at_index' do - it 'returns nil if the index is outside the bounds of the list' do - # Act-Assert - expect(@list.get_at_index(3)).must_be_nil - end - - it 'can retrieve an item at an index in the list' do - # Arrange - @list.add_first(1) - @list.add_first(2) - @list.add_first(3) - @list.add_first(4) - - # Act-Assert - expect(@list.get_at_index(0)).must_equal 4 - expect(@list.get_at_index(1)).must_equal 3 - expect(@list.get_at_index(2)).must_equal 2 - expect(@list.get_at_index(3)).must_equal 1 - end - end - - describe 'max and min values' do - it 'returns nil if the list is empty' do - # Act-Assert - expect(@list.find_max()).must_be_nil - expect(@list.find_min()).must_be_nil - end - - it 'can retrieve the max and min values in the list' do - # Arrange - count = 0 - while count < 5 - @list.add_first(count) - expect(@list.find_max).must_equal count - expect(@list.find_min).must_equal 0 - count += 1 - end - @list.add_last(100) - @list.add_first(-12) - - # Act-Assert - expect(@list.find_max).must_equal 100 - expect(@list.find_min).must_equal(-12) - end - end - - describe "delete" do - it "delete from empty linked list is a no-op" do - # Assert - expect(@list.length).must_equal 0 - # Act - @list.delete(4) - # Assert - expect(@list.length).must_equal 0 - end - - it "can delete valid values from list" do - # Arrange - @list.add_last(9) - @list.add_last(10) - @list.add_first(4) - @list.add_first(3) - @list.add_first(2) - - # Act - # delete fist node (requires updating head) - @list.delete(2) - - # Assert - expect(@list.get_first).must_equal 3 - expect(@list.length).must_equal 4 - expect(@list.get_last).must_equal 10 - expect(@list.find_max).must_equal 10 - expect(@list.find_min).must_equal 3 - - # Act (again) - # delete last node - @list.delete(10) - # Assert - expect(@list.get_first).must_equal 3 - expect(@list.length).must_equal 3 - expect(@list.get_last).must_equal 9 - expect(@list.find_max).must_equal 9 - expect(@list.find_min).must_equal 3 - - # delete fist node (requires updating head) - @list.delete(4) - expect(@list.get_first).must_equal 3 - expect(@list.length).must_equal 2 - expect(@list.get_last).must_equal 9 - expect(@list.find_max).must_equal 9 - expect(@list.find_min).must_equal 3 - end - end - - describe "nth_from_the_end" do - it 'returns nil if n is outside the bounds of the list' do - # Act-Assert - expect(@list.find_nth_from_end(3)).must_be_nil - end - - it 'can retrieve an item at index n from the end in the list' do - # Arrange - @list.add_first(1) - @list.add_first(2) - @list.add_first(3) - @list.add_first(4) - - # Act-Assert - expect(@list.find_nth_from_end(0)).must_equal 1 - expect(@list.find_nth_from_end(1)).must_equal 2 - expect(@list.find_nth_from_end(2)).must_equal 3 - expect(@list.find_nth_from_end(3)).must_equal 4 - expect(@list.find_nth_from_end(4)).must_be_nil - end - end - - describe "reverse" do - it 'can retrieve an item at index n from the end in the list' do - # Arrange - @list.add_first(4) - @list.add_first(3) - @list.add_first(2) - @list.add_first(1) - - # Act - @list.reverse - - # Assert - expect(@list.find_nth_from_end(0)).must_equal 1 - expect(@list.find_nth_from_end(1)).must_equal 2 - expect(@list.find_nth_from_end(2)).must_equal 3 - expect(@list.find_nth_from_end(3)).must_equal 4 - end + # Arrange + before do + @list = LinkedList.new + end + + describe "initialize" do + it "can be created" do + + # Assert + expect(@list).must_be_kind_of LinkedList + end + end + + describe "add_first & get_first" do + it "can add values to an empty list" do + # Act + @list.add_first(3) + + # Assert + expect(@list.get_first).must_equal 3 + end + + it "will put the last added item to the front of the list" do + # Act + @list.add_first(1) + @list.add_first(2) + + # Assert + expect(@list.get_first).must_equal 2 + + # Act again + @list.add_first(3) + + # Assert + expect(@list.get_first).must_equal 3 + end + + it "will return `nil` for `getFirst` if the list is empty" do + # Act-Assert + expect(@list.get_first).must_be_nil + end + end + + describe "length" do + it "will return 0 for an empty list" do + # Act-Assert + expect(@list.length).must_equal 0 + end + + it "will return the length for nonempty lists" do + # Arrange + count = 0 + while count < 5 + @list.add_first(count) + count += 1 + # Act-Assert + expect(@list.length).must_equal count + end + end + end + + describe "addLast & getLast" do + it "will add to the front if the list is empty" do + # Arrange + @list.add_last(1) + # Act-Assert + expect(@list.get_first).must_equal 1 + end + + it "will put new items to the rear of the list" do + # Arrange + @list.add_last(2) + # Act-Assert + expect(@list.length).must_equal 1 + expect(@list.get_last).must_equal 2 + + # Arrange + @list.add_last(3) + # Act-Assert + expect(@list.get_first).must_equal 2 + expect(@list.get_last).must_equal 3 + expect(@list.length).must_equal 2 + + @list.add_last(4) + expect(@list.get_first).must_equal 2 + expect(@list.get_last).must_equal 4 + expect(@list.length).must_equal 3 + end + end + + describe "get_at_index" do + it "returns nil if the index is outside the bounds of the list" do + # Act-Assert + expect(@list.get_at_index(3)).must_be_nil + end + + it "can retrieve an item at an index in the list" do + # Arrange + @list.add_first(1) + @list.add_first(2) + @list.add_first(3) + @list.add_first(4) + + # Act-Assert + expect(@list.get_at_index(0)).must_equal 4 + expect(@list.get_at_index(1)).must_equal 3 + expect(@list.get_at_index(2)).must_equal 2 + expect(@list.get_at_index(3)).must_equal 1 + end + end + + describe "max and min values" do + it "returns nil if the list is empty" do + # Act-Assert + expect(@list.find_max()).must_be_nil + expect(@list.find_min()).must_be_nil + end + + it "can retrieve the max and min values in the list" do + # Arrange + count = 0 + while count < 5 + @list.add_first(count) + expect(@list.find_max).must_equal count + expect(@list.find_min).must_equal 0 + count += 1 + end + @list.add_last(100) + @list.add_first(-12) + + # Act-Assert + expect(@list.find_max).must_equal 100 + expect(@list.find_min).must_equal(-12) + end + end + + describe "delete" do + it "delete from empty linked list is a no-op" do + # Assert + expect(@list.length).must_equal 0 + # Act + @list.delete(4) + # Assert + expect(@list.length).must_equal 0 + end + + it "can delete valid values from list" do + # Arrange + @list.add_last(9) + @list.add_last(10) + @list.add_first(4) + @list.add_first(3) + @list.add_first(2) + + # Act + # delete fist node (requires updating head) + @list.delete(2) + + # Assert + expect(@list.get_first).must_equal 3 + expect(@list.length).must_equal 4 + expect(@list.get_last).must_equal 10 + expect(@list.find_max).must_equal 10 + expect(@list.find_min).must_equal 3 + + # Act (again) + # delete last node + @list.delete(10) + # Assert + expect(@list.get_first).must_equal 3 + expect(@list.length).must_equal 3 + expect(@list.get_last).must_equal 9 + expect(@list.find_max).must_equal 9 + expect(@list.find_min).must_equal 3 + + # delete fist node (requires updating head) + @list.delete(4) + expect(@list.get_first).must_equal 3 + expect(@list.length).must_equal 2 + expect(@list.get_last).must_equal 9 + expect(@list.find_max).must_equal 9 + expect(@list.find_min).must_equal 3 + end + end + + describe "nth_from_the_end" do + it "returns nil if n is outside the bounds of the list" do + # Act-Assert + expect(@list.find_nth_from_end(3)).must_be_nil + end + + it "can retrieve an item at index n from the end in the list" do + # Arrange + @list.add_first(1) + @list.add_first(2) + @list.add_first(3) + @list.add_first(4) + + # Act-Assert + expect(@list.find_nth_from_end(0)).must_equal 1 + expect(@list.find_nth_from_end(1)).must_equal 2 + expect(@list.find_nth_from_end(2)).must_equal 3 + expect(@list.find_nth_from_end(3)).must_equal 4 + expect(@list.find_nth_from_end(4)).must_be_nil + end + end + + describe "reverse" do + it "can retrieve an item at index n from the end in the list" do + # Arrange + @list.add_first(4) + @list.add_first(3) + @list.add_first(2) + @list.add_first(1) + + # Act + @list.reverse + + # Assert + expect(@list.find_nth_from_end(0)).must_equal 1 + expect(@list.find_nth_from_end(1)).must_equal 2 + expect(@list.find_nth_from_end(2)).must_equal 3 + expect(@list.find_nth_from_end(3)).must_equal 4 end + end end