Struct radiate_matrix_tree::tree::node::Node

pub struct Node<T: Clone> { /* fields omitted */ }

a Node struct to represent a bidirectional binary tree holding pointers to the parent and two children, the left and right child

Implementations

impl<T: Clone> Node<T>

implement the node

pub fn new(elem: T) -> Box<Self>

create a new node.

pub fn get(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn is(&self, node: &Node<T>) -> bool

Check if node 'is' the same as this node. This just checks that the references are for the same 'Node'

pub fn check_left_child(&self, node: &Node<T>) -> bool

return true if this node is the left child, false if not

pub fn check_right_child(&self, node: &Node<T>) -> bool

return true if this node is the right child, false if not

pub fn is_left_child(&self) -> Option<bool>

return true if this node is the left child of it's parent, false if not returns None if node doesn't have a parent.

pub fn is_leaf(&self) -> bool

return true if this node is a leaf node, meaning it has no children.

pub fn has_left_child(&self) -> bool

return true if this node has a valid left child and is not pointing to a null pointer

pub fn has_right_child(&self) -> bool

return true if this node has a valid right child and is not pointing to a null pointer

pub fn has_parent(&self) -> bool

return true if this node has a parent, false if not. If it does not, then this node is the root of the tree.

pub fn set_left_child(&mut self, child: Link<T>)

Safely set the left child node. Will drop any old left child node.

pub fn set_right_child(&mut self, child: Link<T>)

Safely set the right child node. Will drop any old right child node.

pub fn set_parent(&mut self, parent: *mut Node<T>)

Safely set the node's parent. If the node already has a parent, this node will be removed from it.

pub fn left_child_mut_opt(&mut self) -> Option<&mut Node<T>>

Safely returns a mutable reference to this node's left child.

pub fn right_child_mut_opt(&mut self) -> Option<&mut Node<T>>

Safely returns a mutable reference to this node's right child.

pub fn parent_mut_opt(&mut self) -> Option<&mut Node<T>>

Safely returns a mutable reference to this node's parent.

pub fn left_child_opt(&self) -> Option<&Node<T>>

Safely returns a reference to this node's left child.

pub fn right_child_opt(&self) -> Option<&Node<T>>

Safely returns a reference to this node's right child.

pub fn parent_opt(&self) -> Option<&Node<T>>

Safely returns a reference to this node's parent.

pub fn take_left_child(&mut self) -> Link<T>

Remove and return the left child node. The returned node is owned by the caller

pub fn take_right_child(&mut self) -> Link<T>

Remove and return the right child node. The returned node is owned by the caller

pub fn remove_from_parent(&mut self)

Safely detach this node from it's parent.

pub fn height(&self) -> i32

return the height of this node recursivley

pub fn depth(&self) -> i32

return the depth of this node, meaning the number of levels down it is from the root of the tree, recrsive.

pub fn size(&self) -> i32

return the size of the subtree recrusivley.

pub fn copy(&self) -> Box<Node<T>>

Return a thin copy of this node, meaning keep all information besides the family pointers, these are nulled-out in order to avoid dangling or circular references.

pub fn deepcopy(&self) -> Box<Node<T>>

deep copy this node and it's subnodes. Recursivley traverse the tree in order and thin copy the current node, then assign it's surroudning pointers recrusivley.

pub fn insert_random(&mut self, node: Box<Node<T>>)

Randomly insert a node into the tree.

pub fn display(&self, level: i32)

Recrusively display the node and it's subnodes Useful for visualizing the strucutre of the tree and debugging. Level is the depth of the tree, at the root it should be 0.

Trait Implementations

impl<T: Clone> Debug for Node<T>

implement debut for the node to give a little more information for the node and make it easier to trace through a tree when a tree is displayed

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

Formats the value using the given formatter.

impl<T: Clone> Deref for Node<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Clone> DerefMut for Node<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Clone> PartialEq<Node<T>> for Node<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.