本文譯自Cho S. Kim的文章:Data Structures With JavaScript: Treejavascript
「樹」,是web開發中最經常使用的數據結構之一。這句話對開發者和用戶來說,都適用:開發人員經過HTML創造了一個DOM,用戶則經過DOM消費網絡信息。 html
進一步講,您正在閱讀的本文也是以樹的形式在瀏覽器中渲染的。文章中的段落由<p>
標籤中的文字所表明;<p>
標籤嵌套在<body>
元素中,而<body>
元素則是<html>
的子元素。java
數據的嵌套相似一個家譜:<html>
元素是一個爹爹,<body>
元素是一個孩兒,<p>
元素則是<body>
元素的孩兒。若是你感受這種類比容易理解,那麼在接下來實現一棵樹的過程當中,更多的類比對你來講應該也不成問題。 node
在本文中,咱們將建立一顆有兩種遍歷方式的樹:Depth-First-Search(DFS)深度優先搜索,和Breadth-First-Search(BFS)寬度優先搜索(遍歷是指訪問樹的每個節點)。這兩種遍歷方式各自強調了對一顆樹操做的不一樣姿式;並且他們用到了咱們以前提過的( 沒翻,去找原文 )數據結構:DFS用到了棧,BFS用到了隊列。web
樹,是一種使用節點來模擬分等級(層次)數據的數據結構。節點存儲數據,並指向其餘節點(每一個節點都存儲有自身數據,和指向其它節點的指針)。部分讀者可能對節點、指針等術語不太熟悉,因此咱們這裏作一個類比:把一棵樹比做一個組織結構。這個組織結構有一個最高負責人(根節點),好比說總經理。緊跟着就是在其之下的職位,好比說一個副總。算法
咱們用一個從老總指向副總的箭頭來表示這種關係。老總
→
副總
。一個職位(老總),就是一個節點;老總和副總之間的關係(箭頭),就是指針。在組織結構圖中建立更多的相似關係,只須要重複上面的步驟,一個節點指向另一個節點。數組
在概念上,我但願節點和指針可以講得通。在實踐上,咱們再能夠舉一個DOM的栗子。一個DOM的根節點就是<html>
,它指向了<head>
和<body>
。而後重複下去生成一顆DOM樹。瀏覽器
這麼搞最讚的一點就是它具備嵌套節點的能力:一個<ul>
,內部能夠有n個<li>
節點,每一個<li>
也能夠有兄弟<li>
節點。(做者發出了奇怪的讚美)網絡
樹跟節點能夠用兩個單獨的構造器來描述:Node
和Tree
。數據結構
data
存儲一個值
parent
指向這個節點的父節點
children
指向表中的下一個節點 (這個可能有一堆,那麼多是一個數組)
_root
指向這個樹的根節點
traverseDF(callback)
使用DFS遍歷樹的節點
traverseBF(callback)
使用BFS遍歷樹的節點
contains(data,traversal)
在樹裏面搜索一個節點
add(data,toData,traverse)
向樹添加一個節點
remove(child,parent)
刪除樹的一個節點
下面開始寫代碼!
function Node(data) { this.data = data; this.parent = null; this.children = []; }
每一個Node的實例都包含三個屬性,data
,parent
和children
。第一個屬性保存跟這個節點有關的數據,好比「村長」。第二個屬性指向一個節點(在js中,就是等於號,好比this.parent = someOtherNode 這個就實現指針了好吧。什麼值傳遞就不細展開了。其餘算法中的指針實現也相似。)。
function Tree(data) { var node = new Node(data); this._root = node; }
Tree
包含兩行代碼,第一行建立了一個Node
的實例node
,第二行把這個node
賦值給了this._root
。就是對一個樹進行了初始化,給了它一個根節點。 Tree
和Node
的定義只須要不多的代碼,可是這些代碼已經足夠咱們模擬一個有層次的數據結構。爲了說明這一點,咱們能夠經過用一點測試數據來建立Tree
的實例(間接也建立了Node
的實例):
var tree = new Tree('CEO'); tree._root; // 返回{data: 'CEO', parent: null, children: []}
有parent
和children
的存在,咱們能夠把節點添加爲_root
的子節點,同時把這些子節點的父節點賦值爲_root
。
接下來,咱們給樹添加下面這5個方法:
traverseDF(callback)
traverseBF(callback)
contains(data,traversal)
add(child,parent)
remove(node,parent)
這些方法都須要對樹進行遍歷,咱們首先來實現遍歷方法(們)。
traverseDF(callback)
對樹進行深度優先遍歷:
Tree.prototype.traverseDF = function(callback) { // 一個遞歸,當即執行函數 (function recurse(currentNode) { // 第二步 for (var i = 0, length = currentNode.children.length; i < length; i++) { // 第三步 recurse(currentNode.children[i]); } // 第四步 callback(currentNode); // 首先執行 })(this._root); };
traverseDF(callback)
有一個callback
參數,顧名思義,callback
是一個稍後會在traverseDF(callback)
內調用的函數。
traverseDF(callback)
內包含了一個叫作recurse
的函數。recurse的意思是遞歸,這是一個遞歸函數,用人話說就是這個函數會調用本身,而後(特定條件下)自動結束。注意上面代碼註釋中的第*步
,我會用他們來描述一下recurse
函數是怎麼遍歷到整棵樹的:
首先執行: recurse
,以樹的根節點做爲參數。此時,currentNode
指向這個根節點。
第二步: 進入到一個for
循環,對currentNode
(好比說根節點)的每個子節點進行迭代,從第一個開始。
第三步: 在for
循環體內,調用recurse
,傳參currentNode
的某一個子節點。具體哪個子節點取決於for
循環的迭代狀況。
第四步: 當currentNode
沒有更多的子節點,退出for
循環,並調用在調用traverseDf(callback)
時傳遞進來的callback
函數。
第二步(自終止),第三步(自調用),第四步(回調函數) 會重複進行,直到咱們遍歷到樹的全部節點。
完整的講述遞歸須要一整面文章,這超出了本文的範圍。讀者能夠用上面的traverseDF(callback)
來實驗(在瀏覽器裏面打個斷點看看是怎麼執行的),來嘗試理解它是怎麼工做的。
下面這段例子用來講明一個樹是如何被traverseDF(callback)
遍歷的。
首先咱們建立一顆樹用來遍歷,下面這種方法並很差,可是能夠起到說明的效果。理想的方式是使用後面在第四部分要實現的add(value)
。
/* 創建一顆結構以下的樹 one ├── two │ ├── five │ └── six ├── three └── four └── seven */ var tree = new Tree('one'); tree._root.children.push(new Node('two')); tree._root.children[0].parent = tree; tree._root.children.push(new Node('three')); tree._root.children[1].parent = tree; tree._root.children.push(new Node('four')); tree._root.children[2].parent = tree; tree._root.children[0].children.push(new Node('five')); tree._root.children[0].children[0].parent = tree._root.children[0]; tree._root.children[0].children.push(new Node('six')); tree._root.children[0].children[1].parent = tree._root.children[0]; tree._root.children[2].children.push(new Node('seven')); tree._root.children[2].children[0].parent = tree._root.children[2];
而後咱們調用traverseDF(callback)
:
tree.traverseDF(function(node) { console.log(node.data) }); /* logs the following strings to the console(這個就不翻了) 'five' 'six' 'two' 'three' 'seven' 'four' 'one' */
traverseBF(callback)
這個方法用來進行寬度優先遍歷。
深度優先和寬度優先的遍歷順序是不同的,咱們使用在traverseBF(callback)
中用過的樹來證實這一點:
/* tree one (depth: 0) ├── two (depth: 1) │ ├── five (depth: 2) │ └── six (depth: 2) ├── three (depth: 1) └── four (depth: 1) └── seven (depth: 2) */
而後傳入相同的回調函數:
tree.traverseBF(function(node) { console.log(node.data) }); /* logs the following strings to the console 'one' 'two' 'three' 'four' 'five' 'six' 'seven' */
上面的log和樹的結構已經說明了寬度優先遍歷的模式。從根節點開始,而後向下一層,從左向右遍歷全部這一層的節點。重複進行知道到達最底層。
如今咱們有了概念,那麼來實現代碼:
Tree.prototype.traverseBF = function(callback) { var queue = new Queue(); queue.enqueue(this._root); currentNode = queue.dequeue(); while(currentNode){ for (var i = 0, length = currentNode.children.length; i < length; i++) { queue.enqueue(currentNode.children[i]); } callback(currentNode); currentNode = queue.dequeue(); } };
traverseBF(callback)
的定義包含了不少邏輯,做者在這裏解釋了一堆。我感受對理解代碼並無幫助。
嘗試解釋一下,根節點算第一層:
從根節點開始,這個時候currentNode是根節點;
第一次while遍歷currentNode的全部子節點,推動隊列。(這個時候第二層已經遍歷到了,而且會在while循環中依次執行,先進先出)
執行回調函數,傳入currentNode;
currentNode賦值爲第二層第一個子節點。
第二次while:對currentNode,第二層第一個子節點的全部子節點遍歷,推入隊列。注意這裏是第三層的第一部分。
執行回調函數,傳入currentNode;
currentNode賦值爲第二層第二個子節點。
第三次while:對currentNode,第二層第二個子節點的全部子節點遍歷,推入隊列。注意這裏是第三層的第二部分。
執行回調函數,傳入currentNode;
currentNode賦值爲第二層第三個子節點。
最後幾回while
:這個時候已經沒有下一層了,不會進入for循環,就是依次把隊列裏剩的節點傳到回調函數裏面執行就對了。
這樣就很清楚了。
contains(callback,traversal)
這個方法用來在樹裏搜索一個特定的值。爲了使用咱們以前定義的兩種遍歷方式,contains(callback,traversal)
能夠接受兩個參數,要找的值,和要進行的遍歷方式。
Tree.prototype.contains = function(callback, traversal) { traversal.call(this, callback); };
call
方法的第一個參數把traversal
綁定在調用contains(callback,traversal)
的那棵樹上面,第二個參數是一個在每一個節點上面調用的函數。
下面這個函數你們本身理解,我感受原做者解釋反了。
// tree is an example of a root node tree.contains(function(node){ if (node.data === 'two') { console.log(node); } }, tree.traverseBF);
add(data, toData, traversal)
如今咱們會找了,再來個添加的方法吧。
Tree.prototype.add = function(data, toData, traversal) { //實例一個node var child = new Node(data), parent = null, //找爹函數 callback = function(node) { if (node.data === toData) { parent = node; } }; //按某種方式執行找爹函數 this.contains(callback, traversal); //找到了嗎 if (parent) { //找到了,領走,認爹 parent.children.push(child); child.parent = parent; } else { //沒找到,報錯:沒這個爹 throw new Error('Cannot add node to a non-existent parent.'); } };
註釋就很清楚了。
var tree = new Tree('CEO'); tree.add('VP of Happiness', 'CEO', tree.traverseBF); /* our tree 'CEO' └── 'VP of Happiness' */
var tree = new Tree('CEO'); tree.add('VP of Happiness', 'CEO', tree.traverseBF); tree.add('VP of Finance', 'CEO', tree.traverseBF); tree.add('VP of Sadness', 'CEO', tree.traverseBF); tree.add('Director of Puppies', 'VP of Finance', tree.traverseBF); tree.add('Manager of Puppies', 'Director of Puppies', tree.traverseBF); /* tree 'CEO' ├── 'VP of Happiness' ├── 'VP of Finance' │ ├── 'Director of Puppies' │ └── 'Manager of Puppies' └── 'VP of Sadness' */
remove(data, fromData, traversal)
相似的,刪除方法:
Tree.prototype.remove = function(data, fromData, traversal) { var tree = this, parent = null, childToRemove = null, index; //由於是刪除某個數據下的某個值,因此先定義找爹 var callback = function(node) { if (node.data === fromData) { parent = node; } }; //按某種方式找爹 this.contains(callback, traversal); //爹存在嗎 if (parent) { //存在,找娃的排行 index = findIndex(parent.children, data); //找着了嗎 if (index === undefined) { //妹找着 throw new Error('Node to remove does not exist.'); } else { //找着了,幹掉,提頭 childToRemove = parent.children.splice(index, 1); } } else { //爹不存在,報錯 throw new Error('Parent does not exist.'); } //拿頭交差 return childToRemove; };
function findIndex(arr, data) { var index; //遍歷某個data爹的娃,若是全等,那麼返回這個娃的排行,不然返回的index等於undefined for (var i = 0; i < arr.length; i++) { if (arr[i].data === data) { index = i; } } return index; }
function Node(data) { this.data = data; this.parent = null; this.children = []; } function Tree(data) { var node = new Node(data); this._root = node; } Tree.prototype.traverseDF = function(callback) { // this is a recurse and immediately-invoking function (function recurse(currentNode) { // step 2 for (var i = 0, length = currentNode.children.length; i < length; i++) { // step 3 recurse(currentNode.children[i]); } // step 4 callback(currentNode); // step 1 })(this._root); }; Tree.prototype.traverseBF = function(callback) { var queue = new Queue(); queue.enqueue(this._root); currentTree = queue.dequeue(); while(currentTree){ for (var i = 0, length = currentTree.children.length; i < length; i++) { queue.enqueue(currentTree.children[i]); } callback(currentTree); currentTree = queue.dequeue(); } }; Tree.prototype.contains = function(callback, traversal) { traversal.call(this, callback); }; Tree.prototype.add = function(data, toData, traversal) { var child = new Node(data), parent = null, callback = function(node) { if (node.data === toData) { parent = node; } }; this.contains(callback, traversal); if (parent) { parent.children.push(child); child.parent = parent; } else { throw new Error('Cannot add node to a non-existent parent.'); } }; Tree.prototype.remove = function(data, fromData, traversal) { var tree = this, parent = null, childToRemove = null, index; var callback = function(node) { if (node.data === fromData) { parent = node; } }; this.contains(callback, traversal); if (parent) { index = findIndex(parent.children, data); if (index === undefined) { throw new Error('Node to remove does not exist.'); } else { childToRemove = parent.children.splice(index, 1); } } else { throw new Error('Parent does not exist.'); } return childToRemove; }; function findIndex(arr, data) { var index; for (var i = 0; i < arr.length; i++) { if (arr[i].data === data) { index = i; } } return index; }