Merge pull request #7 from sheroz/sheroz-patch1

added benchmarks for binary search tree

Cargo.toml

@@ -7,3 +7,10 @@ edition = "2021"
 
 [dependencies]
 uuid = { version = "1.4.1", features = ["v4"] }
+
+[dev-dependencies]
+criterion = "0.5"
+
+[[bench]]
+name = "bst_benches"
+harness = false

README.md

@@ -2,13 +2,11 @@
 
 Tree and parent-child relationship samples for learning purposes
 
-Samples included:
-
 - [Generic Tree](src/generic_tree.rs)
 - [Binary Tree](src/binary_tree.rs)
 - [Binary Search Tree](src/binary_search_tree.rs)
 
 ## Useful insights
 
-- [Learn Rust With Entirely Too Many Linked Lists](https://rust-unofficial.github.io/too-many-lists/)
 - [Tree Data Structure](https://www.programiz.com/dsa/trees)
+- [Learn Rust With Entirely Too Many Linked Lists](https://rust-unofficial.github.io/too-many-lists/)

benches/bst_benches.rs

@@ -0,0 +1,23 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tree_samples_rs::binary_search_tree::*;
+use tree_samples_rs::binary_tree::*;
+
+fn benchmark_is_binary_search_tree_versions(c: &mut Criterion) {
+    let root = utils::populate_balanced_binary_search_tree();
+
+    c.bench_function("is_binary_search_tree_v1", |b| {
+        b.iter(|| BinarySearchTree::is_binary_search_tree_v1(&root))
+    });
+
+    c.bench_function("is_binary_search_tree_v2", |b| {
+        b.iter(|| BinarySearchTree::is_binary_search_tree_v2(&root))
+    });
+
+    c.bench_function("is_binary_search_tree_v3", |b| {
+        b.iter(|| BinarySearchTree::is_binary_search_tree_v3(&root))
+    });
+}
+
+criterion_group!(benches, benchmark_is_binary_search_tree_versions,);
+
+criterion_main!(benches);

src/binary_search_tree.rs

@@ -216,7 +216,7 @@ impl BinarySearchTree {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::binary_tree::test_utils::*;
+    use crate::binary_tree::utils::*;
 
     #[test]
     fn insert_recursion() {

src/binary_tree.rs

@@ -195,8 +195,7 @@ impl BinaryTree {
     }
 }
 
-#[cfg(test)]
-pub mod test_utils {
+pub mod utils {
 
     use super::*;
     pub const NODES_COUNT: usize = 15;
@@ -275,7 +274,7 @@ pub mod test_utils {
 mod tests {
     use std::collections::HashMap;
 
-    use crate::binary_tree::{test_utils::*, BinaryTree};
+    use crate::binary_tree::{utils::*, BinaryTree};
 
     #[test]
     fn populate_node_ref_list_test() {