Struct miden_objects::crypto::merkle::InOrderIndex

pub struct InOrderIndex { /* private fields */ }

Index of nodes in a perfectly balanced binary tree based on an in-order tree walk.

Implementations

impl InOrderIndex

pub fn new(idx: NonZero<usize>) -> InOrderIndex

Returns a new InOrderIndex instantiated from the provided value.

pub fn from_leaf_pos(leaf: usize) -> InOrderIndex

Return a new InOrderIndex instantiated from the specified leaf position.

Panics:

If leaf is higher than or equal to usize::MAX / 2.

pub fn is_leaf(&self) -> bool

True if the index is pointing at a leaf.

Every odd number represents a leaf.

pub fn is_left_child(&self) -> bool

Returns true if this note is a left child of its parent.

pub fn level(&self) -> u32

Returns the level of the index.

Starts at level zero for leaves and increases by one for each parent.

pub fn left_child(&self) -> InOrderIndex

Returns the index of the left child.

Panics:

If the index corresponds to a leaf.

pub fn right_child(&self) -> InOrderIndex

Returns the index of the right child.

Panics:

If the index corresponds to a leaf.

pub fn parent(&self) -> InOrderIndex

Returns the index of the parent node.

pub fn sibling(&self) -> InOrderIndex

Returns the index of the sibling node.

pub fn inner(&self) -> u64

Returns the inner value of this InOrderIndex.

Trait Implementations

impl Clone for InOrderIndex

fn clone(&self) -> InOrderIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InOrderIndex

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

Formats the value using the given formatter.

impl Ord for InOrderIndex

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

Restrict a value to a certain interval.

impl PartialEq for InOrderIndex

fn eq(&self, other: &InOrderIndex) -> 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.

impl PartialOrd for InOrderIndex

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for InOrderIndex

impl Eq for InOrderIndex

impl StructuralPartialEq for InOrderIndex