Struct 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: &Word) -> Option<&[Felt]>

Returns the values associated with given key.

pub fn insert(&mut self, key: Word, 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: &Word) -> Option<Vec<Felt>>

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

pub fn len(&self) -> usize

Returns the number of key value pairs in the advice map.

pub fn is_empty(&self) -> bool

Returns true if the advice map is empty.

pub fn merge_advice_map( &mut self, other: &AdviceMap, ) -> Result<(), ((Word, Vec<Felt>), Vec<Felt>)>

Merges all entries from the given AdviceMap into the current advice map.

If an entry from the new map already exists with the same key but different value, an error is returned containing the existing entry along with the value that would replace it. The current map remains unchanged.

Trait Implementations

impl Clone for AdviceMap

fn clone(&self) -> AdviceMap

Returns a duplicate 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 Deserializable for AdviceMap

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

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

fn extend<T: IntoIterator<Item = (Word, 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<Word, Vec<BaseElement>>> for AdviceMap

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

Converts to this type from the input type.

impl FromIterator<(Word, Vec<BaseElement>)> for AdviceMap

fn from_iter<T: IntoIterator<Item = (Word, Vec<Felt>)>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for AdviceMap

type Item = (Word, Vec<BaseElement>)

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl KvMap<Word, Vec<BaseElement>> for AdviceMap

fn get(&self, key: &Word) -> Option<&Vec<Felt>>

fn contains_key(&self, key: &Word) -> bool

fn len(&self) -> usize

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

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

fn iter(&self) -> Box<dyn Iterator<Item = (&Word, &Vec<Felt>)> + '_>

fn is_empty(&self) -> bool

impl PartialEq for AdviceMap

fn eq(&self, other: &AdviceMap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for AdviceMap

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for AdviceMap

impl StructuralPartialEq for AdviceMap