pub struct BinaryTree<T> { /* private fields */ }
Expand description

The binary tree.

Implementations§

source§

impl<T> BinaryTree<T>

source

pub fn new() -> Self

Build a new empty binary tree

source

pub fn is_empty(&self) -> bool

Returns true when the binary tree is empty

source

pub fn add_root(&mut self, root: BinaryTreeNode<T>) -> TreeIndex

Add a node as the root node. Return the index of the root node.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
let root_index = tree.add_root(root);
assert_eq!(0, root_index);
println!("{}", root_index)
source

pub fn get_root_index(&self) -> TreeIndex

Return the index of the root node. Call this API after inserting root node.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
assert_eq!(0, tree.get_root_index());
source

pub fn get_left_child( &self, node: &BinaryTreeNode<T> ) -> Option<&BinaryTreeNode<T>>

Return the left child of the given node

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
let root_index = tree.add_root(root);
let left_node = BinaryTreeNode::new(5.0);
let _ = tree.add_left_node(root_index, left_node);
let root = tree.get_node(root_index).expect("Didn't find root node");
let left_node = tree.get_left_child(root).expect("Didn't find left child");
println!("{}", left_node.value);
assert!((left_node.value - 5.0) < 0.001)
source

pub fn get_right_child( &self, node: &BinaryTreeNode<T> ) -> Option<&BinaryTreeNode<T>>

Return the right child of the given node

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
let root_index = tree.add_root(root);
let right_node = BinaryTreeNode::new(5.0);
let _ = tree.add_right_node(root_index, right_node);
let root = tree.get_node(root_index).expect("Didn't find root node");
let right_node = tree.get_right_child(root).expect("Didn't find right child");
println!("{}", right_node.value);
assert!((right_node.value - 5.0) < 0.001)
source

pub fn get_node(&self, index: TreeIndex) -> Option<&BinaryTreeNode<T>>

Return the node with the given index

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<i32> = BinaryTree::new();
let root = BinaryTreeNode::new(10);
let _ = tree.add_root(root);
let root_index = tree.get_root_index();
let root = tree.get_node(root_index).expect("Didn't find root node");
assert_eq!(10, root.value);
source

pub fn get_node_mut( &mut self, index: TreeIndex ) -> Option<&mut BinaryTreeNode<T>>

Return the muttable reference of a node with the given index

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<i32> = BinaryTree::new();
let root = BinaryTreeNode::new(10);
let _ = tree.add_root(root);
let root_index = tree.get_root_index();
let root = tree.get_node_mut(root_index).expect("Didn't find root node");
root.value = 11;
assert_eq!(11, root.value);
source

pub fn add_left_node( &mut self, parent: TreeIndex, child: BinaryTreeNode<T> ) -> TreeIndex

Add a node as the left child of a given parent node. Return the index of the added node.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
let root_index = tree.add_root(root);
let left_node = BinaryTreeNode::new(5.0);
let _ = tree.add_left_node(root_index, left_node);
let root = tree.get_node(root_index).expect("Didn't find root node");
let left_node = tree.get_left_child(root).expect("Didn't find left child");
println!("{}", left_node.value);
assert!((left_node.value - 5.0) < 0.001)
source

pub fn add_right_node( &mut self, parent: TreeIndex, child: BinaryTreeNode<T> ) -> TreeIndex

Add a node as the right child of a given parent node. Return the index of the added node.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);
let root_index = tree.add_root(root);
let right_node = BinaryTreeNode::new(5.0);
let _ = tree.add_right_node(root_index, right_node);
let root = tree.get_node(root_index).expect("Didn't find root node");
let right_node = tree.get_right_child(root).expect("Didn't find right child");
println!("{}", right_node.value);
assert!((right_node.value - 5.0) < 0.001)
source

pub fn print(&self)
where T: Debug,

For debug use. This API will print the whole tree.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);

let root_index = tree.add_root(root);

let n1 = BinaryTreeNode::new(5.0);
let n2 = BinaryTreeNode::new(6.0);

let n1_index = tree.add_left_node(root_index, n1);
let n2_index = tree.add_right_node(root_index, n2);

let n3 = BinaryTreeNode::new(7.0);
let n4 = BinaryTreeNode::new(8.0);

tree.add_left_node(n2_index, n3);
tree.add_right_node(n2_index, n4);

let n5 = BinaryTreeNode::new(9.0);

tree.add_left_node(n1_index, n5);

tree.print();

// Output:
//----10.0
//    ----5.0
//        ----9.0
//    ----6.0
//        ----7.0
//        ----8.0
source

pub fn len(&self) -> usize

Get the amount of the nodes in this tree.

§Example
use gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
let mut tree: BinaryTree<f32> = BinaryTree::new();
let root = BinaryTreeNode::new(10.0);

let root_index = tree.add_root(root);

let n1 = BinaryTreeNode::new(5.0);
let n2 = BinaryTreeNode::new(6.0);

let n1_index = tree.add_left_node(root_index, n1);
let n2_index = tree.add_right_node(root_index, n2);

assert_eq!(3, tree.len());

Trait Implementations§

source§

impl<T: Debug> Debug for BinaryTree<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T> Default for BinaryTree<T>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'de, T> Deserialize<'de> for BinaryTree<T>
where T: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> Serialize for BinaryTree<T>
where T: Serialize,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for BinaryTree<T>
where T: RefUnwindSafe,

§

impl<T> Send for BinaryTree<T>
where T: Send,

§

impl<T> Sync for BinaryTree<T>
where T: Sync,

§

impl<T> Unpin for BinaryTree<T>
where T: Unpin,

§

impl<T> UnwindSafe for BinaryTree<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,