Struct Node 

pub struct Node(pub usize);

Represents a node in a tree by its index.

Tuple Fields

0: usize

Implementations

impl Node

pub fn index(&self) -> usize

The index in the tree space for this node

pub fn height(&self) -> u32

The height of this node, where leaves have height 0

pub fn side(&self) -> Side

The side this node is on of its parent

pub fn left_sibling(&self) -> Node

The left sibling of this node. Panics if node is not a right-side node.

pub fn right_sibling(&self) -> Node

The right sibling of this node. Panics if node is not a left-side node.

pub fn sibling(&self) -> Node

The sibling of this node.

pub fn parent(&self) -> Node

Finds the parent of a given node index.

pub fn children(&self) -> (Node, Node)

Find the left and right child of this node.

pub fn rightmost_descendent(&self) -> Node

Finds the right-most node which is a descendent of this one.

pub fn leftmost_descendent(&self) -> Node

Finds the left-most node which is a descendent of this one.

pub fn exists_at_length(&self, length: usize) -> bool

Determines if a log with the given number of elements would contain this node.

pub fn next_node_with_height(&self, height: u32) -> Node

Finds the next node after this one with the specified height. The specified height MUST be less than or equal the height of this node.

pub fn first_node_with_height(height: u32) -> Node

Compute the left-most node which has a given height.

pub fn broots_for_len(length: usize) -> Vec<Node>

Compute the balanced roots for a log with a given log length in number of leaves.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Hash for Node

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Node

fn cmp(&self, other: &Node) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Node

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Node

fn partial_cmp(&self, other: &Node) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Node

impl Eq for Node

impl StructuralPartialEq for Node