genericlist

Documentation

Overview

Package genericlist contains an implementation of a doubly-linked list that uses generics. The list is not go-routine safe.

Index

• type Element
  • func (e *Element[V]) Next() *Element[V]
  • func (e *Element[V]) Prev() *Element[V]
• type List
  • func New[V any]() *List[V]
  • func (l *List[V]) Back() *Element[V]
  • func (l *List[V]) Front() *Element[V]
  • func (l *List[V]) InsertAfter(v V, mark *Element[V]) *Element[V]
  • func (l *List[V]) InsertBefore(v V, mark *Element[V]) *Element[V]
  • func (l *List[V]) Len() int
  • func (l *List[V]) MoveAfter(e, mark *Element[V])
  • func (l *List[V]) MoveBefore(e, mark *Element[V])
  • func (l *List[V]) MoveToBack(e *Element[V])
  • func (l *List[V]) MoveToFront(e *Element[V])
  • func (l *List[V]) PushBack(v V) *Element[V]
  • func (l *List[V]) PushFront(v V) *Element[V]
  • func (l *List[V]) Remove(e *Element[V]) V

Types

type Element

type Element[V any] struct {
	Value V
	// contains filtered or unexported fields
}

Element is an element of a doubly linked list

func (*Element[V]) Next

func (e *Element[V]) Next() *Element[V]

Next returns the next list element or nil.

func (*Element[V]) Prev

func (e *Element[V]) Prev() *Element[V]

Prev returns the previous list element or nil.

type List

type List[V any] struct {
	// contains filtered or unexported fields
}

List is a doubly linked list

func New

func New[V any]() *List[V]

New returns a new empty list.

func (*List[V]) Back

func (l *List[V]) Back() *Element[V]

Back returns the last element of list l or nil if the list is empty.

func (*List[V]) Front

func (l *List[V]) Front() *Element[V]

Front returns the first element of list l or nil if the list is empty.

func (*List[V]) InsertAfter

func (l *List[V]) InsertAfter(v V, mark *Element[V]) *Element[V]

InsertAfter inserts a new element e with value v after the mark and returns e

func (*List[V]) InsertBefore

func (l *List[V]) InsertBefore(v V, mark *Element[V]) *Element[V]

InsertBefore inserts a new element e with value v before the mark and returns e

func (*List[V]) Len

func (l *List[V]) Len() int

Len returns the number of elements of list l. The complexity is O(1).

func (*List[V]) MoveAfter

func (l *List[V]) MoveAfter(e, mark *Element[V])

MoveAfter moves element e to its new position after mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*List[V]) MoveBefore

func (l *List[V]) MoveBefore(e, mark *Element[V])

MoveBefore moves element e to its new position before mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*List[V]) MoveToBack

func (l *List[V]) MoveToBack(e *Element[V])

MoveToBack moves element e to the back of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*List[V]) MoveToFront

func (l *List[V]) MoveToFront(e *Element[V])

MoveToFront moves element e to the front of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*List[V]) PushBack

func (l *List[V]) PushBack(v V) *Element[V]

PushBack inserts a new element e with value v at the back of list l and returns e.

func (*List[V]) PushFront

func (l *List[V]) PushFront(v V) *Element[V]

PushFront inserts a new element e with value v at the front of list l and returns e.

func (*List[V]) Remove

func (l *List[V]) Remove(e *Element[V]) V

Remove removes e from l if e is an element of list l. It returns the element value e.Value. The element must not be nil.