binius_core::merkle_tree

Struct MerkleTree

source
pub struct MerkleTree<D> {
    pub log_len: usize,
    pub batch_size: usize,
    pub inner_nodes: Vec<D>,
    pub cap_height: usize,
}
Expand description

A binary Merkle tree that commits batches of vectors.

The vector entries at each index in a batch are hashed together into leaf digests. Then a Merkle tree is constructed over the leaf digests. The implementation requires that the vector lengths are all equal to each other and a power of two.

Fields§

§log_len: usize

Base-2 logarithm of the number of leaves

§batch_size: usize

Number of vectors that are committed in this batch

§inner_nodes: Vec<D>

The inner nodes, arranged as a flattened array of layers with the root at the end

§cap_height: usize

cap_height-th layer of the tree

Implementations§

source§

impl<D> MerkleTree<D>
where D: Copy + Default + Send + Sync,

source

pub fn build<P, H, C>( compression: &C, log_len: usize, leaves: &[impl AsRef<[P]>], cap_height: usize, ) -> Result<Self, Error>
where P: PackedField + Sync, H: Hasher<P, Digest = D> + Send, C: PseudoCompressionFunction<D, 2> + Sync,

source

pub fn get_cap(&self) -> &[D]

Get the cap_height-th layer of the tree

source

pub fn branch(&self, index: usize) -> Result<Vec<D>, Error>

Get a Merkle branch for the given index

Throws if the index is out of range

source

pub fn truncated_branch(&self, indices: Range<usize>) -> Result<Vec<D>, Error>

Get a truncated Merkle branch for the given range corresponding to the subtree

Throws if the index is out of range

Trait Implementations§

source§

impl<D: Clone> Clone for MerkleTree<D>

source§

fn clone(&self) -> MerkleTree<D>

Returns a copy of the value. Read more
1.6.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<D: Debug> Debug for MerkleTree<D>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<D> Freeze for MerkleTree<D>

§

impl<D> RefUnwindSafe for MerkleTree<D>
where D: RefUnwindSafe,

§

impl<D> Send for MerkleTree<D>
where D: Send,

§

impl<D> Sync for MerkleTree<D>
where D: Sync,

§

impl<D> Unpin for MerkleTree<D>
where D: Unpin,

§

impl<D> UnwindSafe for MerkleTree<D>
where D: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more