下标
类,结构和枚举可以定义下标,它们是访问集合,列表或序列的成员元素的快捷方式。您可以使用下标以索引设置和检索值,而无需单独的设置和检索方法。例如,您可以将someArray [index]和Dictionary实例中的元素作为someDictionary [key]访问Array实例中的元素。
您可以为单个类型定义多个下标,并根据传递给下标的索引值的类型选择适当的下标超载。下标不限于单个维度,您可以使用多个输入参数定义下标以适应您的自定义类型的需求。
下标语法
下标使您能够通过在实例名称后面的方括号中写入一个或多个值来查询某个类型的实例。它们的语法类似于实例方法语法和计算属性语法。您可以使用subscript关键字编写下标定义,并以与实例方法相同的方式指定一个或多个输入参数和返回类型。与实例方法不同,下标可以是可读写或只读的。这种行为由getter和setter以与计算属性相同的方式传递:
subscript(index: Int) -> Int {
get {
// return an appropriate subscript value here
}
set(newValue) {
// perform a suitable setting action here
}
}
newValue的类型与下标的返回值相同。 与计算属性一样,您可以选择不指定setter的(newValue)参数。 如果您自己没有提供默认参数,则会向setter提供名为newValue的默认参数。
与只读计算属性一样,您可以通过删除get关键字及其大括号来简化只读下标的声明:
subscript(index: Int) -> Int {
// return an appropriate subscript value here
}
下面是一个只读的下标实现的例子,它定义了一个TimesTable结构来表示一个n次的整数表:
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"
在这个例子中,创建一个TimesTable的新实例来表示三次表。这通过将值3传递给结构的初始值设定项来指示,作为用于实例乘数参数的值。
您可以通过调用其下标来查询threeTimesTable实例,如调用threeTimesTable [6]所示。这要求在三次表中的第六个条目,其返回值18或3次6。
注意
n次表是基于一个固定的数学规则。将threeTimesTable [someIndex]设置为新值并不合适,因此TimesTable的下标被定义为只读下标。
下标使用
“下标”的确切含义取决于其使用的上下文。下标通常用作访问集合,列表或序列中成员元素的快捷方式。您可以自由地以最合适的方式为您的特定类或结构的功能实现下标。
例如,Swift的Dictionary类型实现了一个下标来设置和检索存储在Dictionary实例中的值。您可以在字典中设置一个值,方法是在下标括号内提供字典键类型的键,并将字典值类型的值赋给下标:
var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
numberOfLegs["bird"] = 2
上面的例子定义了一个名为numberOfLegs的变量,并用一个包含三个键值对的字典文字来初始化它。 numberOfLegs字典的类型被推断为[String:Int]。创建字典后,此示例使用下标分配将字符串“bird”和Int值2添加到字典中。
有关字典下标的更多信息,请参阅访问和修改字典。
注意
Swift的字典类型实现了它的键值下标作为一个下标,它接受并返回一个可选类型。对于上面的numberOfLegs字典,键值下标采用并返回类型为Int?或“optional int”的值。 Dictionary类型使用可选的下标类型来模拟不是每个键都有值的事实,并且通过为键分配一个零值来给出一种方法来删除键的值。
下标选项
下标可以接受任意数量的输入参数,并且这些输入参数可以是任何类型。下标还可以返回任何类型。下标可以使用可变参数,但不能使用输入参数或提供默认参数值。
类或结构可以提供尽可能多的下标实现,并根据使用下标时下标括号内包含的值或值的类型推断使用的下标。多重下标的定义称为下标重载。
虽然下标最常见的是采用单个参数,但如果它适合您的类型,也可以使用多个参数定义下标。以下示例定义了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提供了一个初始化程序,它接受两个称为行和列的参数,并创建一个足够大的数组来存储Double类型的行*列值。 矩阵中的每个位置的初始值为0.0。 为了达到这个目的,数组的大小和初始单元格值为0.0被传递给一个数组初始化器,该数组初始化器创建并初始化一个正确大小的新数组。 该初始值设定项在使用默认值创建数组中有更详细的描述。
您可以通过将适当的行和列计数传递给其初始值设定项构造一个新的Matrix实例:
var matrix = Matrix(行数:2,列数:2)
上例创建一个具有两行两列的新Matrix实例。 此Matrix实例的网格数组实际上是矩阵的扁平版本,从左上角到右下角读取:
矩阵中的值可以通过将行和列值传递给下标来设置,并用逗号分隔:
matrix[0, 1] = 1.5
matrix[1, 0] = 3.2
这两个语句调用下标的设置器在矩阵的右上角位置(其中行为0且列为1)和位于左下角位置(其中行1和列为0)的位置设置值1.5:
Matrix下标的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