Struct miden_core::ProgramOutputs

pub struct ProgramOutputs { /* private fields */ }

Output container for Miden VM programs.

Miden program outputs contain the full state of the stack at the end of execution as well as the addresses in the overflow table which are required to reconstruct the table (when combined with the overflow values from the stack state).

stack is expected to be ordered as if they elements were popped off the stack one by one. Thus, the value at the top of the stack is expected to be in the first position, and the order of the rest of the output elements will also match the order on the stack.

overflow_addrs is expected to start with the prev address value from the first row in the overflow table (the row representing the deepest element in the stack) and then be followed by the address (clk value) of each row in the table starting from the deepest element in the stack and finishing with the row which was added to the table last.

Implementations

impl ProgramOutputs

pub fn new(stack: Vec<u64>, overflow_addrs: Vec<u64>) -> Self

pub fn from_elements(stack: Vec<Felt>, overflow_addrs: Vec<Felt>) -> Self

pub fn stack(&self) -> &[u64]

Returns the stack outputs, which is state of the stack at the end of execution converted to integers.

pub fn stack_outputs(&self, num_outputs: usize) -> &[u64]

Returns the number of requested stack outputs or returns the full stack if fewer than the requested number of stack values exist.

pub fn stack_top(&self) -> StackTopState

Returns the state of the top of the stack at the end of execution.

pub fn overflow_addrs(&self) -> &[u64]

Returns the overflow address outputs, which are the addresses required to reconstruct the overflow table (when combined with the stack overflow values) converted to integers.

pub fn has_overflow(&self) -> bool

Returns true if the overflow table outputs are non-empty.

pub fn overflow_prev(&self) -> Felt

Returns the previous address prev for the first row in the stack overflow table

pub fn stack_overflow(&self) -> Vec<(Felt, Felt)>

Returns (address, value) for all rows which were on the overflow table at the end of execution in the order in which they were added to the table (deepest stack item first).

pub fn stack_mut(&mut self) -> &mut [u64]

Returns mutable access to the stack outputs, to be used for testing or running examples. TODO: this should be marked with #[cfg(test)] attribute, but that currently won’t work with the integration test handler util.

Trait Implementations

impl Clone for ProgramOutputs

fn clone(&self) -> ProgramOutputs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProgramOutputs

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

Formats the value using the given formatter.

impl Default for ProgramOutputs

fn default() -> ProgramOutputs

Returns the “default value” for a type.