Struct simplicity::NodeBounds

pub struct NodeBounds {
    pub extra_cells: usize,
    pub extra_frames: usize,
    pub cost: Cost,
}

Bounds on the resources required by a node during execution on the Bit Machine

Fields

extra_cells: usize

Upper bound on the required number of cells (bits). The root additionally requires the bit width of its source and target type (input, output)

extra_frames: usize

Upper bound on the required number of frames (sum of read and write frames). The root additionally requires two frames (input, output)

cost: Cost

CPU cost

Implementations

impl NodeBounds

pub fn iden(target_type: usize) -> NodeBounds

Node bounds for an iden node

pub const fn unit() -> NodeBounds

Node bounds for a unit node

pub fn injl(child: Self) -> NodeBounds

Node bounds for an injl node

pub fn injr(child: Self) -> NodeBounds

Node bounds for an injr node

pub fn take(child: Self) -> NodeBounds

Node bounds for a take node

pub fn drop(child: Self) -> NodeBounds

Node bounds for a drop node

pub fn comp(left: Self, right: Self, mid_ty_bit_width: usize) -> NodeBounds

Node bounds for a comp node

pub fn case(left: Self, right: Self) -> NodeBounds

Node bounds for a case node

pub fn assertl(child: Self) -> NodeBounds

Node bounds for a assertl node

pub fn assertr(child: Self) -> NodeBounds

Node bounds for a assertr node

pub fn pair(left: Self, right: Self) -> NodeBounds

Node bounds for a pair node

pub fn disconnect( left: Self, right: Self, left_target_b_bit_width: usize, left_source_bit_width: usize, left_target_bit_width: usize ) -> NodeBounds

Node bounds for a disconnect node

pub fn witness(target_ty_bit_width: usize) -> NodeBounds

Node bounds for an arbitrary jet node

pub fn jet<J: Jet>(jet: J) -> NodeBounds

Node bounds for an arbitrary jet node

pub fn const_word(value: &Value) -> NodeBounds

Node bounds for an arbitrary constant word node

pub const fn fail() -> NodeBounds

Node bounds for a fail node.

This is a bit of a silly constructor because if a fail node is actually executed in the bit machine, it will fail instantly, while if it isn’t executed, it will fail the “no unexecuted nodes” check. But to analyze arbitrary programs, we need it.

Trait Implementations

impl Clone for NodeBounds

fn clone(&self) -> NodeBounds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeBounds

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

Formats the value using the given formatter.

impl Hash for NodeBounds

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NodeBounds

fn cmp(&self, other: &NodeBounds) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NodeBounds

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for NodeBounds

fn partial_cmp(&self, other: &NodeBounds) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NodeBounds

impl Eq for NodeBounds

impl StructuralPartialEq for NodeBounds