Go | container/list标准库

概述

container/list包实现了基本的双向链表功能，包括元素的插入、删除、移动功能

链表元素

链表中元素定义如下：

type Element struct {
     Value interface{}
}

func (e *Element) Next() *Element
func (e *Element) Prev() *Element

通过Value属性来获取元素的值，此外Element还有两个方法Next和Prev分别获取当前元素的前一个元素和后一个元素。

成员函数

初始化

可以通过调用New函数或者Init方法来初始化一个空的list，此外Init也可以重置一个list。函数声明如下：

// New返回一个初始化的列表。
func New() *List

// 这个方法是初始化方法，同时也会清空原来list中的所有元素
func (l *List) Init() *List

遍历

对于链表来说，遍历是最常用的操作，遍历操作一共三步：

• 第一步，获取一个遍历起始点；使用Front或Back获取一个链表的头和尾，其函数声明如下：

  func (l *List) Front() *List
  func (l *List) Back() *List
  

• 第二步，从当前元素转到下一个元素；使用Element上的Prev和Next方法向前或向后移动一个元素。
• 第三步，遍历结束条件；遍历结束条件需要人为判断，一般比较当前元素是否为结束元素。

插入

container/list中提供了两种插入方法，InsertAfter和InsertBefore，分别用于在一个元素前或后插入元素，方法声明如下：

// insertaafter在mark后面插入一个新元素e，并返回e。
// 如果mark不是l的一个元素，列表不会被修改。
func (l *List) InsertAfter(v interface{}, mark *Element) *Element

// InsertBefore插入一个新元素e，值v紧挨着mark并返回e。
// 如果mark不是l的一个元素，列表不会被修改。
func (l *List) InsertBefore(v interface{}, mark *Element) *Element

添加

PushBack和PushFront用于在一个链表的头和尾添加元素（此外还有一次性添加一个list的PushBackList和PushFrontList），方法声明如下：

// PushBack在列表l的后面插入一个值为v的新元素e，并返回e。
func (l *List) PushBack(v interface{}) *Element

// PushFront在列表l的前面插入一个值为v的新元素e，并返回e
func (l *List) PushFront(v interface{}) *Element

// PushFrontList在列表l的前面插入另一个列表的副本。
// 列表l和other可能是相同的。它们不能为零。
func (l *List) PushFrontList(other *List)

// PushBackList在list l的后面插入另一个list的副本。
// 列表l和other可能是相同的。它们不能为零。
func (l *List) PushBackList(other *List)

删除

可以通过Remove方法，删除链表上指定元素，方法声明如下：

// 如果e是list l中的一个元素，则从列表l中移除e。
// 返回元素的值e。
// 该元素不能为空。
func (l *List) Remove(e *Element) interface{}

移动

MoveToFront和MoveToBack用于将链表中某元素移动到链表的头和尾，方法声明如下：

// MoveToFront将元素e移动到列表l的前面。
// 如果e不是l的一个元素，列表不会被修改。
// 该元素不能为空。
func (l *List) MoveToFront(e *Element)

// MoveToBack将元素e移动到列表l的后面。
// 如果e不是l的一个元素，列表不会被修改。
// 该元素不能为空。
func (l *List) MoveToBack(e *Element) 

MoveBefore和MoveAfter用于将链表中某元素移动到链表中某个元素之前或和后，方法声明如下：

// MoveBefore将元素e移动到标记之前的新位置。
// 如果e或mark不是l的元素，或e == mark，则不修改列表。
// 元素和标记不能为nil
func (l *List) MoveBefore(e, mark *Element)

// MoveAfter将元素e移动到mark之后的新位置。
// 如果e或mark不是l的元素，或e == mark，则不修改列表。
// 元素和标记不能为nil。
func (l *List) MoveAfter(e, mark *Element)

长度

可以通过Len方法，获取当前列表元素个数，方法声明如下：

// Len返回列表l中元素的个数。
// 复杂度是O(1)
func (l *List) Len() int { return l.len }

使用实例

实际上，将前面的内容整合起来，就可以实现一个简单的遍历链表的功能。下面是一个简单的遍历实现

package main

import (
	"container/list"
	"fmt"
)

func main() {
	link := list.New()

	for i := 0; i <= 10; i++ {
		link.PushBack(i)
	}

	for p := link.Front(); p != link.Back(); p = p.Next() {
		fmt.Println("Number", p.Value)
	}
}