Golang标准库：sort包—— 排序算法

た入场券 2024-02-18 09:07 53阅读 0赞

## 3.1 sort —— 排序算法 ##

该包实现了四种基本排序算法：插入排序、归并排序、堆排序和快速排序。  
但是这四种排序方法是不公开的，它们只被用于 sort 包内部使用。所以在对数据集合排序时不必考虑应当选择哪一种排序方法，只要实现了 sort.Interface 定义的三个方法：获取数据集合长度的 Len() 方法、比较两个元素大小的 Less() 方法和交换两个元素位置的 Swap() 方法，就可以顺利对数据集合进行排序。sort 包会根据实际数据自动选择高效的排序算法。  
除此之外，为了方便对常用数据类型的操作，sort 包提供了对\[\]int 切片、\[\]float64 切片和\[\]string 切片完整支持，主要包括：

*  对基本数据类型切片的排序支持
 *  基本数据元素查找
 *  判断基本数据类型切片是否已经排好序
 *  对排好序的数据集合逆序

### 3.1.1 数据集合排序 ###

前面已经提到过，对数据集合（包括自定义数据类型的集合）排序需要实现 sort.Interface 接口的三个方法，我们看以下该接口的定义：

type Interface interface {
        
    		// 获取数据集合元素个数
    		Len() int
    		// 如果 i 索引的数据小于 j 索引的数据，返回 true，且不会调用下面的 Swap()，即数据升序排序。
    		Less(i, j int) bool
    		// 交换 i 和 j 索引的两个元素的位置
            Swap(i, j int)
    }

数据集合实现了这三个方法后，即可调用该包的 Sort() 方法进行排序。  
Sort() 方法定义如下：

func Sort(data Interface)

Sort() 方法惟一的参数就是待排序的数据集合。

该包还提供了一个方法可以判断数据集合是否已经排好顺序，该方法的内部实现依赖于我们自己实现的 Len() 和 Less() 方法：

func IsSorted(data Interface) bool {
        
        n := data.Len()
        for i := n - 1; i > 0; i-- {
        
            if data.Less(i, i-1) {
        
                return false
            }
        }
        return true
    }

下面是一个使用 sort 包对学生成绩排序的示例：

package main
    
    import (
    	"fmt"
    	"sort"
    )
    
    // 学生成绩结构体
    type StuScore struct {
        
        name  string    // 姓名
        score int   // 成绩
    }
    
    type StuScores []StuScore
    
    //Len()
    func (s StuScores) Len() int {
        
    	return len(s)
    }
    
    //Less(): 成绩将有低到高排序
    func (s StuScores) Less(i, j int) bool {
        
    	return s[i].score < s[j].score
    }
    
    //Swap()
    func (s StuScores) Swap(i, j int) {
        
    	s[i], s[j] = s[j], s[i]
    }
    
    func main() {
        
        stus := StuScores{
        
                    {
        "alan", 95},
                    {
        "hikerell", 91},
                    {
        "acmfly", 96},
                    {
        "leao", 90},
    				}
    				
    	// 打印未排序的 stus 数据
        fmt.Println("Default:\n\t",stus)
        //StuScores 已经实现了 sort.Interface 接口 , 所以可以调用 Sort 函数进行排序
    	sort.Sort(stus)
    	// 判断是否已经排好顺序，将会打印 true
    	fmt.Println("IS Sorted?\n\t", sort.IsSorted(stus))
    	// 打印排序后的 stus 数据
        fmt.Println("Sorted:\n\t",stus)
    }

该示例程序的自定义类型 StuScores 实现了 sort.Interface 接口，所以可以将其对象作为 sort.Sort() 和 sort.IsSorted() 的参数传入。运行结果：

Default:
         [{
        alan 95} {
        hikerell 91} {
        acmfly 96} {
        leao 90}]
    IS Sorted?
         true
    Sorted:
         [{
        leao 90} {
        hikerell 91} {
        alan 95} {
        acmfly 96}]

该示例实现的是升序排序，如果要得到降序排序结果，其实只要修改 Less() 函数：

//Less(): 成绩降序排序 , 只将小于号修改为大于号
    func (s StuScores) Less(i, j int) bool {
        
    	return s[i].score > s[j].score
    }

此外，*sort*包提供了 Reverse() 方法，可以允许将数据按 Less() 定义的排序方式逆序排序，而不必修改 Less() 代码。方法定义如下：

func Reverse(data Interface) Interface

我们可以看到 Reverse() 返回的一个 sort.Interface 接口类型，整个 Reverse() 的内部实现比较有趣：

// 定义了一个 reverse 结构类型，嵌入 Interface 接口
    type reverse struct {
        
        Interface
    }
    
    //reverse 结构类型的 Less() 方法拥有嵌入的 Less() 方法相反的行为
    //Len() 和 Swap() 方法则会保持嵌入类型的方法行为
    func (r reverse) Less(i, j int) bool {
        
        return r.Interface.Less(j, i)
    }
    
    // 返回新的实现 Interface 接口的数据类型
    func Reverse(data Interface) Interface {
        
        return &reverse{
        data}
    }

了解内部原理后，可以在学生成绩排序示例中使用 Reverse() 来实现成绩升序排序：

sort.Sort(sort.Reverse(stus))
    fmt.Println(stus)

最后一个方法：Search()

func Search(n int, f func(int) bool) int

> 该方法会使用“二分查找”算法来找出能使 f(x)(0<=x<n) 返回 ture 的最小值 i。  
> 前提条件 : f(x)(0<=x<i) 均返回 false, f(x)(i<=x<n) 均返回 ture。  
> 如果不存在 i 可以使 f(i) 返回 ture, 则返回 n。

Search() 函数一个常用的使用方式是搜索元素 x 是否在已经升序排好的切片 s 中：

x := 11
    s := []int{
        3, 6, 8, 11, 45} // 注意已经升序排序
    pos := sort.Search(len(s), func(i int) bool {
         return s[i] >= x })
    if pos < len(s) && s[pos] == x {
        
        fmt.Println(x, " 在 s 中的位置为：", pos)
    } else {
        
        fmt.Println("s 不包含元素 ", x)
    }

官方文档还给出了一个猜数字的小程序：

func GuessingGame() {
        
    	var s string
    	fmt.Printf("Pick an integer from 0 to 100.\n")
    	answer := sort.Search(100, func(i int) bool {
        
    		fmt.Printf("Is your number <= %d? ", i)
    		fmt.Scanf("%s", &s)
    		return s != "" && s[0] == 'y'
    	})
    	fmt.Printf("Your number is %d.\n", answer)
    }

### 3.1.2 *sort*包已经支持的内部数据类型排序 ###

前面已经提到，*sort*包原生支持\[\]int、\[\]float64 和\[\]string 三种内建数据类型切片的排序操作，即不必我们自己实现相关的 Len()、Less() 和 Swap() 方法。

**1. IntSlice 类型及\[\]int 排序**

由于\[\]int 切片排序内部实现及使用方法与\[\]float64 和\[\]string 类似，所以只详细描述该部分。

*sort*包定义了一个 IntSlice 类型，并且实现了 sort.Interface 接口：

type IntSlice []int
    func (p IntSlice) Len() int           {
         return len(p) }
    func (p IntSlice) Less(i, j int) bool {
         return p[i] < p[j] }
    func (p IntSlice) Swap(i, j int)      {
         p[i], p[j] = p[j], p[i] }
    //IntSlice 类型定义了 Sort() 方法，包装了 sort.Sort() 函数
    func (p IntSlice) Sort() {
         Sort(p) }
    //IntSlice 类型定义了 SearchInts() 方法，包装了 SearchInts() 函数
    func (p IntSlice) Search(x int) int {
         return SearchInts(p, x) }

并且提供的 sort.Ints() 方法使用了该 IntSlice 类型：

func Ints(a []int) {
         Sort(IntSlice(a)) }

所以，对\[\]int 切片排序更常使用 sort.Ints()，而不是直接使用 IntSlice 类型：

s := []int{
        5, 2, 6, 3, 1, 4} // 未排序的切片数据
    sort.Ints(s)
    fmt.Println(s) // 将会输出[1 2 3 4 5 6]

如果要使用降序排序，显然要用前面提到的 Reverse() 方法：

s := []int{
        5, 2, 6, 3, 1, 4} // 未排序的切片数据
    sort.Sort(sort.Reverse(sort.IntSlice(s)))
    fmt.Println(s) // 将会输出[6 5 4 3 2 1]

如果要查找整数 x 在切片 a 中的位置，相对于前面提到的 Search() 方法，*sort*包提供了 SearchInts():

func SearchInts(a []int, x int) int

注意，SearchInts() 的使用条件为：**切片 a 已经升序排序** 以下是一个错误使用的例子：

s := []int{
        5, 2, 6, 3, 1, 4} // 未排序的切片数据
    fmt.Println(sort.SearchInts(s, 2)) // 将会输出 0 而不是 1

**2. Float64Slice 类型及\[\]float64 排序**

实现与 Ints 类似，只看一下其内部实现：

type Float64Slice []float64
    
    func (p Float64Slice) Len() int           {
         return len(p) }
    func (p Float64Slice) Less(i, j int) bool {
         return p[i] < p[j] || isNaN(p[i]) && !isNaN(p[j]) }
    func (p Float64Slice) Swap(i, j int)      {
         p[i], p[j] = p[j], p[i] }
    func (p Float64Slice) Sort() {
         Sort(p) }
    func (p Float64Slice) Search(x float64) int {
         return SearchFloat64s(p, x) }

与 Sort()、IsSorted()、Search() 相对应的三个方法：

func Float64s(a []float64)  
    func Float64sAreSorted(a []float64) bool
    func SearchFloat64s(a []float64, x float64) int

要说明一下的是，在上面 Float64Slice 类型定义的 Less 方法中，有一个内部函数 isNaN()。  
isNaN() 与*math*包中 IsNaN() 实现完全相同，*sort*包之所以不使用 math.IsNaN()，完全是基于包依赖性的考虑，应当看到，*sort*包的实现不依赖与其他任何包。

**3. StringSlice 类型及\[\]string 排序**

两个 string 对象之间的大小比较是基于“字典序”的。

实现与 Ints 类似，只看一下其内部实现：

type StringSlice []string
    
    func (p StringSlice) Len() int           {
         return len(p) }
    func (p StringSlice) Less(i, j int) bool {
         return p[i] < p[j] }
    func (p StringSlice) Swap(i, j int)      {
         p[i], p[j] = p[j], p[i] }
    func (p StringSlice) Sort() {
         Sort(p) }
    func (p StringSlice) Search(x string) int {
         return SearchStrings(p, x) }

与 Sort()、IsSorted()、Search() 相对应的三个方法：

func Strings(a []string)
    func StringsAreSorted(a []string) bool
    func SearchStrings(a []string, x string) int

### 3.1.3 \[\]interface 排序与查找 ###

通过前面的内容我们可以知道，只要实现了 `sort.Interface` 接口，即可通过 sort 包内的函数完成排序，查找等操作。并且 sort 包已经帮我们把`[]int`,`[]float64`,`[]string` 三种类型都实现了该接口，我们可以方便的调用。但是这种用法对于其它数据类型的 slice 不友好，可能我们需要为大量的 struct 定义一个单独的 \[\]struct 类型，再为其实现 `sort.Interface` 接口，类似这样：

type Person struct {
        
        Name string
        Age  int
    }
    type Persons []Person
    
    func (p Persons) Len() int {
        
        panic("implement me")
    }
    
    func (p Persons) Less(i, j int) bool {
        
        panic("implement me")
    }
    
    func (p Persons) Swap(i, j int) {
        
        panic("implement me")
    }

> 思考一个问题：为什么 sort 包可以完成 `[]int` 的排序，而不能完成 `[]struct` 的排序？

因为排序涉及到比较两个变量的值，而 struct 可能包含多个属性，程序并不知道你想以哪一个属性或哪几个属性作为衡量大小的标准。如果你能帮助程序完成比较，并将结果返回， sort 包内的方法就可以完成排序，判断，查找等。sort 包提供了以下函数：

func Slice(slice interface{
        }, less func(i, j int) bool) 
    func SliceStable(slice interface{
        }, less func(i, j int) bool) 
    func SliceIsSorted(slice interface{
        }, less func(i, j int) bool) bool 
    func Search(n int, f func(int) bool) int

通过函数签名可以看到，排序相关的三个函数都接收 `[]interface`，并且需要传入一个比较函数，用于为程序比较两个变量的大小，因为函数签名和作用域的原因，这个函数只能是 `匿名函数`。

**1. sort.Slice**

该函数完成 \[\]interface 的排序，举个栗子：

people := []struct {
        
    	Name string
    	Age  int
    }{
        
    	{
        "Gopher", 7},
    	{
        "Alice", 55},
    	{
        "Vera", 24},
    	{
        "Bob", 75},
    }
    
    sort.Slice(people, func(i, j int) bool {
         return people[i].Age < people[j].Age }) // 按年龄升序排序
    fmt.Println("Sort by age:", people)

输出结果：

By age: [{
        Gopher 7} {
        Vera 24} {
        Alice 55} {
        Bob 75}]

**2. sort.SliceStable**

该函数完成 \[\]interface 的稳定排序，举个栗子：

people := []struct {
        
    	Name string
    	Age  int
    }{
        
    	{
        "Gopher", 7},
    	{
        "Alice", 55},
    	{
        "Vera", 24},
    	{
        "Bob", 75},
    }
    
    sort.SliceStable(people, func(i, j int) bool {
         return people[i].Age > people[j].Age }) // 按年龄降序排序
    fmt.Println("Sort by age:", people)

输出结果：

By age: [{
        Bob 75} {
        Alice 55} {
        Vera 24} {
        Gopher 7}]

**3. sort.SliceIsSorted**

该函数判断 \[\]interface 是否为有序，举个栗子：

people := []struct {
        
        Name string
        Age  int
    }{
        
        {
        "Gopher", 7},
        {
        "Alice", 55},
        {
        "Vera", 24},
        {
        "Bob", 75},
    }
    
    sort.Slice(people, func(i, j int) bool {
         return people[i].Age > people[j].Age }) // 按年龄降序排序
    fmt.Println("Sort by age:", people)
    fmt.Println("Sorted:",sort.SliceIsSorted(people,func(i, j int) bool {
         return people[i].Age < people[j].Age }))

输出结果：

Sort by age: [{
        Bob 75} {
        Alice 55} {
        Vera 24} {
        Gopher 7}]
    Sorted: false

sort 包没有为 \[\]interface 提供反序函数，但是从 1 和 2 可以看出，我们传入的比较函数已经决定了排序结果是升序还是降序。

判断 slice 是否为有序，同样取决于我们传入的比较函数，从 3 可以看出，虽然 slice 已经按年龄降序排序，但我们在判断 slice 是否为有序时给的比较函数是判断其是否为升序有序，所以最终得到的结果为 false。

**4. sort.Search**

该函数判断 \[\]interface 是否存在指定元素，举个栗子：

*  升序 slice

sort 包为 `[]int`,`[]float64`,`[]string` 提供的 Search 函数其实也是调用的该函数，因为该函数是使用的二分查找法，所以要求 slice 为升序排序状态。并且判断条件必须为 `>=`，这也是官方库提供的三个查找相关函数的的写法。

举个栗子：

a := []int{
        2, 3, 4, 200, 100, 21, 234, 56}
    x := 21
    
    sort.Slice(a, func(i, j int) bool {
         return a[i] < a[j] })   // 升序排序
    index := sort.Search(len(a), func(i int) bool {
         return a[i] >= x }) // 查找元素
    
    if index < len(a) && a[index] == x {
        
    	fmt.Printf("found %d at index %d in %v\n", x, index, a)
    } else {
        
    	fmt.Printf("%d not found in %v,index:%d\n", x, a, index)
    }

输出结果：

found 21 at index 3 in [2 3 4 21 56 100 200 234]

*  降序 slice

如果 slice 是降序状态，而我们又不想将其变为升序，只需将判断条件由 `>=` 变更为 `<=` 即可。此处就不给代码了，有兴趣的同学可以自己去尝试一下。推荐采用升序排列及相应的判断条件，与官方函数保持风格一致。