Struct OpStack

pub struct OpStack {
    pub stack: Vec<BFieldElement>,
    /* private fields */
}

The operational stack of Triton VM. It always contains at least OpStackElement::COUNT elements. Initially, the bottom-most Digest::LEN elements equal the digest of the program being executed. The remaining elements are initially 0.

The OpStack is represented as one contiguous piece of memory, and Triton VM uses it as such. For reasons of arithmetization, however, there is a distinction between the op-stack registers and the op-stack underflow memory. The op-stack registers are the first OpStackElement::COUNT elements of the op-stack, and the op-stack underflow memory is the remaining elements.

Fields

stack: Vec<BFieldElement>

The underlying, actual stack. When manually accessing, be aware of reversed indexing: while op_stack[0] is the top of the stack, op_stack.stack[0] is the lowest element in the stack.

Implementations

impl OpStack

pub fn new(program_digest: Digest) -> Self

pub fn len(&self) -> usize

pub fn push(&mut self, element: BFieldElement)

pub fn pop(&mut self) -> Result<BFieldElement, OpStackError>

pub fn insert(&mut self, index: OpStackElement, element: BFieldElement)

pub fn remove(&mut self, index: OpStackElement) -> BFieldElement

pub fn start_recording_underflow_io_sequence(&mut self)

pub fn stop_recording_underflow_io_sequence(&mut self) -> Vec<UnderflowIO>

pub fn push_extension_field_element(&mut self, element: XFieldElement)

pub fn pop_extension_field_element( &mut self, ) -> Result<XFieldElement, OpStackError>

pub fn is_u32(&self, stack_element: OpStackElement) -> Result<(), OpStackError>

pub fn get_u32( &self, stack_element: OpStackElement, ) -> Result<u32, OpStackError>

pub fn pop_u32(&mut self) -> Result<u32, OpStackError>

pub fn pop_multiple<const N: usize>( &mut self, ) -> Result<[BFieldElement; N], OpStackError>

pub fn peek_at_top_extension_field_element(&self) -> XFieldElement

pub fn would_be_too_shallow(&self, stack_delta: i32) -> bool

pub fn pointer(&self) -> BFieldElement

The address of the next free address of the op-stack. Equivalent to the current length of the op-stack.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for OpStack

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for OpStack

fn clone(&self) -> OpStack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpStack

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpStack

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<OpStackElement> for OpStack

type Output = BFieldElement

The returned type after indexing.

fn index(&self, stack_element: OpStackElement) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for OpStack

type Output = BFieldElement

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<OpStackElement> for OpStack

fn index_mut(&mut self, stack_element: OpStackElement) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for OpStack

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for OpStack

type Item = BFieldElement

The type of the elements being iterated over.

type IntoIter = IntoIter<<OpStack as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for OpStack

fn eq(&self, other: &OpStack) -> 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 Serialize for OpStack

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OpStack

impl StructuralPartialEq for OpStack