UNPKG

@clarketm/superbinarytree

Version:

BinaryTree with superpowers! 💪

github.com/clarketm/super/tree/master/packages/superbinarytree

143 lines (85 loc) • 3.67 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# [BinaryTree](https://www.npmjs.com/package/@clarketm/superbinarytree) [![NPM release](https://img.shields.io/npm/v/@clarketm/superbinarytree.svg)](https://www.npmjs.com/package/@clarketm/superbinarytree) BinaryTree with superpowers! 💪 ## Individual Module Installation ### Yarn ```bash $ yarn add @clarketm/superbinarytree ``` ### Npm ```bash $ npm install @clarketm/superbinarytree --save ``` ## API ### `constructor(iterable: Iterable<number>, comparator: Comparator)` Construct a BinaryTree ### `root: TreeNode` Get the root of the tree ### `height: number` Get the height of the tree ### `getHeight(node: TreeNode): number` Get the height of the tree at node | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `findMin(node: TreeNode): TreeNode` Find minimum value in tree | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `findMax(node: TreeNode): TreeNode` Find maximum value in tree | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `insert(value: Item)` Insert a value into the tree | Name | Type | Attribute | Description | | ----- | ---- | --------- | ----------------------------- | | value | Item | | value to insert into the tree | ### `search(value: Item): TreeNode` Search and retrieve a value from the tree | Name | Type | Attribute | Description | | ----- | ---- | --------- | --------------- | | value | Item | | value to search | ### `remove(value: Item)` Remove a value from the tree | Name | Type | Attribute | Description | | ----- | ---- | --------- | --------------- | | value | Item | | value to remove | ### `preOrder(node: TreeNode): Array<TreeNode>` Traverse the tree in preOrder traversal ordering | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `inOrder(node: TreeNode): Array<TreeNode>` Traverse the tree in inOrder traversal ordering | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `postOrder(node: TreeNode): Array<TreeNode>` Traverse the tree in postOrder traversal ordering | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `levelOrder(node: TreeNode): Array<TreeNode>` Traverse the tree in levelOrder traversal ordering | Name | Type | Attribute | Description | | ---- | -------------- | --------- | ----------- | | node | BinaryTreeNode | | root node | ### `toArray(traversal: Traversal, flatten: boolean): Array<TreeNode|Item>` Convert the tree to an array | Name | Type | Attribute | Description | | --------- | --------- | --------- | ------------------------------------------------- | | traversal | Traversal | | method of traversal | | flatten | boolean | | if false return nodes; if true return only values | ## `TreeNode` TreeNode ### `constructor(value: Item)` Construct a TreeNode ### `value: Item` Get the value of node ### `left: TreeNode` Get the right child node ### `right: TreeNode` Get the right child node