Struct miden_processor::AdviceMap

pub struct AdviceMap(/* private fields */);

Defines a set of non-deterministic (advice) inputs which the VM can access by their keys.

Each key maps to one or more field element. To access the elements, the VM can move the values associated with a given key onto the advice stack using adv.push_mapval instruction. The VM can also insert new values into the advice map during execution.

Implementations

impl AdviceMap

pub fn new() -> Self

Creates a new advice map.

pub fn get(&self, key: &RpoDigest) -> Option<&[Felt]>

Returns the values associated with given key.

pub fn insert(&mut self, key: RpoDigest, value: Vec<Felt>) -> Option<Vec<Felt>>

Inserts a key value pair in the advice map and returns the inserted value.

pub fn remove(&mut self, key: RpoDigest) -> Option<Vec<Felt>>

Removes the value associated with the key and returns the removed element.

Trait Implementations

impl Clone for AdviceMap

fn clone(&self) -> AdviceMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceMap

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

Formats the value using the given formatter.

impl Default for AdviceMap

fn default() -> AdviceMap

Returns the “default value” for a type.

impl Extend<(RpoDigest, Vec<BaseElement>)> for AdviceMap

fn extend<T: IntoIterator<Item = (RpoDigest, Vec<Felt>)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<BTreeMap<RpoDigest, Vec<BaseElement>>> for AdviceMap

fn from(value: BTreeMap<RpoDigest, Vec<Felt>>) -> Self

Converts to this type from the input type.

impl IntoIterator for AdviceMap

type Item = (RpoDigest, Vec<BaseElement>)

The type of the elements being iterated over.

type IntoIter = IntoIter<RpoDigest, Vec<BaseElement>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.