github.com/tursom/GoCollections@v0.3.10/collections/LinkedList.go

/*
 * Copyright (c) 2022 tursom. All rights reserved.
 * Use of this source code is governed by a GPL-3
 * license that can be found in the LICENSE file.
 */

package collections

import (
	"github.com/tursom/GoCollections/exceptions"
	"github.com/tursom/GoCollections/lang"
)

type (
	LinkedList[T lang.Object] struct {
		lang.BaseObject
		head *linkedListNode[T]
		size int
	}
	linkedListNode[T lang.Object] struct {
		prev, next *linkedListNode[T]
		value      T
	}
	linkedListIterator[T lang.Object] struct {
		list       *LinkedList[T]
		node, head *linkedListNode[T]
		index      int
	}
)

func (l *LinkedList[T]) String() string {
	return String[T](l)
}

func NewLinkedList[T lang.Object]() *LinkedList[T] {
	tail := &linkedListNode[T]{}
	tail.prev = tail
	tail.next = tail
	return &LinkedList[T]{lang.NewBaseObject(), tail, 0}
}

func NewLinkedListFrom[T lang.Object](list List[T], from, to int) *LinkedList[T] {
	newList := NewLinkedList[T]()
	iterator, err := SkipIterator[T](list.ListIterator(), to-from)
	if err != nil {
		panic(err)
	}

	for i := 0; i < to-from; i++ {
		next, err := iterator.Next()
		if err != nil {
			panic(err)
		}

		// newList wont throw any exception in this place
		_ = newList.Add(next)
	}

	return newList
}

func (l *LinkedList[T]) Size() int {
	return l.size
}

func (l *LinkedList[T]) IsEmpty() bool {
	return l.size == 0
}

func (l *LinkedList[T]) Contains(element T) bool {
	return Contains[T](l, element)
}

func (l *LinkedList[T]) ContainsAll(c Collection[T]) bool {
	return ContainsAll[T](l, c)
}

func (l *LinkedList[T]) Add(element T) bool {
	l.size++
	node := &linkedListNode[T]{l.head.prev, l.head, element}
	node.next.prev = node
	node.prev.next = node
	return true
}

func (l *LinkedList[T]) Remove(element T) exceptions.Exception {
	err := LoopMutable[T](l, func(e T, iterator MutableIterator[T]) exceptions.Exception {
		if lang.Equals(element, e) {
			iterator.Remove()
			return exceptions.CollectionLoopFinished
		}
		return nil
	})
	if err != nil {
		return nil
	} else {
		return exceptions.NewElementNotFoundException("", nil)
	}
}

func (l *LinkedList[T]) AddAll(c Collection[T]) bool {
	return AddAll[T](l, c)
}

func (l *LinkedList[T]) RemoveAll(c Collection[T]) bool {
	return RemoveAll[T](l, c)
}

func (l *LinkedList[T]) RetainAll(c Collection[T]) bool {
	return RetainAll[T](l, c)
}

func (l *LinkedList[T]) Clear() {
	l.head.next = l.head
	l.size = 0
}

func (l *LinkedList[T]) SubList(from, to int) List[T] {
	return l.SubMutableList(from, to)
}

func (l *LinkedList[T]) Set(index int, element T) exceptions.Exception {
	node := l.head
	for node != l.head {
		if index == 0 {
			node.value = element
			return nil
		}
		index--
	}
	return exceptions.NewIndexOutOfBound("", nil)
}

func (l *LinkedList[T]) AddAtIndex(index int, element T) bool {
	node := l.head
	for node != l.head {
		if index == 0 {
			l.size++
			node.next = &linkedListNode[T]{node, node.next, element}
			node.next.next.prev = node.next
			return true
		}
		index--
	}
	return false
}

func (l *LinkedList[T]) addAtNode(node *linkedListNode[T], element T) {
	l.size++
	node.next = &linkedListNode[T]{node, node.next, element}
	node.next.next.prev = node.next
}

func (l *LinkedList[T]) RemoveAt(index int) exceptions.Exception {
	node := l.head
	for node != l.head {
		if index == 0 {
			l.size--
			node.remove()
			return nil
		}
		index--
	}
	return exceptions.NewIndexOutOfBound("", nil)
}
func (l *LinkedList[T]) RemoveLast() (T, exceptions.Exception) {
	if l.head.next == l.head {
		return lang.Nil[T](), exceptions.NewIndexOutOfBound("list is empty", nil)
	}
	return l.head.prev.remove(), nil
}

func (l *LinkedList[T]) SubMutableList(from, to int) MutableList[T] {
	if from < 0 || from < to || to > l.size {
		panic(exceptions.NewIndexOutOfBound("", nil))
	}
	list := NewLinkedList[T]()
	if from == to {
		return list
	}
	node := l.head
	for i := 0; i < from; i++ {
		node = node.next
	}
	for i := from; i < to; i++ {
		node = node.next
		list.Add(node.value)
	}
	return list
	return NewArrayListFrom[T](l, from, to)
}

func (l *LinkedList[T]) Get(index int) (T, exceptions.Exception) {
	if index < l.size/2 {
		return loopLinkedListNodeUp[T](l.head, index)
	} else {
		return loopLinkedListNodeDown[T](l.head, l.size-index-1)
	}
}

func loopLinkedListNodeUp[T lang.Object](head *linkedListNode[T], index int) (T, exceptions.Exception) {
	node := head.next
	for node != head {
		if index == 0 {
			return node.value, nil
		}
		index--
		node = node.next
	}

	return lang.Nil[T](), exceptions.NewIndexOutOfBound("", nil)
}

func loopLinkedListNodeDown[T lang.Object](head *linkedListNode[T], index int) (T, exceptions.Exception) {
	node := head.prev
	for node != head {
		if index == 0 {
			return node.value, nil
		}
		index--
		node = node.prev
	}

	return lang.Nil[T](), exceptions.NewIndexOutOfBound("", nil)
}

func (l *LinkedList[T]) Iterator() Iterator[T] {
	return l.MutableIterator()
}

func (l *LinkedList[T]) MutableIterator() MutableIterator[T] {
	return l.MutableListIterator()
}

func (l *LinkedList[T]) ListIterator() ListIterator[T] {
	return l.MutableListIterator()
}

func (l *LinkedList[T]) MutableListIterator() MutableListIterator[T] {
	return &linkedListIterator[T]{l, l.head.next, l.head, 0}
}

func (l *linkedListIterator[T]) HasNext() bool {
	return l.node != l.head
}

func (l *linkedListIterator[T]) Next() (T, exceptions.Exception) {
	if l.node == l.head {
		return lang.Nil[T](), exceptions.NewIndexOutOfBound("", nil)
	}
	l.node = l.node.next
	l.index++
	return l.node.prev.value, nil
}

func (l *linkedListIterator[T]) Remove() exceptions.Exception {
	if l.node.prev == l.head {
		return exceptions.NewIndexOutOfBound("", nil)
	}
	l.node.prev.remove()
	l.list.size--
	return nil
}

func (l *linkedListNode[T]) remove() T {
	l.next.prev = l.prev
	l.prev.next = l.next
	return l.value
}

func (l *linkedListIterator[T]) HasPrevious() bool {
	return l.head.next != l.head
}

func (l *linkedListIterator[T]) Previous() (T, exceptions.Exception) {
	if l.node.prev.prev == l.head {
		return lang.Nil[T](), exceptions.NewIndexOutOfBound("", nil)
	}
	l.node = l.node.prev
	l.index--
	return l.node.prev.value, nil
}

func (l *linkedListIterator[T]) NextIndex() int {
	return l.index
}

func (l *linkedListIterator[T]) PreviousIndex() int {
	return l.index - 1
}

func (l *linkedListIterator[T]) Set(value T) exceptions.Exception {
	l.node.prev.value = value
	return nil
}

func (l *linkedListIterator[T]) Add(value T) exceptions.Exception {
	l.list.addAtNode(l.node.prev, value)
	return nil
}