12 Subscripts 下标

类、结构和枚举可以定义下标，下标是访问集合、列表或序列的成员元素的快捷方式。您可以使用下标按索引设置和检索值，而不需要单独的设置和检索方法。例如，以someArray[index]访问数组实例中的元素，以someDictionary[key]访问Dictionary实例中的元素。

您可以为单个类型定义多个下标，并根据传递给下标的索引值的类型选择要使用的适当下标重载。下标不限于单个维度，您可以使用多个输入参数定义下标，以满足自定义类型的需要。

Subscript Syntax 下标语法

下标使您能够通过在实例名称后面的方括号中写入一个或多个值来查询类型的实例。它们的语法类似于实例方法语法和计算属性语法。使用下标关键字编写下标定义，并以与实例方法相同的方式指定一个或多个输入参数和返回类型。与实例方法不同，下标可以是可读写的，也可以是只读的。
此行为由getter和setter以与计算属性相同的方式进行通信:

subscript(index: Int) -> Int {
    get {
        // return an appropriate subscript value here
    }
    set(newValue) {
        // perform a suitable setting action here
    }
}

newValue的类型与下标的返回值相同。与计算属性一样，可以选择不指定setter的(newValue)参数。如果您自己没有提供一个名为newValue的默认参数，则会将其提供给setter。

与只读计算属性一样，可以通过删除get关键字及其大括号简化只读下标的声明:

subscript(index: Int) -> Int {
    // return an appropriate subscript value here
}

下面是一个只读下标实现的例子:

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

您可以通过调用它的下标来查询threeTimesTable实例，如调用threeTimesTable[6]所示。这将请求three-times表中的第6个条目，该条目返回一个值18，或者3乘以6。

Subscript Usage 下标的使用

“下标”的确切含义取决于使用它的上下文。
下标通常用作访问集合、列表或序列中的成员元素的快捷方式。您可以自由地以最适合您特定类或结构功能的方式实现下标。

例如，Swift的Dictionary类型实现一个下标来设置和检索Dictionary实例中存储的值。您可以通过在下标括号中提供字典的键类型的键来设置字典中的值，并将字典的值类型的值赋给下标:

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

上面的示例定义了一个名为numberOfLegs的变量，并用包含三个键值对的字典文本初始化它。numberOfLegs字典的类型被推断为[String: Int]。在创建字典之后，这个例子使用下标赋值向字典中添加一个字符串键“bird”和一个Int值2。

Swift的Dictionary类型将其键值下标实现为一个下标，它接受并返回一个可选类型。对于上面的numberOfLegs字典，键值下标接受并返回一个Int类型的值?，或“可选int”。Dictionary类型使用可选的下标类型来模拟并非每个键都有值这一事实，并通过为该键分配nil值来提供删除键值的方法。

Subscript Options

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

类或结构可以根据需要提供尽可能多的下标实现，并且将根据在使用下标时包含在下标括号中的值的类型推断要使用的适当下标。这种对多个下标的定义称为下标重载。

虽然下标通常只接受一个参数，但是如果下标适合您的类型，您还可以定义一个包含多个参数的下标。下面的例子定义了一个矩阵结构，它表示一个双值的二维矩阵。矩阵结构的下标取两个整数参数:

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提供一个初始化器，该初始化器接受两个名为rows和columns的参数，并创建一个足够大的数组来存储Double类型的rows * columns值。矩阵中的每个位置的初始值都是0.0。为此，将数组的大小和初始单元格值0.0传递给一个数组初始化器，该初始化器创建并初始化一个具有正确大小的新数组。

你可以构造一个新的矩阵实例，通过传递一个适当的行和列计数到它的初始化器:

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

上面的示例创建了一个包含两行和两列的新矩阵实例。这个矩阵实例的网格数组实际上是矩阵的一个扁平版本，从左上角到右下角读:

subscriptMatrix01_2x.png

矩阵中的值可以通过将行值和列值传递到下标来设置，下标之间用逗号分隔:

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

这两个语句调用下标的setter，将矩阵右上角(行为0，列为1)的值设为1.5，左下角(行为1，列为0)的值设为3.2:

subscriptMatrix02_2x.png

矩阵下标的getter和setter都包含一个断言，用于检查下标的行和列值是否有效。为了辅助这些断言，Matrix包含一个名为indexIsValid(row:column:)的方便方法，它检查请求的行和列是否在矩阵的范围内:

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

如果您试图访问矩阵边界之外的下标，则会触发断言:

let someValue = matrix[2, 2]
// this triggers an assert, because [2, 2] is outside of the matrix bounds

<<返回目录