Swift learning part 12 - 下标

下标可以定义在类、结构体和枚举中，是访问集合、列表或序列中元素的快捷方式。可以使用下标的索引设置和获取值，而不需要再调用对应的存取方法。

一个类型可以定义多个下标，通过不同索引类型进行重载，下标不限于一维，可以定义具有多个入参的下标。

下标语法

下标允许通过在实例名称后面的方括号中传入一个或多个索引值来对实例进行存取。定义下标使用 subscript 关键字，指定一个或多个输入参数和返回类型。与实例方法不同，下标可以设定为读写或只读，这种行为由 getter 和 setter 实现，类似计算型属性。

subscript(index: Int) -> Int {
    get {
        // 返回一个适当的 Int 类型的值
    }
    set(newValue) {
        // 执行适当的赋值操作
    }
}

newValue 的类型和下标的返回类型相同，可以不指定 setter 的参数(newValue)，不指定则默认为 newValue。

如同只读计算属性，可以省略只读下标的 get 关键字：

subscript(index: Int) -> Int {
    // 返回一个适当的 Int 类型的值
}

下面代码演示了只读下标的实现，这里定义一个 TimesTable 结构体，用来表示传入整数的乘法表：

struct TimesTable {
    let multiplier: Int
    subscript(index: Int) -> Int {
        return multiplier * index
    }
}
let threeTimesTable = TimesTable(multiplier: 3)
print("six times three is \(threeTimesTable[6])")
// 打印 "six times three is 18"

下标用法

下标的确切含义取决于使用场景。下标通常作为访问集合、列表或序列中元素的快捷方式。可以针对自己特定的类或结构体的功能来自由地以最恰当的方式实现下标。

例如，Swift 的 Dictionary 类型实现下标用于对其实例中储存的值进行存取操作。

var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
numberOfLegs["bird"] = 2

上例定义一个名为 numberOfLegs 的变量，并用一个包含三对键值的字典字面量初始化它。numberOfLegs 字典的类型被推断为 [String: Int]。字典创建完成后，该例子通过下标将 String 类型的键 bird 和 Int 类型的值 2 添加到字典中。

注意：
Swift 的Dictionary类型的下标接受并返回可选类型的值。上例中的numberOfLegs字典通过下标返回的是一个Int?或者说“可选的int”。Dictionary类型之所以如此实现下标，是因为不是每个键都有个对应的值，同时这也提供了一种通过键删除对应值的方式，只需将键对应的值赋值为nil即可。

下标选项

下标可以接受任意数量的入参，并且这些入参可以是任意类型，下标的返回值也可以是任意类型。下标可以使用可变参数，并且可以提供默认参数数值，但是不能使用输入输出参数。

一个类或结构体可以根据自身需要提供多个下标实现，使用下标时将通过入参的数量和类型进行区分，自动匹配合适的下标，这就是下标的重载。

如下定义一个 Matrix 结构体，用于表示一个 Double 类型的二维矩阵：

Matrix提供了一个接受两个入参的构造方法，入参分别是rows和columns，创建了一个足够容纳rows * columns个Double类型的值的数组。通过传入数组长度和初始值0.0到数组的构造器，将矩阵中每个位置的值初始化为0.0。

struct Matrix {
    let rows: Int, columns: Int
    var grid: [Double]
    
    init(rows: Int, columns: Int) {
        self.rows = rows
        self.columns = columns
        grid = Array.init(repeating: 0.0, count: rows * columns)
    }
        
    /// 判断下标是否越界
    func indexIsValid(row: Int, column: Int) -> Bool {
        return row >= 0 && row < rows && column >= 0 && column < columns
    }
    
    subscript(row: Int, column: Int) -> Double {
        get {
            assert(indexIsValid(row: row, column: column), "Index out of range")
            return grid[(row * columns) + column]
        }
        set {
            assert(indexIsValid(row: row, column: column), "Index out of range")
            grid[(row * columns) + column] = newValue
        }
    }
}

可以通过传入合适的row和column的数量来构造一个新的Matrix实例：

var matrix = Matrix(rows: 2, columns: 2)

将row和column的值传入下标来为矩阵设值，下标的入参使用逗号分隔：

matrix[0, 1] = 1.5
matrix[1, 0] = 3.2

Matrix下标的 getter 和 setter 中都含有断言，用来检查下标入参row和column的值是否有效。

断言在下标越界时触发：

let someValue = matrix[2, 2] 
// 断言将会触发，因为 [2, 2] 已经超过了 matrix 的范围

类型下标

实例下标是在特定类型的一个实例上调用的下标，你也可以定义一种在这个类型本身上调用的下标，这种下标的类型被称作类型下标。你可以通过在 subscript 关键字之前写下 static 关键字的方式来表示一个类型下标。类可以使用 class 关键字来允许子类重写父类中对那个下标的实现。

下面的例子展示了如何定义和调用一个类型下标：

enum Planet: Int {
    case mercury = 1, venus, earth, mars, jupiter, saturn, uranus, neptune
    static subscript(n: Int) -> Planet { 
    // 作者实际 coding 时报错："Subscript cannot be marked 'static'"
        return Planet(rawValue: n)!
    }
}
let mars = Planet[4]
print(mars)