zec
/
incrementalmerkletree
mirror of https://github.com/zcash/incrementalmerkletree.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Wrap long lines & fix emmer/ommer typo.

This commit is contained in:
Kris Nuttycombe 2023-06-16 16:29:06 -06:00
parent 964e71b79d
commit d9fbd00e91
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
incrementalmerkletree/src/lib.rs
View File

@ -2,7 +2,8 @@
//!
//! # Navigating Tree Structure
//!
//! Several different abstractions are used for navigating tree structure. Consider this example binary tree:
//! Several different abstractions are used for navigating tree structure. Consider this example
//! binary tree:
//!
//! ```text
//! a
@ -16,24 +17,31 @@
//!
//! **Location Abstractions:**
//!
//! - [Level] represents the height from the leaves. Examples: `e` is level 0, `c` is level 1, `a` is level 2.
//! - `index` is the 0-based distance from the left-most node _on a given [Level]_. Examples: `f` has index 2, `c` has index 1, and `a` has index 0.
//! - [Level] represents the height from the leaves. Examples: `e` is level 0, `c` is level 1, `a`
//! is level 2.
//! - `index` is the 0-based distance from the left-most node _on a given [Level]_. Examples: `f`
//! has index 2, `c` has index 1, and `a` has index 0.
//! - [Position] is a type abstraction of the index of a leaf at [Level] 0.
//! - [Address] locates any node within a tree by representing the [Level] and `index`. Examples: the [Address] of `c` is at [Level] 1 and index 1, the [Address] of `f` is at [Level] 0, index 2.
//! - [Address] locates any node within a tree by representing the [Level] and `index`. Examples:
//! the [Address] of `c` is at [Level] 1 and index 1, the [Address] of `f` is at [Level] 0,
//! index 2.
//!
//! **Relationship Abstractions:**
//!
//! A given node has these navigational relationships:
//!
//! - `parent` - the node directly above at one higher [Level].
//! - `child` - the complementary relationship to parent; a parent may have up to two children because only binary trees are supported.
//! - `child` - the complementary relationship to parent; a parent may have up to two children
//! because only binary trees are supported.
//! - `sibling` - the other node with the same parent.
//! - `cousin` - a node at the same [Level] excluding the sibling.
//! - `emmer` - the parent's sibling.
//! - `ommer` - the parent's sibling.
//! - `root` - the single node with the largest [Level].
//! - `ancestor` - the parent or an ancestor of the parent; the root is an ancestor of every other node.
//! - `ancestor` - the parent or an ancestor of the parent; the root is an ancestor of every
//! other node.
//!
//! Note: we often refer to `emmers` (plural) when describing leaf-to-root paths, so in that context `emmers` refers to the node's emmer, plus each ancestor's emmer.
//! Note: we often refer to `ommers` (plural) when describing leaf-to-root paths, so in that
//! context `ommers` refers to the node's ommer, plus each ancestor's ommer.
use either::Either;
use std::cmp::Ordering;