Merge pull request #7 from linksplatform/issue-6-d8de5266ad68

Rename SzbTree to RecursiveSizeBalancedTree and NoRecurSzbTree to IterativeSizeBalancedTree

Author: konard

README.md

@@ -6,18 +6,18 @@ This library provides low-level tree and linked list data structure traits for t
 
 ## Overview
 
-`platform-trees` is a Rust implementation of tree and linked list methods used by the Links Platform. It provides generic traits that can be implemented for various storage backends, enabling efficient tree-based data structures with size-balanced binary (SZB) tree algorithms.
+`platform-trees` is a Rust implementation of tree and linked list methods used by the Links Platform. It provides generic traits that can be implemented for various storage backends, enabling efficient tree-based data structures with size-balanced tree algorithms.
 
 ## Features
 
 ### Tree Structures
-- **`SzbTree`** - Size-balanced binary tree trait with core operations:
+- **`RecursiveSizeBalancedTree`** - Base size-balanced binary tree trait with core operations:
   - Node navigation (`get_left`, `get_right`, `get_next`, `get_previous`)
   - Tree rotations (`left_rotate`, `right_rotate`)
   - Size management (`get_size`, `fix_size`, `inc_size`, `dec_size`)
   - Tree queries (`contains`, `get_leftest`, `get_rightest`)
 
-- **`NoRecurSzbTree`** - Non-recursive size-balanced tree trait extending `SzbTree`:
+- **`IterativeSizeBalancedTree`** - Iterative size-balanced tree trait extending `RecursiveSizeBalancedTree`:
   - Iterative `attach` and `detach` operations
   - Avoids stack overflow on deep trees
   - Maintains tree balance during modifications
@@ -50,10 +50,10 @@ Add the dependency to your `Cargo.toml`:
 platform-trees = "0.1.0-beta.1"
 ```
 
-### Example: Implementing SzbTree
+### Example: Implementing RecursiveSizeBalancedTree
 
 ```rust
-use platform_trees::{SzbTree, NoRecurSzbTree};
+use platform_trees::{IterativeSizeBalancedTree, RecursiveSizeBalancedTree};
 use platform_data::LinkType;
 
 // Define your tree node storage
@@ -68,8 +68,8 @@ struct Node {
     // ... your data
 }
 
-// Implement the SzbTree trait for your storage type
-impl SzbTree<usize> for MyTreeStorage {
+// Implement the RecursiveSizeBalancedTree trait for your storage type
+impl RecursiveSizeBalancedTree<usize> for MyTreeStorage {
     unsafe fn get_mut_left_reference(&mut self, node: usize) -> *mut usize {
         &mut self.nodes[node].left
     }
@@ -119,8 +119,8 @@ impl SzbTree<usize> for MyTreeStorage {
     }
 }
 
-// Implement NoRecurSzbTree to get attach/detach operations
-impl NoRecurSzbTree<usize> for MyTreeStorage {}
+// Implement IterativeSizeBalancedTree to get attach/detach operations
+impl IterativeSizeBalancedTree<usize> for MyTreeStorage {}
 ```
 
 ### Example: Implementing LinkedList
@@ -179,8 +179,8 @@ impl AbsoluteCircularLinkedList<usize> for MyListStorage {}
 
 | Trait | Description |
 |-------|-------------|
-| `SzbTree<T>` | Base trait for size-balanced binary trees with rotation and navigation operations |
-| `NoRecurSzbTree<T>` | Extension trait providing iterative attach/detach without recursion |
+| `RecursiveSizeBalancedTree<T>` | Base trait for size-balanced binary trees with rotation and navigation operations |
+| `IterativeSizeBalancedTree<T>` | Extension trait providing iterative attach/detach without recursion |
 
 ### List Traits
 

src/lib.rs

@@ -13,4 +13,4 @@ pub use lists::{
     RelativeLinkedList,
 };
 
-pub use trees::{NoRecurSzbTree, SzbTree};
+pub use trees::{IterativeSizeBalancedTree, RecursiveSizeBalancedTree};

src/tests.rs

@@ -1,8 +1,8 @@
 //! Comprehensive tests for 100% code coverage of platform-trees
 
 use crate::{
-    AbsoluteCircularLinkedList, AbsoluteLinkedList, LinkedList, LinkType, NoRecurSzbTree,
-    RelativeCircularLinkedList, RelativeLinkedList, SzbTree,
+    AbsoluteCircularLinkedList, AbsoluteLinkedList, IterativeSizeBalancedTree, LinkType,
+    LinkedList, RecursiveSizeBalancedTree, RelativeCircularLinkedList, RelativeLinkedList,
 };
 
 // =============================================================================
@@ -147,15 +147,15 @@ impl RelativeLinkedList<usize> for TestRelativeList {
 
 impl RelativeCircularLinkedList<usize> for TestRelativeList {}
 
-/// A tree node structure for testing SzbTree
+/// A tree node structure for testing SizeBalancedTree
 #[derive(Debug, Clone, Copy, Default)]
 struct TreeNode {
     left: usize,
     right: usize,
     size: usize,
 }
 
-/// A simple SzbTree implementation for testing
+/// A simple SizeBalancedTree implementation for testing
 struct TestTree {
     nodes: Vec<TreeNode>,
 }
@@ -168,7 +168,7 @@ impl TestTree {
     }
 }
 
-impl SzbTree<usize> for TestTree {
+impl RecursiveSizeBalancedTree<usize> for TestTree {
     unsafe fn get_mut_left_reference(&mut self, node: usize) -> *mut usize {
         &mut self.nodes[node].left
     }
@@ -218,7 +218,7 @@ impl SzbTree<usize> for TestTree {
     }
 }
 
-impl NoRecurSzbTree<usize> for TestTree {}
+impl IterativeSizeBalancedTree<usize> for TestTree {}
 
 // =============================================================================
 // LinkType trait tests
@@ -773,11 +773,11 @@ mod relative_circular_linked_list_tests {
 }
 
 // =============================================================================
-// SzbTree trait tests
+// SizeBalancedTree trait tests
 // =============================================================================
 
 #[cfg(test)]
-mod szb_tree_tests {
+mod size_balanced_tree_tests {
     use super::*;
 
     #[test]
@@ -1149,11 +1149,11 @@ mod szb_tree_tests {
 }
 
 // =============================================================================
-// NoRecurSzbTree trait tests
+// IterativeSizeBalancedTree trait tests
 // =============================================================================
 
 #[cfg(test)]
-mod no_recur_szb_tree_tests {
+mod iterative_size_balanced_tree_tests {
     use super::*;
 
     #[test]

src/trees/no_recur_szb_tree.rs src/trees/iterative_size_balanced_tree.rssrc/trees/no_recur_szb_tree.rs renamed to src/trees/iterative_size_balanced_tree.rs

@@ -1,6 +1,6 @@
-use crate::{LinkType, SzbTree};
+use crate::{LinkType, RecursiveSizeBalancedTree};
 
-pub trait NoRecurSzbTree<T: LinkType>: SzbTree<T> {
+pub trait IterativeSizeBalancedTree<T: LinkType>: RecursiveSizeBalancedTree<T> {
     unsafe fn attach(&mut self, root: *mut T, node: T) {
         if *root == T::funty(0) {
             self.set_size(node, T::funty(1));

src/trees/mod.rs

@@ -1,5 +1,5 @@
-mod no_recur_szb_tree;
-mod szb_tree;
+mod iterative_size_balanced_tree;
+mod recursive_size_balanced_tree;
 
-pub use no_recur_szb_tree::NoRecurSzbTree;
-pub use szb_tree::SzbTree;
+pub use iterative_size_balanced_tree::IterativeSizeBalancedTree;
+pub use recursive_size_balanced_tree::RecursiveSizeBalancedTree;

src/trees/szb_tree.rs src/trees/recursive_size_balanced_tree.rssrc/trees/szb_tree.rs renamed to src/trees/recursive_size_balanced_tree.rs

@@ -1,6 +1,6 @@
 use crate::LinkType;
 
-pub trait SzbTree<T: LinkType> {
+pub trait RecursiveSizeBalancedTree<T: LinkType> {
     unsafe fn get_mut_left_reference(&mut self, node: T) -> *mut T;
 
     unsafe fn get_mut_right_reference(&mut self, node: T) -> *mut T;