Go标准容器之Ring

简介

Go的标准包Container中包含了常用的容器类型，包括conatiner/list，container/heap，container/ring，本篇讲解container/ring的使用。

ring包

ring包提供了环形链表的操作。它仅导出了一个类型，Ring：

// Ring表示环形链表中的元素。
type Ring struct {
    Value interface{} // Value类型为interface{}，因此可以接受任意类型
}

// 创建一个长度为n的环形链表
func New(n int) *Ring
// 针对环形链表中的每一个元素x进行f(x)操作
func (r *Ring) Do(f func(interface{}))
// 获取环形链表长度
func (r *Ring) Len() int
// 如果r和s在同一环形链表中，则删除r和s之间的元素，
// 被删除的元素组成一个新的环形链表，返回值为该环形链表的指针（即删除前，r->Next()表示的元素）
// 如果r和s不在同一个环形链表中，则将s插入到r后面，返回值为
// 插入s后，s最后一个元素的下一个元素（即插入前，r->Next()表示的元素）
func (r *Ring) Link(s *Ring) *Ring
// 移动 n % r.Len() 个位置，n正负均可
func (r *Ring) Move(n int) *Ring
// 返回下一个元素
func (r *Ring) Next() *Ring
// 返回前一个元素
func (r *Ring) Prev() *Ring
// 删除r后面的 n % r.Len() 个元素
func (r *Ring) Unlink(n int) *Ring

示例

Ring的用法

package main

import (
    "container/ring"
    "fmt"
)

func main() {

    const rLen = 3

    // 创建新的Ring
    r := ring.New(rLen)

    for i := 0; i < rLen; i++ {
        r.Value = i
        r = r.Next()
    }

    fmt.Printf("Length of ring: %d\n", r.Len()) // Length of ring: 3

    // 该匿名函数用来打印Ring中的数据
    printRing := func(v interface{}) {
        fmt.Print(v, " ")
    }

    r.Do(printRing) // 0 1 2
    fmt.Println()

    // 将r之后的第二个元素的值乘以2
    r.Move(2).Value = r.Move(2).Value.(int) * 2

    r.Do(printRing) // 0 1 4
    fmt.Println()

    // 删除 r 与 r+2 之间的元素，即删除 r+1
    // 返回删除的元素组成的Ring的指针
    result := r.Link(r.Move(2))

    r.Do(printRing) // 0 4
    fmt.Println()

    result.Do(printRing) // 1
    fmt.Println()

    another := ring.New(rLen)
    another.Value = 7
    another.Next().Value = 8 // 给 another + 1 表示的元素赋值，即第二个元素
    another.Prev().Value = 9 // 给 another - 1 表示的元素赋值，即第三个元素

    another.Do(printRing) // 7 8 9
    fmt.Println()

    // 插入another到r后面，返回插入前r的下一个元素
    result = r.Link(another)

    r.Do(printRing) // 0 7 8 9 4
    fmt.Println()

    result.Do(printRing) // 4 0 7 8 9
    fmt.Println()

    // 删除r之后的三个元素，返回被删除元素组成的Ring的指针
    result = r.Unlink(3)

    r.Do(printRing) // 0 4
    fmt.Println()

    result.Do(printRing) // 7 8 9
    fmt.Println()
}

模拟约瑟夫问题

环形列表可以模拟约瑟夫问题。约瑟夫问题描述如下：

来自百度：
据说著名犹太历史学家 Josephus有过以下的故事：在罗马人占领乔塔帕特后，39 个犹太人与Josephus及他的朋友躲到一个洞中，39个犹太人决定宁愿死也不要被敌人抓到，于是决定了一个自杀方式，41个人排成一个圆圈，由第1个人开始报数，每报数到第3人该人就必须自杀，然后再由下一个重新报数，直到所有人都自杀身亡为止。然而Josephus 和他的朋友并不想遵从。首先从一个人开始，越过k-2个人（因为第一个人已经被越过），并杀掉第k个人。接着，再越过k-1个人，并杀掉第k个人。这个过程沿着圆圈一直进行，直到最终只剩下一个人留下，这个人就可以继续活着。问题是，给定了和，一开始要站在什么地方才能避免被处决？Josephus要他的朋友先假装遵从，他将朋友与自己安排在第16个与第31个位置，于是逃过了这场死亡游戏。

用代码模拟如下：

package main

import (
    "container/ring"
    "fmt"
)

type Player struct {
    position int  // 位置
    alive    bool // 是否存活
}

func main() {

    const (
        playerCount = 41  // 玩家人数
        startPos    = 1  // 开始报数位置
    )

    deadline := 3

    r := ring.New(playerCount)

    // 设置所有玩家初始值
    for i := 1; i <= playerCount; i++ {
        r.Value = &Player{i, true}
        r = r.Next()
    }

    // 如果开始报数的位置不为1，则设置开始位置
    if startPos > 1 {
        r = r.Move(startPos - 1)
    }

    counter := 1  // 报数从1开始，因为下面的循环从第二个开始计算
    deadCount := 0  // 死亡人数，初始值为0

    for deadCount < playerCount {  // 直到所有人都死亡，否则循环一直执行
        r = r.Next() // 跳到下一个人

        // 如果是活着的人，则报数
        if r.Value.(*Player).alive {
            counter++
        }

        // 如果报数为deadline，则此人淘汰出局
        if counter == deadline {
            r.Value.(*Player).alive = false
            fmt.Printf("Player %d died!\n", r.Value.(*Player).position)
            deadCount++

            counter = 0  // 报数置成0
        }
    }
}

输出如下，可以看到16和31是最后两个出队列的，因此Josephus将他的朋友与自己安排在第16个与第31个位置是安全的。

Player 3 died!
Player 6 died!
Player 9 died!
Player 12 died!
Player 15 died!
Player 18 died!
Player 21 died!
Player 24 died!
Player 27 died!
Player 30 died!
Player 33 died!
Player 36 died!
Player 39 died!
Player 1 died!
Player 5 died!
Player 10 died!
Player 14 died!
Player 19 died!
Player 23 died!
Player 28 died!
Player 32 died!
Player 37 died!
Player 41 died!
Player 7 died!
Player 13 died!
Player 20 died!
Player 26 died!
Player 34 died!
Player 40 died!
Player 8 died!
Player 17 died!
Player 29 died!
Player 38 died!
Player 11 died!
Player 25 died!
Player 2 died!
Player 22 died!
Player 4 died!
Player 35 died!
Player 16 died!
Player 31 died!