Merge pull request #74 from 0xPolygonMiden/hacka-node-index-docs

docs: mention tree form order of NodeIndex docs
This commit is contained in:
Bobbin Threadbare 2023-02-22 12:19:45 -08:00 committed by GitHub
commit ae3f14e0ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,6 +4,9 @@ use super::{Felt, MerkleError, RpoDigest, StarkField};
// ================================================================================================
/// A Merkle tree address to an arbitrary node.
///
/// The position is relative to a tree in level order, where for a given depth `d` elements are
/// numbered from $0..2^d$.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Hash)]
pub struct NodeIndex {
depth: u8,