Documentation
¶
Overview ¶
Package singlylinkedlist implements the singly-linked list.
Structure is not thread safe.
Reference: https://en.wikipedia.org/wiki/List_%28abstract_data_type%29
Index ¶
- type Iterator
- func (it *Iterator[T]) DistanceTo(other ds.OrderedIterator) int
- func (it *Iterator[T]) Get() (value T, found bool)
- func (it *Iterator[T]) Index() (int, bool)
- func (it *Iterator[T]) IsAfter(other ds.OrderedIterator) bool
- func (it *Iterator[T]) IsBefore(other ds.OrderedIterator) bool
- func (it *Iterator[T]) IsBegin() bool
- func (it *Iterator[T]) IsEnd() bool
- func (it *Iterator[T]) IsEqual(other ds.ComparableIterator) bool
- func (it *Iterator[T]) IsFirst() bool
- func (it *Iterator[T]) IsLast() bool
- func (it *Iterator[T]) IsValid() bool
- func (it *Iterator[T]) MoveTo(n int) bool
- func (it *Iterator[T]) Next()
- func (it *Iterator[T]) NextN(n int)
- func (it *Iterator[T]) Set(value T) bool
- func (it *Iterator[T]) Size() int
- type List
- func (list *List[T]) Clear()
- func (list *List[T]) Contains(comparator utils.Comparator[T], values ...T) bool
- func (list *List[T]) End() ds.ReadWriteOrdCompForRandCollIterator[int, T]
- func (list *List[T]) First() ds.ReadWriteOrdCompForRandCollIterator[int, T]
- func (list *List[T]) FromJSON(data []byte) error
- func (list *List[T]) Get(index int) (value T, found bool)
- func (list *List[T]) GetValues() []T
- func (list *List[T]) IndexOf(comparator utils.Comparator[T], value T) int
- func (list *List[T]) Insert(index int, values ...T)
- func (list *List[T]) IsEmpty() bool
- func (list *List[T]) Last() ds.ReadWriteOrdCompForRandCollIterator[int, T]
- func (list *List[T]) MarshalJSON() ([]byte, error)
- func (list *List[T]) NewIterator(l *List[T], position int) *Iterator[T]
- func (list *List[T]) PopBack(n int)
- func (list *List[T]) PopFront(n int)
- func (list *List[T]) PushBack(values ...T)
- func (list *List[T]) PushFront(values ...T)
- func (list *List[T]) Remove(index int)
- func (list *List[T]) Set(index int, value T)
- func (list *List[T]) Size() int
- func (list *List[T]) Sort(comparator utils.Comparator[T])
- func (list *List[T]) Swap(i, j int)
- func (list *List[T]) ToJSON() ([]byte, error)
- func (list *List[T]) ToString() string
- func (list *List[T]) UnmarshalJSON(bytes []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Iterator ¶
type Iterator[T any] struct { // contains filtered or unexported fields }
Iterator holding the iterator's state
func (*Iterator[T]) DistanceTo ¶ added in v0.7.0
func (it *Iterator[T]) DistanceTo(other ds.OrderedIterator) int
DistanceTo implements ds.ReadWriteOrdCompBidRandCollIterator If other is of type IndexedIterator, IndexedIterator.Index() will be used, possibly executing in O(1)
func (*Iterator[T]) IsAfter ¶ added in v0.7.0
func (it *Iterator[T]) IsAfter(other ds.OrderedIterator) bool
IsAfter implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsBefore ¶ added in v0.7.0
func (it *Iterator[T]) IsBefore(other ds.OrderedIterator) bool
IsBefore implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsBegin ¶ added in v0.7.0
IsBegin implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsEqual ¶ added in v0.7.0
func (it *Iterator[T]) IsEqual(other ds.ComparableIterator) bool
IsEqual implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsFirst ¶ added in v0.7.0
IsFirst implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsLast ¶ added in v0.7.0
IsLast implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) IsValid ¶ added in v0.7.0
IsValid implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) MoveTo ¶ added in v0.7.0
MoveTo implements ds.ReadWriteOrdCompBidRandCollIterator
func (*Iterator[T]) Next ¶
func (it *Iterator[T]) Next()
Next implements ds.ReadWriteOrdCompBidRandCollIterator
type List ¶
type List[T any] struct { // contains filtered or unexported fields }
List holds the elements, where each element points to the next element
func NewFromIterator ¶ added in v0.7.0
func NewFromIterator[T any](it ds.ReadCompForIterator[T]) *List[T]
NewFromIterator instantiates a new list containing the elements provided by the passed iterator.
func NewFromIterators ¶ added in v0.7.0
func NewFromIterators[T any](first ds.ReadCompForIterator[T], end ds.ComparableIterator) *List[T]
NewFromIterators instantiates a new list containing the elements provided by first, until it is equal to end. end is a sentinel and not included.
func NewFromSlice ¶ added in v0.7.0
NewFromSlice instantiates a new list containing the provided slice.
func (*List[T]) Contains ¶
func (list *List[T]) Contains(comparator utils.Comparator[T], values ...T) bool
Contains checks if values (one or more) are present in the set. All values have to be present in the set for the method to return true. Performance time complexity of n^2. Returns true if no arguments are passed at all, i.e. set is always super-set of empty set.
func (*List[T]) End ¶ added in v0.7.0
func (list *List[T]) End() ds.ReadWriteOrdCompForRandCollIterator[int, T]
End returns an initialized iterator, which points to one element afrer it's last. Unless Previous() is called, the iterator is in an invalid state.
func (*List[T]) First ¶ added in v0.7.0
func (list *List[T]) First() ds.ReadWriteOrdCompForRandCollIterator[int, T]
First returns an initialized iterator, which points to it's first element.
func (*List[T]) Get ¶
Get returns the element at index. Second return parameter is true if index is within bounds of the array and array is not empty, otherwise false.
func (*List[T]) GetValues ¶ added in v0.3.0
func (list *List[T]) GetValues() []T
Values returns all elements in the list.
func (*List[T]) IndexOf ¶
func (list *List[T]) IndexOf(comparator utils.Comparator[T], value T) int
IndexOf returns index of provided element
func (*List[T]) Insert ¶
Insert inserts values at specified index position shifting the value at that position (if any) and any subsequent elements to the right. Does not do anything if position is negative or bigger than list's size Note: position equal to list's size is valid, i.e. append.
func (*List[T]) Last ¶ added in v0.7.0
func (list *List[T]) Last() ds.ReadWriteOrdCompForRandCollIterator[int, T]
Last returns an initialized iterator, which points to it's last element.
func (*List[T]) MarshalJSON ¶
MarshalJSON @implements json.Marshaler
func (*List[T]) NewIterator ¶ added in v0.7.0
Iterator returns a stateful iterator whose values can be fetched by an index.
func (*List[T]) PushBack ¶ added in v0.3.0
func (list *List[T]) PushBack(values ...T)
Add appends a value (one or more) at the end of the list (same as Append())
func (*List[T]) PushFront ¶ added in v0.3.0
func (list *List[T]) PushFront(values ...T)
Prepend prepends a values (or more)
func (*List[T]) Set ¶
Set value at specified index Does not do anything if position is negative or bigger than list's size Note: position equal to list's size is valid, i.e. append.
func (*List[T]) Sort ¶
func (list *List[T]) Sort(comparator utils.Comparator[T])
Sort sort values (in-place) using.
func (*List[T]) UnmarshalJSON ¶
UnmarshalJSON @implements json.Unmarshaler
Source Files