list

README

Usage

This is the Go standard library implementation of a linked list (https://golang.org/src/container/list/list.go), with the following modifications:

• it uses Go generics
• it allows passing in a sync.Pool (via the NewWithPool constructor) to reduce allocations of Element structs

Documentation

Overview

Package list implements a doubly linked list.

To iterate over a list (where l is a *List[T]):

for e := l.Front(); e != nil; e = e.Next() {
	// do something with e.Value
}

Index

• func NewPool[T any]() *sync.Pool
• type Element
  • func (e *Element[T]) List() *List[T]
  • func (e *Element[T]) Next() *Element[T]
  • func (e *Element[T]) Prev() *Element[T]
• type List
  • func New[T any]() *List[T]
  • func NewWithPool[T any](pool *sync.Pool) *List[T]
  • func (l *List[T]) Back() *Element[T]
  • func (l *List[T]) Front() *Element[T]
  • func (l *List[T]) Init() *List[T]
  • func (l *List[T]) InsertAfter(v T, mark *Element[T]) *Element[T]
  • func (l *List[T]) InsertBefore(v T, mark *Element[T]) *Element[T]
  • func (l *List[T]) Len() int
  • func (l *List[T]) MoveAfter(e, mark *Element[T])
  • func (l *List[T]) MoveBefore(e, mark *Element[T])
  • func (l *List[T]) MoveToBack(e *Element[T])
  • func (l *List[T]) MoveToFront(e *Element[T])
  • func (l *List[T]) PushBack(v T) *Element[T]
  • func (l *List[T]) PushBackList(other *List[T])
  • func (l *List[T]) PushFront(v T) *Element[T]
  • func (l *List[T]) PushFrontList(other *List[T])
  • func (l *List[T]) Remove(e *Element[T]) T

Functions

func NewPool

func NewPool[T any]() *sync.Pool

Types

type Element

type Element[T any] struct {

	// The value stored with this element.
	Value T
	// contains filtered or unexported fields
}

Element is an element of a linked list.

func (*Element[T]) List

func (e *Element[T]) List() *List[T]

func (*Element[T]) Next

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

Next returns the next list element or nil.

func (*Element[T]) Prev

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

Prev returns the previous list element or nil.

type List

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

List represents a doubly linked list. The zero value for List is an empty list ready to use.

func New

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

New returns an initialized list.

func NewWithPool

func NewWithPool[T any](pool *sync.Pool) *List[T]

NewWithPool returns an initialized list, using a sync.Pool for list elements.

func (*List[T]) Back

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

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

func (*List[T]) Front

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

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

func (*List[T]) Init

func (l *List[T]) Init() *List[T]

Init initializes or clears list l.

func (*List[T]) InsertAfter

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

InsertAfter inserts a new element e with value v immediately after mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*List[T]) InsertBefore

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

InsertBefore inserts a new element e with value v immediately before mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*List[T]) Len

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

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

func (*List[T]) MoveAfter

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

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[T]) MoveBefore

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

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[T]) MoveToBack

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

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[T]) MoveToFront

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

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[T]) PushBack

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

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

func (*List[T]) PushBackList

func (l *List[T]) PushBackList(other *List[T])

PushBackList inserts a copy of another list at the back of list l. The lists l and other may be the same. They must not be nil.

func (*List[T]) PushFront

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

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

func (*List[T]) PushFrontList

func (l *List[T]) PushFrontList(other *List[T])

PushFrontList inserts a copy of another list at the front of list l. The lists l and other may be the same. They must not be nil.

func (*List[T]) Remove

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

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.