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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
use ;
use crate;
/// A generic binary search tree (BST) storing key-value pairs.
///
/// Keys must be ordered (`Ord`). Duplicate keys are not allowed.
/// Deleting a node with children **cascades** and also removes its subtree.
///
/// # Examples
///
/// ## Creating a BST
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let tree: BinarySearchTree<i8, i8> = BinarySearchTree::new();
/// ```
///
/// ## Inserting key-value pairs
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i8, i8> = BinarySearchTree::new();
/// tree.insert(4, 40).unwrap();
/// tree.insert(2, 20).unwrap();
/// tree.insert(6, 60).unwrap();
///
/// assert_eq!(3, tree.size());
/// ```
///
/// ## Keys are stored in sorted order
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i16, i16> = BinarySearchTree::new();
/// tree.insert(4, 40).unwrap();
/// tree.insert(2, 20).unwrap();
/// tree.insert(6, 60).unwrap();
/// tree.insert(1, 10).unwrap();
/// tree.insert(3, 30).unwrap();
///
/// assert_eq!((&1, &10), tree.find(&1).unwrap());
/// assert_eq!((&3, &30), tree.find(&3).unwrap());
/// assert_eq!((&6, &60), tree.find(&6).unwrap());
/// ```
///
/// ## Duplicate keys are rejected
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i32, i32> = BinarySearchTree::new();
/// assert!(tree.insert(1, 10).is_ok());
/// assert!(tree.insert(1, 999).is_err()); // duplicate key returns Err
/// assert_eq!(1, tree.size());
/// ```
///
/// ## Finding a key
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i16, i16> = BinarySearchTree::new();
/// tree.insert(4, 40).unwrap();
/// tree.insert(2, 20).unwrap();
///
/// assert_eq!((&2, &20), tree.find(&2).unwrap());
/// assert!(tree.find(&999).is_err()); // non-existent key returns Err
/// ```
///
/// ## Finding a mutable reference to a value
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i16, i16> = BinarySearchTree::new();
/// tree.insert(2, 20).unwrap();
///
/// if let Ok((_, val)) = tree.find_mut(&2) {
/// *val = 99;
/// }
/// assert_eq!((&2, &99), tree.find(&2).unwrap());
/// ```
///
/// ## Deleting a node (cascades subtree)
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i16, i16> = BinarySearchTree::new();
/// tree.insert(4, 40).unwrap();
/// tree.insert(2, 20).unwrap();
/// tree.insert(1, 10).unwrap(); // child of 2
/// tree.insert(3, 30).unwrap(); // child of 2
///
/// tree.delete(&2).unwrap(); // deletes 2 and its entire subtree (1 and 3)
/// assert_eq!(1, tree.size()); // only root (4) remains
///
/// assert!(tree.delete(&999).is_err()); // non-existent key returns Err
/// ```
///
/// ## Counting leaf nodes
/// ```
/// use eldek_tad::binary_tree::{binary_search_tree::BinarySearchTree, traits::binary_tree_traits::BinaryTreeTrait};
///
/// let mut tree: BinarySearchTree<i16, i16> = BinarySearchTree::new();
/// tree.insert(4, 40).unwrap();
/// tree.insert(2, 20).unwrap();
/// tree.insert(6, 60).unwrap();
/// tree.insert(1, 10).unwrap();
/// tree.insert(3, 30).unwrap();
///
/// assert_eq!(3, tree.count_leaves()); // nodes 1, 3, and 6 have no children
/// assert_eq!(0, BinarySearchTree::<i32, i32>::new().count_leaves());
/// ```
;