From dfb073f784670115adf9a1cdf205aab5aa0b5346 Mon Sep 17 00:00:00 2001 From: "Augusto F. Hack" Date: Wed, 22 Feb 2023 14:29:02 +0100 Subject: [PATCH] docs: mention tree form order of NodeIndex docs --- src/merkle/index.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/merkle/index.rs b/src/merkle/index.rs index 95d7123..1b47aab 100644 --- a/src/merkle/index.rs +++ b/src/merkle/index.rs @@ -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,