Struct Final

pub struct Final { /* private fields */ }

Data related to a finalized type, which can be extracted from a super::Type if (and only if) it is finalized.

Implementations

impl Final

pub fn unit() -> Arc<Self>

Create the unit type.

pub fn two_two_n(n: usize) -> Arc<Self>

Create the type 2^(2^n) for the given n.

The type is precomputed and fast to access.

pub fn u1() -> Arc<Self>

Create the type of 1-bit words.

The type is precomputed and fast to access.

pub fn u2() -> Arc<Self>

Create the type of 2-bit words.

The type is precomputed and fast to access.

pub fn u4() -> Arc<Self>

Create the type of 4-bit words.

The type is precomputed and fast to access.

pub fn u8() -> Arc<Self>

Create the type of 8-bit words.

The type is precomputed and fast to access.

pub fn u16() -> Arc<Self>

Create the type of 16-bit words.

The type is precomputed and fast to access.

pub fn u32() -> Arc<Self>

Create the type of 32-bit words.

The type is precomputed and fast to access.

pub fn u64() -> Arc<Self>

Create the type of 64-bit words.

The type is precomputed and fast to access.

pub fn u128() -> Arc<Self>

Create the type of 128-bit words.

The type is precomputed and fast to access.

pub fn u256() -> Arc<Self>

Create the type of 256-bit words.

The type is precomputed and fast to access.

pub fn u512() -> Arc<Self>

Create the type of 512-bit words.

The type is precomputed and fast to access.

pub fn sum(left: Arc<Self>, right: Arc<Self>) -> Arc<Self>

Create the sum of the given left and right types.

pub fn product(left: Arc<Self>, right: Arc<Self>) -> Arc<Self>

Create the product of the given left and right types.

pub fn tmr(&self) -> Tmr

Accessor for the TMR

pub fn bit_width(&self) -> usize

Accessor for the Bit Machine bit-width of the type

pub fn has_padding(&self) -> bool

Whether the type’s bit representation has any padding.

If this is true, then its “compact” witness-encoded bit-width may be lower than its “padded” bit-machine bit-width.

pub fn is_empty(&self) -> bool

Check if the type is a nested product of units. In this case, values contain no information.

pub fn bound(&self) -> &CompleteBound

Accessor for the type bound

pub fn is_unit(&self) -> bool

Check if the type is a unit.

pub fn as_sum(&self) -> Option<(&Arc<Self>, &Arc<Self>)>

Access the inner types of a sum type.

pub fn as_product(&self) -> Option<(&Arc<Self>, &Arc<Self>)>

Access the inner types of a product type.

pub fn as_word(&self) -> Option<u32>

If the type is of the form TWO^(2^n), then return n.

Post condition

0 ≤ n < 32.

pub fn pad_left(&self, other: &Self) -> usize

Compute the padding of left values of the sum type Self + Other.

pub fn pad_right(&self, other: &Self) -> usize

Compute the padding of right values of the sum type Self + Other.

Trait Implementations

impl Clone for Final

fn clone(&self) -> Final

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DagLike for &Final

type Node = Final

The type of the DAG node, with no references or wrappers

fn data(&self) -> &Final

A pointer to the underlying data

fn as_dag_node(&self) -> Dag<Self>

Interpret the node as a DAG node

fn left_child(&self) -> Option<Self>

Accessor for the left child of the node, if one exists

fn right_child(&self) -> Option<Self>

Accessor for the right child of the node, if one exists

fn n_children(&self) -> usize

Number of children that the node has.

fn rtl_post_order_iter<S: SharingTracker<SwapChildren<Self>> + Default>( self, ) -> RtlPostOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in right-to-left post order.

fn pre_order_iter<S: SharingTracker<Self> + Default>( self, ) -> PreOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in pre-order.

fn verbose_pre_order_iter<S: SharingTracker<Self> + Default>( self, max_depth: Option<usize>, ) -> VerbosePreOrderIter<Self, S>

where Self: Clone,

Obtains a verbose iterator of all the nodes rooted at the DAG, in pre-order.

fn post_order_iter<S: SharingTracker<Self> + Default>( self, ) -> PostOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in post order.

fn is_shared_as<S: SharingTracker<Self> + Default>(self) -> bool

where Self: Clone,

Checks whether a DAG’s internal sharing (as expressed by shared pointers) matches the given target sharing.

fn post_order_iter_with_tracker<S: SharingTracker<Self>>( self, tracker: S, ) -> PostOrderIter<Self, S>

Obtains an post-order iterator of all the nodes rooted at DAG, using the given tracker.

impl Debug for Final

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

Formats the value using the given formatter.

impl Display for Final

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

Formats the value using the given formatter.

impl Hash for Final

fn hash<H: Hasher>(&self, hasher: &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 Final

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

Restrict a value to a certain interval.

impl PartialEq for Final

fn eq(&self, other: &Self) -> 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 PartialOrd for Final

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Final