Struct SplitNode 

pub struct SplitNode { /* private fields */ }

A Split node defines conditional execution. When the VM encounters a Split node it executes either the on_true child or on_false child.

Which child is executed is determined based on the top of the stack. If the value is 1, then the on_true child is executed. If the value is 0, then the on_false child is executed. If the value is neither 0 nor 1, the execution fails.

Implementations

impl SplitNode

Constants

pub const DOMAIN: Felt

The domain of the split node (used for control block hashing).

impl SplitNode

Constructors

pub fn new( branches: [MastNodeId; 2], mast_forest: &MastForest, ) -> Result<Self, MastForestError>

pub fn new_unsafe(branches: [MastNodeId; 2], digest: Word) -> Self

Returns a new SplitNode from values that are assumed to be correct. Should only be used when the source of the inputs is trusted (e.g. deserialization).

impl SplitNode

Public accessors

pub fn on_true(&self) -> MastNodeId

Returns the ID of the node which is to be executed if the top of the stack is 1.

pub fn on_false(&self) -> MastNodeId

Returns the ID of the node which is to be executed if the top of the stack is 0.

Trait Implementations

impl Clone for SplitNode

fn clone(&self) -> SplitNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitNode

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

Formats the value using the given formatter.

impl From<SplitNode> for MastNode

fn from(v: SplitNode) -> MastNode

Converts to this type from the input type.

impl MastNodeErrorContext for SplitNode

fn decorators(&self) -> impl Iterator<Item = (usize, DecoratorId)>

The list of decorators tied to this node, along with their associated index.

fn get_assembly_op<'m>( &self, mast_forest: &'m MastForest, target_op_idx: Option<usize>, ) -> Option<&'m AssemblyOp>

Returns the AssemblyOp associated with this node and operation (if provided), if any.

impl MastNodeExt for SplitNode

fn digest(&self) -> Word

Returns a commitment to this Split node.

The commitment is computed as a hash of the on_true and on_false child nodes in the domain defined by Self::DOMAIN - i..e,:

Hasher::merge_in_domain(&[on_true_digest, on_false_digest], SplitNode::DOMAIN);

fn before_enter(&self) -> &[DecoratorId]

Returns the decorators to be executed before this node is executed.

fn after_exit(&self) -> &[DecoratorId]

Returns the decorators to be executed after this node is executed.

fn append_before_enter(&mut self, decorator_ids: &[DecoratorId])

Sets the list of decorators to be executed before this node.

fn append_after_exit(&mut self, decorator_ids: &[DecoratorId])

Sets the list of decorators to be executed after this node.

fn remove_decorators(&mut self)

Removes all decorators from this node.

fn to_display<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn Display + 'a>

Returns a display formatter for this node.

fn to_pretty_print<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn PrettyPrint + 'a>

Returns a pretty printer for this node.

fn remap_children(&self, remapping: &Remapping) -> Self

Remap the node children to their new positions indicated by the given Remapping.

fn has_children(&self) -> bool

Returns true if the this node has children.

fn append_children_to(&self, target: &mut Vec<MastNodeId>)

Appends the NodeIds of the children of this node, if any, to the vector.

fn domain(&self) -> Felt

Returns the domain of this node.

impl PartialEq for SplitNode

fn eq(&self, other: &SplitNode) -> 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 TryInto<SplitNode> for MastNode

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SplitNode, <Self as TryInto<SplitNode>>::Error>

Performs the conversion.

impl Eq for SplitNode

impl StructuralPartialEq for SplitNode