Struct Position 

pub struct Position(/* private fields */);

Implementations

impl Position

pub fn level(self) -> u32

What level is this node in the tree, 0 if the node is a leaf, 1 if the level is one above a leaf, etc.

pub fn is_leaf(self) -> bool

pub fn from_level_and_pos(level: u32, pos: u64) -> Self

pos count start from 0 on each level

pub fn from_inorder_index(index: u64) -> Self

pub fn to_inorder_index(self) -> u64

pub fn from_postorder_index(index: u64) -> Result<Self>

pub fn to_postorder_index(self) -> u64

pub fn parent(self) -> Self

What is the parent of this node?

pub fn left_child(self) -> Self

What is the left node of this node? Will overflow if the node is a leaf

pub fn right_child(self) -> Self

What is the right node of this node? Will overflow if the node is a leaf

pub fn is_left_child(self) -> bool

Whether this position is a left child of its parent. The observation is that, after stripping out all right-most 1 bits, a left child will have a bit pattern of xxx00(11..), while a right child will be represented by xxx10(11..)

pub fn is_right_child(self) -> bool

pub fn from_leaf_index(leaf_index: u64) -> Self

pub fn sibling(self) -> Self

This method takes in a node position and return its sibling position

The observation is that, after stripping out the right-most common bits, two sibling nodes flip the the next right-most bits with each other. To find out the right-most common bits, first remove all the right-most ones because they are corresponding to level’s indicator. Then remove next zero right after.

pub fn root_from_leaf_index(leaf_index: u64) -> Self

This method calculates the index of the smallest root which contains this leaf. Observe that, the root position is composed by a “height” number of ones

For example

    0010010(node)
    0011111(smearing)
    -------
    0001111(root)

pub fn root_from_leaf_count(leaf_count: LeafCount) -> Self

pub fn root_level_from_leaf_count(leaf_count: LeafCount) -> u32

pub fn right_most_child(self) -> Self

Given a node, find its right most child in its subtree. Right most child is a Position, could be itself, at level 0

pub fn left_most_child(self) -> Self

Given a node, find its left most child in its subtree Left most child is a node, could be itself, at level 0

impl Position

pub fn is_freezable(self, leaf_index: u64) -> bool

pub fn is_placeholder(self, leaf_index: u64) -> bool

pub fn iter_ancestor(self) -> AncestorIterator

Creates an AncestorIterator using this position.

pub fn iter_ancestor_sibling(self) -> AncestorSiblingIterator

Creates an AncestorSiblingIterator using this position.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl Hash for Position

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 Position

fn cmp(&self, other: &Position) -> 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 Position

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Position

fn partial_cmp(&self, other: &Position) -> 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 StructuralPartialEq for Position