internallist

Documentation

Overview

Package internallist implements an internal doubly linked list.

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

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

Index

• type Element
  • func (e *Element) Next() *Element
  • func (e *Element) Prev() *Element
• type List
  • func New() *List
  • func (l *List) Back() *Element
  • func (l *List) Front() *Element
  • func (l *List) Init() *List
  • func (l *List) InsertAfter(e *Element, mark *Element) *Element
  • func (l *List) InsertBefore(e *Element, mark *Element) *Element
  • func (l *List) Len() int
  • func (l *List) MoveAfter(e, mark *Element)
  • func (l *List) MoveBefore(e, mark *Element)
  • func (l *List) MoveToBack(e *Element)
  • func (l *List) MoveToFront(e *Element)
  • func (l *List) PushBack(e *Element) *Element
  • func (l *List) PushFront(e *Element) *Element
  • func (l *List) Remove(e *Element) interface{}

Types

type Element

type Element struct {

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

Element is an element of a linked list. It should be internally embedded into the target structure, and have Value initialised

func (*Element) Next

func (e *Element) Next() *Element

Next returns the next list element or nil.

func (*Element) Prev

func (e *Element) Prev() *Element

Prev returns the previous list element or nil.

type List

type List struct {
	// contains filtered or unexported fields
}

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

func New

func New() *List

New returns an initialized list.

func (*List) Back

func (l *List) Back() *Element

Back returns the last element of list l or nil.

func (*List) Front

func (l *List) Front() *Element

Front returns the first element of list l or nil.

func (*List) Init

func (l *List) Init() *List

Init initializes or clears list l.

func (*List) InsertAfter

func (l *List) InsertAfter(e *Element, mark *Element) *Element

InsertAfter inserts a new element e after mark and returns e. If mark is not an element of l, the list is not modified.

func (*List) InsertBefore

func (l *List) InsertBefore(e *Element, mark *Element) *Element

InsertBefore inserts a new element e before mark and returns e. If mark is not an element of l, the list is not modified.

func (*List) Len

func (l *List) Len() int

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

func (*List) MoveAfter

func (l *List) MoveAfter(e, mark *Element)

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.

func (*List) MoveBefore

func (l *List) MoveBefore(e, mark *Element)

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.

func (*List) MoveToBack

func (l *List) MoveToBack(e *Element)

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

func (*List) MoveToFront

func (l *List) MoveToFront(e *Element)

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

func (*List) PushBack

func (l *List) PushBack(e *Element) *Element

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

func (*List) PushFront

func (l *List) PushFront(e *Element) *Element

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

func (*List) Remove

func (l *List) Remove(e *Element) interface{}

Remove removes e from l if e is an element of list l. It returns the element value e.Value.