Struct VM

pub struct VM;

Implementations

impl VM

pub fn run( program: Program, public_input: PublicInput, non_determinism: NonDeterminism, ) -> Result<Vec<BFieldElement>, VMError>

Run Triton VM on the Program with the given public input and non-determinism. If an error is encountered, the returned VMError contains the VMState at the point of execution failure.

See also trace_execution and profile.

pub fn trace_execution( program: Program, public_input: PublicInput, non_determinism: NonDeterminism, ) -> Result<(AlgebraicExecutionTrace, Vec<BFieldElement>), VMError>

Trace the execution of a Program. That is, run the Program and additionally record that part of every encountered state that is necessary for proving correct execution. If execution succeeds, returns

1. an AlgebraicExecutionTrace, and
2. the output of the program.

See also run and profile.

pub fn trace_execution_of_state( state: VMState, ) -> Result<(AlgebraicExecutionTrace, VMState), VMError>

Trace the execution of a Program from a given VMState. Consider using trace_execution, unless you know this is what you want.

Returns the AlgebraicExecutionTrace and the terminal VMState if execution succeeds.

pub fn profile( program: Program, public_input: PublicInput, non_determinism: NonDeterminism, ) -> Result<(Vec<BFieldElement>, ExecutionTraceProfile), VMError>

Run Triton VM with the given public and secret input, recording the influence of a callable block of instructions on the AlgebraicExecutionTrace. For example, this can be used to identify the number of clock cycles spent in some block of instructions, or how many rows it contributes to the U32 Table.

See also run and trace_execution.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for VM

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.

impl Clone for VM

fn clone(&self) -> VM

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VM

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VM

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VM

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for VM

impl Eq for VM

impl StructuralPartialEq for VM