原文鏈接: Swift Algorithm Club: Swift Stack Data Structure
翻譯: coderJoey
通過本教程,你將學習怎樣用swift實現堆棧數據結構。作為基礎數據結構,堆棧能解決很多程序中的問題。
開始吧
堆棧很像數組,但是其功能較數組而言有所限制。你只能通過push(壓人)來添加新元素到堆棧的頂部,也只能通過pop來移除堆棧頂部的元素,如果不進行移除操作的話,你也只能查看到堆棧最上面的元素。
這種數據結構有什么用呢?在很多算法中,例如某個時刻你想添加一些新的對象到一個臨時鏈中,然后不就之后你需要刪除掉這些對象,添加和刪除這些對象的順序有時候是很重要的。
堆棧進出棧順序是LIFO( last-in first-out order:后進先出),也就是最后進棧的元素最先被移除。(這非常像數據結構隊列(FIFO:先進先出))
接下來,你將用數組實現堆棧的內部存儲操作。雖然這不是很高效的做法,但能讓你理解堆棧結構的實現方式。
堆棧的相關操作
堆棧的功能范圍相對有限。 以堆疊的書籍為例,堆棧相應的功能有:
Push
當你要添加元素到堆棧中時,你應該將元素push到堆棧的最上面。就像放一本書到一疊書上面。
Peek
按照設計規則,堆棧不允許查看除了堆棧的頂部元素的其它元素。 peek方法只允許你查看堆棧頂部的內容。
Pop
就像下圖從一疊書中拿掉最上面的書本一樣,你只能通過pop移除掉堆棧中最上面的元素。
Swift 堆棧的實現
用Xcode創建一個新的playground!
開始,先將下面的代碼寫到你的playground中:
struct Stack {
fileprivate var array: [String] = []
}
這里定義了一個擁有一個array屬性的堆棧,你將通過這個array屬性來實現 push、 pop、 和 peek這些功能方法
Push
將對象壓入到堆棧中是比較簡單的。把下面的方法加到stack實現中:
// 1
mutating func push(_ element: String) {
// 2
array.append(element)
}
push方法只有一個參數,即需要添加到棧頂的元素。
注意這里新元素是添加到數組的末尾而不是數組的開頭。如果添加到數組的開始位置,則是代價相當大的O(n)操作,因為這需要數組里面所有的元素在內存中都進行移位操作。添加在數組尾部的時間復雜度是** O(1)**,不管數組的大小是多少,它所需要的時間是固定的。
Pop
元素出棧也是很簡單的。將下面的方法放到push方法下面:
// 1
mutating func pop() -> String? {
// 2
return array.popLast()
}
pop方法的返回值是可選類型String,返回可選類型是為了處理堆棧為空的情況。如果你對一個內容為空的堆棧進行pop操作的話,返回值將是nil。
Swift 數組刪除最后一個元素的方法popLast。
Peek
查看堆棧的元素實質就是查看棧頂的元素。這也是相對比較容易實現的。Swift 數組有一個last屬性專門來訪問數組的最后一個元素。
func peek() -> String? {
return array.last
}
peek方法和pop方法類似,最大的區別是pop方法前面有關鍵字mutating。這是因為peek方法不會改變數組的內容,所以沒有必要加關鍵字mutating了。
試一試
到現在為止,你的Swift堆棧已經可以進行一些測試了。將下面的代碼加到playground的底部:
// 1
var rwBookStack = Stack()
// 2
rwBookStack.push("3D Games by Tutorials")
// 3
rwBookStack.peek()
// 4
rwBookStack.pop()
// 5
rwBookStack.pop()
在playground的右面板上,你能看到每一行的輸出結果:
初始化一個堆棧對象并賦值給變量rwBookStack。這里使用var將其定義為變量而不是常量,是因為等會你會改變堆棧的內容。
添加一個字符串到堆棧中。
查看堆棧內容,也就是最后入棧的字符串“3D Games by Tutorials”。
移除棧頂的內容,也就是最后入棧的字符串“3D Games by Tutorials”。
由于你已經移除了堆棧中的所有內容,所以面板顯示為nil。
CustomStringConvertible
現在打印堆棧對象的話,很難看出堆棧是如何工作的。 幸運的是,Swift有一個名為CustomStringConvertible的內置協議,它允許你自定義打印內容。 將下面的代碼寫到Stack實現的下面(不是里面):
// 1
extension Stack: CustomStringConvertible {
// 2
var description: String {
// 3
let topDivider = "---Stack---\n"
let bottomDivider = "\n-----------\n"
// 4
let stackElements = array.reversed().joined(separator: "\n")
// 5
return topDivider + stackElements + bottomDivider
}
}
上面代碼做了什么:
實現一個Stack的擴展,并遵守CustomStringConvertible協議。
根據CustomStringConvertible協議實現description屬性。
添加數據頭部和尾部的打印內容。
你需要將數組里面的元素按照堆棧的樣式打印出來。 由于你是將元素添加到數組的尾部,所以首先要做的是反轉數組。然后用joined(separator:) 方法來拼接數組里面的元素,元素之間用separator隔開。例如數組["3D Games by Tutorials", "tvOS Apprentice"] 拼接之后就變成了** "3D Games by Tutorials\ntvOS Apprentice" **。
最后將topDivider 、 stackElements 和 bottomDivider像三明治一樣的疊起來,作為堆棧的描述(打印)內容。
刪掉之前的測試代碼并添加下面的代碼到playground底部:
var rwBookStack = Stack()
rwBookStack.push("3D Games by Tutorials")
rwBookStack.push("tvOS Apprentice")
rwBookStack.push("iOS Apprentice")
rwBookStack.push("Swift Apprentice")
print(rwBookStack)
在playground下面的控制臺將輸出:
---Stack---
Swift Apprentice
iOS Apprentice
tvOS Apprentice
3D Games by Tutorials
-----------
泛型
目前為止,你的堆棧只能存儲strings。如果要創建一個堆棧來存儲整數,則必須實現一個面向整數的全新的堆棧。幸運的是Swift可以通過泛型來抽象我們需要儲存的數據。將你的Stack改成下面的樣式:
struct Stack<Element> {
// ...
}
代碼中的尖括號將這個結構體聲明為泛型,允許堆棧傳入Swift中的所有類型。 下一步,查找并將實例中的“String”類型替換為“Element”。現在你的Stack應該是這樣:
struct Stack<Element> {
fileprivate var array: [Element] = []
mutating func push(_ element: Element) {
array.append(element)
}
mutating func pop() -> Element? {
return array.popLast()
}
func peek() -> Element? {
return array.last
}
}
最后,你還需要修改description屬性的內容。只需要改一個地方,像下面這樣:
// 修改前
let stackElements = array.reversed().joined(separator: "\n")
// 修改后
let stackElements = array.map { "\($0)" }.reversed().joined(separator: "\n")
這里主要是將數組元素在拼接前轉換成String類型。由于你不確定數組元素的類型,所以這個轉換時必要的。
最后你要將創建的堆棧對象指定為String類型。
var rwBookStack = Stack<String>()
現在你的堆棧能夠指定為String、Int和其他任何類型了,甚至你自定義的類型像Person也是可以的!
收尾
這里還有兩個屬性是堆棧常常用到的:判斷堆棧是否為空和堆棧當前的元素個數。
var isEmpty: Bool {
return array.isEmpty
}
var count: Int {
return array.count
}
何去何從
希望你對制作堆棧的這套教程感到滿意!
上面的代碼可點擊這里下載。你還可以去往這里查看最初的實現方式以及進行堆棧的進一步的討論。