version: 1.10
package list
import "container/list"
Overview
Package list implements a 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
}
// Create a new list and put some numbers in it.
l := list.New()
e4 := l.PushBack(4)
e1 := l.PushFront(1)
l.InsertBefore(3, e4)
l.InsertAfter(2, e1)
// Iterate through list and print its contents.
for e := l.Front(); e != nil; e = e.Next() {
fmt.Println(e.Value)
}
// Output:
// 1
// 2
// 3
// 4
Index
- type 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(v interface{}, mark Element) *Element
- func (l List) InsertBefore(v interface{}, 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(v interface{}) Element
- func (l List) PushBackList(other List)
- func (l List) PushFront(v interface{}) Element
- func (l List) PushFrontList(other List)
- func (l List) Remove(e Element) interface{}
Examples
Package files
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.
func (*Element) Next ¶
Next returns the next list element or nil.
func (*Element) Prev ¶
Prev returns the previous list element or nil.
type List ¶
- type List 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() *List
New returns an initialized list.
func (*List) Back ¶
Back returns the last element of list l or nil if the list is empty.
func (*List) Front ¶
Front returns the first element of list l or nil if the list is empty.
func (*List) Init ¶
Init initializes or clears list l.
func (*List) InsertAfter ¶
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) InsertBefore ¶
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) Len ¶
Len returns the number of elements of list l. The complexity is O(1).
func (*List) MoveAfter ¶
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) MoveBefore ¶
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) MoveToBack ¶
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) MoveToFront ¶
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) PushBack ¶
PushBack inserts a new element e with value v at the back of list l and returns e.
func (*List) PushBackList ¶
PushBackList inserts a copy of an other list at the back of list l. The lists l and other may be the same. They must not be nil.
func (*List) PushFront ¶
PushFront inserts a new element e with value v at the front of list l and returns e.
func (*List) PushFrontList ¶
PushFrontList inserts a copy of an other list at the front of list l. The lists l and other may be the same. They must not be nil.
func (*List) Remove ¶
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.