栈和队列

一、栈 Stack 和队列 Queue

我们日常生活中，都需要将物品排列，或者安排事情的先后顺序。更通俗地讲，我们买东西时，人太多的情况下，我们要排队，排队也有先后顺序，有些人早了点来，排完队就离开了，有些人晚一点，才刚刚进去人群排队。

数据是有顺序的，从数据 1 到数据 2，再到数据 3，和日常生活一样，我们需要放数据，也需要排列数据。

在计算机的世界里，会经常听见两种结构，栈（stack） 和 队列 (queue)。它们是一种收集数据的有序集合（Collection），只不过删除和访问数据的顺序不同。

  1. 栈：先进后出，先进队的数据最后才出来。在英文的意思里，stack 可以作为一叠的意思，这个排列是垂直的，你将一张纸放在另外一张纸上面，先放的纸肯定是最后才会被拿走，因为上面有一张纸挡住了它。
  2. 队列：先进先出，先进队的数据先出来。在英文的意思里，queue 和现实世界的排队意思一样，这个排列是水平的，先排先得。

我们可以用数据结构：链表（可连续或不连续的将数据与数据关联起来的结构），或 数组（连续的内存空间，按索引取值） 来实现 栈（stack） 和 队列 (queue)。

数组实现：能快速随机访问存储的元素，通过下标 index 访问，支持随机访问，查询速度快，但存在元素在数组空间中大量移动的操作，增删效率低。

链表实现：只支持顺序访问，在某些遍历操作中查询速度慢，但增删元素快。

二、实现数组栈 ArrayStack

数组形式的下压栈，后进先出:

主要使用可变长数组来实现。

  1. // 数组栈，后进先出
  2. type ArrayStack struct {
  3.     array []string   // 底层切片
  4.     size  int        // 栈的元素数量
  5.     lock  sync.Mutex // 为了并发安全使用的锁
  6. }

我们来分析它的各操作。

2.1.入栈

  1. // 入栈
  2. func (stack *ArrayStack) Push(v string) {
  3.     stack.lock.Lock()
  4.     defer stack.lock.Unlock()
  6.     // 放入切片中，后进的元素放在数组最后面
  7.     stack.array = append(stack.array, v)
  9.     // 栈中元素数量+1
  10.     stack.size = stack.size + 1
  11. }

将元素入栈，会先加锁实现并发安全。

入栈时直接把元素放在数组的最后面，然后元素数量加 1。性能损耗主要花在切片追加元素上，切片如果容量不够会自动扩容，底层损耗的复杂度我们这里不计，所以时间复杂度为 O(1)。

2.2.出栈

  1. func (stack *ArrayStack) Pop() string {
  2.     stack.lock.Lock()
  3.     defer stack.lock.Unlock()
  5.     // 栈中元素已空
  6.     if stack.size == 0 {
  7.         panic("empty")
  8.     }
  10.     // 栈顶元素
  11.     v := stack.array[stack.size-1]
  13.     // 切片收缩，但可能占用空间越来越大
  14.     //stack.array = stack.array[0 : stack.size-1]
  16.     // 创建新的数组，空间占用不会越来越大，但可能移动元素次数过多
  17.     newArray := make([]string, stack.size-1, stack.size-1)
  18.     for i := 0; i < stack.size-1; i++ {
  19.         newArray[i] = stack.array[i]
  20.     }
  21.     stack.array = newArray
  23.     // 栈中元素数量-1
  24.     stack.size = stack.size - 1
  25.     return v
  26. }

元素出栈，会先加锁实现并发安全。

如果栈大小为0，那么不允许出栈，否则从数组的最后面拿出元素。

元素取出后:

  1. 如果切片偏移量向前移动 stack.array[0 : stack.size-1]，表明最后的元素已经不属于该数组了，数组变相的缩容了。此时，切片被缩容的部分并不会被回收，仍然占用着空间，所以空间复杂度较高，但操作的时间复杂度为：O(1)。
  2. 如果我们创建新的数组 newArray，然后把老数组的元素复制到新数组，就不会占用多余的空间，但移动次数过多，时间复杂度为：O(n)。

最后元素数量减一，并返回值。

2.3.获取栈顶元素

  1. // 获取栈顶元素
  2. func (stack *ArrayStack) Peek() string {
  3.     // 栈中元素已空
  4.     if stack.size == 0 {
  5.         panic("empty")
  6.     }
  8.     // 栈顶元素值
  9.     v := stack.array[stack.size-1]
  10.     return v
  11. }

获取栈顶元素，但不出栈。和出栈一样，时间复杂度为：O(1)。

2.4.获取栈大小和判定是否为空

  1. // 栈大小
  2. func (stack *ArrayStack) Size() int {
  3.     return stack.size
  4. }
  6. // 栈是否为空
  7. func (stack *ArrayStack) IsEmpty() bool {
  8.     return stack.size == 0
  9. }

一目了然，时间复杂度都是：O(1)。

2.5.示例

  1. func main() {
  2.     arrayStack := new(ArrayStack)
  3.     arrayStack.Push("cat")
  4.     arrayStack.Push("dog")
  5.     arrayStack.Push("hen")
  6.     fmt.Println("size:", arrayStack.Size())
  7.     fmt.Println("pop:", arrayStack.Pop())
  8.     fmt.Println("pop:", arrayStack.Pop())
  9.     fmt.Println("size:", arrayStack.Size())
  10.     arrayStack.Push("drag")
  11.     fmt.Println("pop:", arrayStack.Pop())
  12. }

输出：

  1. size: 3
  2. pop: hen
  3. pop: dog
  4. size: 1
  5. pop: drag

三、实现链表栈 LinkStack

链表形式的下压栈，后进先出：

  1. // 链表栈，后进先出
  2. type LinkStack struct {
  3.     root *LinkNode  // 链表起点
  4.     size int        // 栈的元素数量
  5.     lock sync.Mutex // 为了并发安全使用的锁
  6. }
  8. // 链表节点
  9. type LinkNode struct {
  10.     Next  *LinkNode
  11.     Value string
  12. }

我们来分析它的各操作。

3.1.入栈

  1. // 入栈
  2. func (stack *LinkStack) Push(v string) {
  3.     stack.lock.Lock()
  4.     defer stack.lock.Unlock()
  6.     // 如果栈顶为空，那么增加节点
  7.     if stack.root == nil {
  8.         stack.root = new(LinkNode)
  9.         stack.root.Value = v
  10.     } else {
  11.         // 否则新元素插入链表的头部
  12.         // 原来的链表
  13.         preNode := stack.root
  15.         // 新节点
  16.         newNode := new(LinkNode)
  17.         newNode.Value = v
  19.         // 原来的链表链接到新元素后面
  20.         newNode.Next = preNode
  22.         // 将新节点放在头部
  23.         stack.root = newNode
  24.     }
  26.     // 栈中元素数量+1
  27.     stack.size = stack.size + 1
  28. }

将元素入栈，会先加锁实现并发安全。

如果栈里面的底层链表为空，表明没有元素，那么新建节点并设置为链表起点：stack.root = new(LinkNode)。

否则取出老的节点：preNode := stack.root，新建节点：newNode := new(LinkNode)，然后将原来的老节点链接在新节点后面： newNode.Next = preNode，最后将新节点设置为链表起点 stack.root = newNode。

时间复杂度为：O(1)。

3.2.出栈

  1. // 出栈
  2. func (stack *LinkStack) Pop() string {
  3.     stack.lock.Lock()
  4.     defer stack.lock.Unlock()
  6.     // 栈中元素已空
  7.     if stack.size == 0 {
  8.         panic("empty")
  9.     }
  11.     // 顶部元素要出栈
  12.     topNode := stack.root
  13.     v := topNode.Value
  15.     // 将顶部元素的后继链接链上
  16.     stack.root = topNode.Next
  18.     // 栈中元素数量-1
  19.     stack.size = stack.size - 1
  21.     return v
  22. }

元素出栈。如果栈大小为0，那么不允许出栈。

直接将链表的第一个节点 topNode := stack.root 的值取出，然后将表头设置为链表的下一个节点：stack.root = topNode.Next，相当于移除了链表的第一个节点。

时间复杂度为：O(1)。

3.3.获取栈顶元素

  1. // 获取栈顶元素
  2. func (stack *LinkStack) Peek() string {
  3.     // 栈中元素已空
  4.     if stack.size == 0 {
  5.         panic("empty")
  6.     }
  8.     // 顶部元素值
  9.     v := stack.root.Value
  10.     return v
  11. }

获取栈顶元素，但不出栈。和出栈一样，时间复杂度为：O(1)。

3.4.获取栈大小和判定是否为空

  1. // 栈大小
  2. func (stack *LinkStack) Size() int {
  3.     return stack.size
  4. }
  6. // 栈是否为空
  7. func (stack *LinkStack) IsEmpty() bool {
  8.     return stack.size == 0
  9. }

3.5.示例

  1. func main() {
  2.     linkStack := new(LinkStack)
  3.     linkStack.Push("cat")
  4.     linkStack.Push("dog")
  5.     linkStack.Push("hen")
  6.     fmt.Println("size:", linkStack.Size())
  7.     fmt.Println("pop:", linkStack.Pop())
  8.     fmt.Println("pop:", linkStack.Pop())
  9.     fmt.Println("size:", linkStack.Size())
  10.     linkStack.Push("drag")
  11.     fmt.Println("pop:", linkStack.Pop())
  12. }

输出：

  1. size: 3
  2. pop: hen
  3. pop: dog
  4. size: 1
  5. pop: drag

四、实现数组队列 ArrayQueue

队列先进先出，和栈操作顺序相反，我们这里只实现入队，和出队操作，其他操作和栈一样。

  1. // 数组队列，先进先出
  2. type ArrayQueue struct {
  3.     array []string   // 底层切片
  4.     size  int        // 队列的元素数量
  5.     lock  sync.Mutex // 为了并发安全使用的锁
  6. }

4.1.入队

  1. // 入队
  2. func (queue *ArrayQueue) Add(v string) {
  3.     queue.lock.Lock()
  4.     defer queue.lock.Unlock()
  6.     // 放入切片中，后进的元素放在数组最后面
  7.     queue.array = append(queue.array, v)
  9.     // 队中元素数量+1
  10.     queue.size = queue.size + 1
  11. }

直接将元素放在数组最后面即可，和栈一样，时间复杂度为：O(n)。

4.2.出队

  1. // 出队
  2. func (queue *ArrayQueue) Remove() string {
  3.     queue.lock.Lock()
  4.     defer queue.lock.Unlock()
  6.     // 队中元素已空
  7.     if queue.size == 0 {
  8.         panic("empty")
  9.     }
  11.     // 队列最前面元素
  12.     v := queue.array[0]
  14.     /*    直接原位移动，但缩容后继的空间不会被释放
  15.         for i := 1; i < queue.size; i++ {
  16.             // 从第一位开始进行数据移动
  17.             queue.array[i-1] = queue.array[i]
  18.         }
  19.         // 原数组缩容
  20.         queue.array = queue.array[0 : queue.size-1]
  21.     */
  23.     // 创建新的数组，移动次数过多
  24.     newArray := make([]string, queue.size-1, queue.size-1)
  25.     for i := 1; i < queue.size; i++ {
  26.         // 从老数组的第一位开始进行数据移动
  27.         newArray[i-1] = queue.array[i]
  28.     }
  29.     queue.array = newArray
  31.     // 队中元素数量-1
  32.     queue.size = queue.size - 1
  33.     return v
  34. }

出队，把数组的第一个元素的值返回，并对数据进行空间挪位，挪位有两种：

  1. 原地挪位，依次补位 queue.array[i-1] = queue.array[i]，然后数组缩容：queue.array = queue.array[0 : queue.size-1]，但是这样切片缩容的那部分内存空间不会释放。
  2. 创建新的数组，将老数组中除第一个元素以外的元素移动到新数组。

时间复杂度是：O(n)。

五、实现链表队列 LinkQueue

队列先进先出，和栈操作顺序相反，我们这里只实现入队，和出队操作，其他操作和栈一样。

  1. // 链表队列，先进先出
  2. type LinkQueue struct {
  3.     root *LinkNode  // 链表起点
  4.     size int        // 队列的元素数量
  5.     lock sync.Mutex // 为了并发安全使用的锁
  6. }
  8. // 链表节点
  9. type LinkNode struct {
  10.     Next  *LinkNode
  11.     Value string
  12. }

5.1.入队

  1. // 入队
  2. func (queue *LinkQueue) Add(v string) {
  3.     queue.lock.Lock()
  4.     defer queue.lock.Unlock()
  6.     // 如果栈顶为空，那么增加节点
  7.     if queue.root == nil {
  8.         queue.root = new(LinkNode)
  9.         queue.root.Value = v
  10.     } else {
  11.         // 否则新元素插入链表的末尾
  12.         // 新节点
  13.         newNode := new(LinkNode)
  14.         newNode.Value = v
  16.         // 一直遍历到链表尾部
  17.         nowNode := queue.root
  18.         for nowNode.Next != nil {
  19.             nowNode = nowNode.Next
  20.         }
  22.         // 新节点放在链表尾部
  23.         nowNode.Next = newNode
  24.     }
  26.     // 队中元素数量+1
  27.     queue.size = queue.size + 1
  28. }

将元素放在链表的末尾，所以需要遍历链表，时间复杂度为：O(n)。

5.2.出队

  1. // 出队
  2. func (queue *LinkQueue) Remove() string {
  3.     queue.lock.Lock()
  4.     defer queue.lock.Unlock()
  6.     // 队中元素已空
  7.     if queue.size == 0 {
  8.         panic("empty")
  9.     }
  11.     // 顶部元素要出队
  12.     topNode := queue.root
  13.     v := topNode.Value
  15.     // 将顶部元素的后继链接链上
  16.     queue.root = topNode.Next
  18.     // 队中元素数量-1
  19.     queue.size = queue.size - 1
  21.     return v
  22. }

链表第一个节点出队即可，时间复杂度为：O(1)。

附录

代码下载： https://github.com/hunterhug/goa.c/blob/master/code/stack/main.go 。