Skip to content

Commit

Permalink
docs: SimpleSmt::compute_mutations note
Browse files Browse the repository at this point in the history
  • Loading branch information
krushimir committed Jan 27, 2025
1 parent c1bcd6d commit 11ad605
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/merkle/smt/simple/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,10 @@ impl<const DEPTH: u8> SimpleSmt<DEPTH> {
/// [`SimpleSmt::apply_mutations()`] can be called in order to commit these changes to the
/// Merkle tree, or [`drop()`] to discard them.
///
/// **Note:** Parallel computation is only supported for trees whose depth is a multiple of 8.
/// Since `SimpleSmt` can have a depth that isn't a multiple of 8, this method defaults to the
/// sequential implementation to ensure correctness.
///
/// # Example
/// ```
/// # use miden_crypto::{hash::rpo::RpoDigest, Felt, Word};
Expand Down

0 comments on commit 11ad605

Please sign in to comment.