lists

Documentation

Index

• func Swap[T any](list List[T], i, j int)
• type ArrayList
  • func NewArrayList[T any](capacity int) *ArrayList[T]
  • func (a *ArrayList[T]) Add(elems ...T)
  • func (a *ArrayList[T]) Clear()
  • func (a *ArrayList[T]) Clone() List[T]
  • func (a *ArrayList[T]) Contains(elem T, equal containers.Equal[T]) bool
  • func (a *ArrayList[T]) Get(i int) (_ T, _ bool)
  • func (a *ArrayList[T]) IndexOf(elem T, equal containers.Equal[T]) int
  • func (a *ArrayList[T]) Insert(i int, elem ...T)
  • func (a *ArrayList[T]) Iterator() containers.IndexIterator[T]
  • func (a *ArrayList[T]) Join(list List[T])
  • func (a *ArrayList[T]) Remove(i int)
  • func (a *ArrayList[T]) RemoveElem(elem T, equal containers.Equal[T])
  • func (a *ArrayList[T]) Set(i int, elem T)
  • func (a *ArrayList[T]) Size() int
  • func (a *ArrayList[T]) String() string
  • func (a *ArrayList[T]) Values() (_ []T)
• type Iterator
  • func (i *Iterator[T]) Index() int
  • func (i *Iterator[T]) Next()
  • func (i *Iterator[T]) Reverse()
  • func (i *Iterator[T]) Rewind()
  • func (i *Iterator[T]) SeekTo(index int) bool
  • func (i *Iterator[T]) Valid() bool
  • func (i *Iterator[T]) Value() (_ T)
• type LinkedList
  • func NewLinkedList[T any]() *LinkedList[T]
  • func (l *LinkedList[T]) Add(elems ...T)
  • func (l *LinkedList[T]) Clear()
  • func (l *LinkedList[T]) Clone() List[T]
  • func (l *LinkedList[T]) Contains(elem T, equal containers.Equal[T]) bool
  • func (l *LinkedList[T]) Get(i int) (val T, found bool)
  • func (l *LinkedList[T]) IndexOf(elem T, equal containers.Equal[T]) int
  • func (l *LinkedList[T]) Insert(i int, elems ...T)
  • func (l *LinkedList[T]) Iterator() containers.IndexIterator[T]
  • func (l *LinkedList[T]) Join(list List[T])
  • func (l *LinkedList[T]) Remove(i int)
  • func (l *LinkedList[T]) RemoveElem(elem T, equal containers.Equal[T])
  • func (l *LinkedList[T]) Set(i int, elem T)
  • func (l *LinkedList[T]) Size() int
  • func (l *LinkedList[T]) String() string
  • func (l *LinkedList[T]) Values() []T
• type List

Functions

func Swap

func Swap[T any](list List[T], i, j int)

Swap swaps the two given elements of index in the give list

Types

type ArrayList

type ArrayList[T any] struct {
	// contains filtered or unexported fields
}

func NewArrayList

func NewArrayList[T any](capacity int) *ArrayList[T]

NewArrayList returns a new ArrayList with the given capacity

func (*ArrayList[T]) Add

func (a *ArrayList[T]) Add(elems ...T)

func (*ArrayList[T]) Clear

func (a *ArrayList[T]) Clear()

func (*ArrayList[T]) Clone

func (a *ArrayList[T]) Clone() List[T]

func (*ArrayList[T]) Contains

func (a *ArrayList[T]) Contains(elem T, equal containers.Equal[T]) bool

func (*ArrayList[T]) Get

func (a *ArrayList[T]) Get(i int) (_ T, _ bool)

func (*ArrayList[T]) IndexOf

func (a *ArrayList[T]) IndexOf(elem T, equal containers.Equal[T]) int

func (*ArrayList[T]) Insert

func (a *ArrayList[T]) Insert(i int, elem ...T)

func (*ArrayList[T]) Iterator

func (a *ArrayList[T]) Iterator() containers.IndexIterator[T]

func (*ArrayList[T]) Join

func (a *ArrayList[T]) Join(list List[T])

func (*ArrayList[T]) Remove

func (a *ArrayList[T]) Remove(i int)

func (*ArrayList[T]) RemoveElem

func (a *ArrayList[T]) RemoveElem(elem T, equal containers.Equal[T])

func (*ArrayList[T]) Set

func (a *ArrayList[T]) Set(i int, elem T)

func (*ArrayList[T]) Size

func (a *ArrayList[T]) Size() int

func (*ArrayList[T]) String

func (a *ArrayList[T]) String() string

func (*ArrayList[T]) Values

func (a *ArrayList[T]) Values() (_ []T)

type Iterator

type Iterator[T any] struct {
	// contains filtered or unexported fields
}

Iterator returns a basic list iterator

func (*Iterator[T]) Index

func (i *Iterator[T]) Index() int

func (*Iterator[T]) Next

func (i *Iterator[T]) Next()

func (*Iterator[T]) Reverse

func (i *Iterator[T]) Reverse()

func (*Iterator[T]) Rewind

func (i *Iterator[T]) Rewind()

func (*Iterator[T]) SeekTo

func (i *Iterator[T]) SeekTo(index int) bool

func (*Iterator[T]) Valid

func (i *Iterator[T]) Valid() bool

func (*Iterator[T]) Value

func (i *Iterator[T]) Value() (_ T)

type LinkedList

type LinkedList[T any] struct {
	// contains filtered or unexported fields
}

LinkedList implements the list interface by linked nodes which is more efficient to insert and remove nodes.

func NewLinkedList

func NewLinkedList[T any]() *LinkedList[T]

func (*LinkedList[T]) Add

func (l *LinkedList[T]) Add(elems ...T)

func (*LinkedList[T]) Clear

func (l *LinkedList[T]) Clear()

func (*LinkedList[T]) Clone

func (l *LinkedList[T]) Clone() List[T]

func (*LinkedList[T]) Contains

func (l *LinkedList[T]) Contains(elem T, equal containers.Equal[T]) bool

func (*LinkedList[T]) Get

func (l *LinkedList[T]) Get(i int) (val T, found bool)

func (*LinkedList[T]) IndexOf

func (l *LinkedList[T]) IndexOf(elem T, equal containers.Equal[T]) int

func (*LinkedList[T]) Insert

func (l *LinkedList[T]) Insert(i int, elems ...T)

func (*LinkedList[T]) Iterator

func (l *LinkedList[T]) Iterator() containers.IndexIterator[T]

func (*LinkedList[T]) Join

func (l *LinkedList[T]) Join(list List[T])

func (*LinkedList[T]) Remove

func (l *LinkedList[T]) Remove(i int)

func (*LinkedList[T]) RemoveElem

func (l *LinkedList[T]) RemoveElem(elem T, equal containers.Equal[T])

func (*LinkedList[T]) Set

func (l *LinkedList[T]) Set(i int, elem T)

func (*LinkedList[T]) Size

func (l *LinkedList[T]) Size() int

func (*LinkedList[T]) String

func (l *LinkedList[T]) String() string

func (*LinkedList[T]) Values

func (l *LinkedList[T]) Values() []T

type List

type List[T any] interface {
	// Get returns the elem at the given index
	Get(i int) (T, bool)
	// IndexOf returns the index of first element that matches the given element. if not found, return -1
	IndexOf(elem T, equal containers.Equal[T]) int
	// Set replaces the elem at the given index
	Set(i int, elem T)
	// Add appends the given element to the end of the list
	Add(elem ...T)
	// Insert inserts the given elems into the list at the given index
	Insert(i int, elem ...T)
	// Remove removes the elem match given index from the list
	Remove(i int)
	// RemoveElem removes the first element matches the given from the list,
	RemoveElem(elem T, equal containers.Equal[T])
	// Contains check if list contains the given elements
	Contains(elem T, equal containers.Equal[T]) bool
	// Clone returns a value-copy of the original list, not the deep-copy list
	Clone() List[T]
	// Join joins the given list into the original list
	Join(list List[T])

	containers.IndexIterable[T]

	containers.Container[T]
}

List is the base interface of all lists