13.3. 下标选项

下标可以接受任意数量的入参,并且这些入参可以是任何类型。下标的返回值也可以是任意类型。

与函数一样,下标可以接受不同数量的参数,并且为这些参数提供默认值,如在 可变参数默认参数值 中所述。但是,与函数不同的是,下标不能使用 in-out 参数。

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

虽然接受单一入参的下标是最常见的,但也可以根据情况定义接受多个入参的下标。例如下例定义了一个 Matrix 结构体,用于表示一个 Double 类型的二维矩阵。Matrix 结构体的下标接受两个整型参数:

struct Matrix {
    let rows: Int, columns: Int
    var grid: [Double]
    init(rows: Int, columns: Int) {
        self.rows = rows
        self.columns = columns
        grid = Array(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
        }
    }
}

Matrix 提供了一个接受两个入参的构造方法,入参分别是 rowscolumns,创建了一个足够容纳 rows * columnsDouble 类型的值的数组。通过传入数组长度和初始值 0.0 到数组的构造器,将矩阵中每个位置的值初始化为 0.0。关于数组的这种构造方法请参考 创建一个带有默认值的

你可以通过传入合适的 rowcolumn 数值来构造一个新的 Matrix 实例:

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

上例中创建了一个两行两列的 Matrix 实例。该 Matrix 实例的 grid 数组按照从左上到右下的阅读顺序将矩阵扁平化存储:

rowcolumn 的值传入下标来为矩阵设值,下标的入参使用逗号分隔:

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

上面两条语句分别调用下标的 setter 将矩阵右上角位置(即 row0column1 的位置)的值设置为 1.5,将矩阵左下角位置(即 row1column0 的位置)的值设置为 3.2

Matrix 下标的 getter 和 setter 中都含有断言,用来检查下标入参 rowcolumn 的值是否有效。为了方便进行断言,Matrix 包含了一个名为 indexIsValid(row:column:) 的便利方法,用来检查入参 rowcolumn 的值是否在矩阵范围内:

func indexIsValid(row: Int, column: Int) -> Bool {
    return row >= 0 && row < rows && column >= 0 && column < columns
}

断言在下标越界时触发:

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