docs: mention tree form order of NodeIndex docs

This commit is contained in:
Augusto F. Hack 2023-02-22 14:29:02 +01:00
parent 85ba3f1a34
commit dfb073f784
No known key found for this signature in database
GPG key ID: 3F3584B7FB1DFB76

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,