Struct ntree_rs::Node

pub struct Node<T> { /* private fields */ }

Represents the minimum unit in a tree, containing a value of type T and all those nodes children of the node itself, if any.

Implementations

impl<T> Node<T>

pub fn preorder<F>(&self, f: F)where F: FnMut(&Self),

Calls the given closure for each node in the tree rooted by self following then pre-order traversal.

pub fn preorder_mut<F>(&mut self, f: F)where F: FnMut(&mut Self),

Calls the given closure for each node in the tree rooted by self following then pre-order traversal.

pub fn postorder<F>(&self, f: F)where F: FnMut(&Self),

Calls the given closure for each node in the tree rooted by self following the post-order traversal.

pub fn postorder_mut<F>(&mut self, f: F)where F: FnMut(&mut Self),

Calls the given closure for each node in the tree rooted by self following the post-order traversal.

pub fn reduce<F, R>(&self, f: F) -> Rwhere F: FnMut(&Self, Vec<R>) -> R, R: Sized,

Calls the given closure recursivelly along the tree rooted by self. This method traverses the tree in post-order, and so the second parameter of f is a vector containing the returned value of f for each child in that node given as the first parameter.

pub fn reduce_mut<F, R>(&mut self, f: F) -> Rwhere F: FnMut(&mut Self, Vec<R>) -> R, R: Sized,

Calls the given closure recursivelly along the tree rooted by self. This method traverses the tree in post-order, and so the second parameter of f is a vector containing the returned value of f for each child in that node given as the first parameter.

pub fn cascade<F, R>(&self, base: R, f: F)where F: FnMut(&Self, &R) -> R, R: Sized,

Calls the given closure recursivelly along the tree rooted by self. This method traverses the tree in pre-order, and so the second parameter of f is the returned value of calling f on the parent of that node given as the first parameter.

pub fn cascade_mut<F, R>(&mut self, base: R, f: F)where F: FnMut(&mut Self, &R) -> R, R: Sized,

Calls the given closure recursivelly along the tree rooted by self. This method traverses the tree in pre-order, and so the second parameter of f is the returned value of calling f on the parent of that node given as the first parameter.

impl<T> Node<T>

pub fn new(value: T) -> Self

pub fn value(&self) -> &T

Returns a immutable reference to node’s value.

pub fn set_value(&mut self, value: T)

Sets the given value as the Node’s one.

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

Returns a mutable reference to node’s value.

pub fn children(&self) -> &[Node<T>]

Returns an immutable slice of all node’s children.

pub fn children_mut(&mut self) -> &mut [Node<T>]

Returns a mutable slice of all node’s children.

pub fn add_child(&mut self, child: Node<T>) -> usize

Adds a new child to the node and returns its total number of children.

pub fn remove_child(&mut self, index: usize) -> Option<Node<T>>

Removes the children located at the given index and returns it, if any.

pub fn children_len(&self) -> usize

Returns the total of direct descendants (children) the node has.

pub fn size(&self) -> usize

Returns the number of descendants the node has. This method return 0 if, and only if, the node has no children.

pub fn height(&self) -> usize

Returns the length of the longest branch in the tree rooted by self. Also known as the height of the tree. This method returns 1 if, and only if, the node has no children.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: PartialEq> 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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.