Struct PermutationCheckBus

pub struct PermutationCheckBus {
    pub index: BusIndex,
}

A PermutationCheckBus bus is used to establish that two multi-sets of values are equal.

Soundness requires that both the total number of messages sent and received over the bus per message is at most the field characteristic.

Fields

index: BusIndex

Implementations

impl PermutationCheckBus

pub const fn new(index: BusIndex) -> Self

pub fn send<AB, E>( &self, builder: &mut AB, message: impl IntoIterator<Item = E>, enabled: impl Into<AB::Expr>, )

where AB: InteractionBuilder, E: Into<AB::Expr>,

Send a message.

Caller must constrain enabled to be boolean.

pub fn receive<AB, E>( &self, builder: &mut AB, message: impl IntoIterator<Item = E>, enabled: impl Into<AB::Expr>, )

where AB: InteractionBuilder, E: Into<AB::Expr>,

Receive a message.

Caller must constrain enabled to be boolean.

pub fn send_or_receive<AB, E>( &self, builder: &mut AB, interaction_type: PermutationInteractionType, message: impl IntoIterator<Item = E>, enabled: impl Into<AB::Expr>, )

where AB: InteractionBuilder, E: Into<AB::Expr>,

Send or receive determined by interaction_type.

Caller must constrain enabled to be boolean.

pub fn interact<AB, E>( &self, builder: &mut AB, message: impl IntoIterator<Item = E>, direction: impl Into<AB::Expr>, )

where AB: InteractionBuilder, E: Into<AB::Expr>,

Send or receive a message determined by the expression direction.

Direction = 1 means send, direction = -1 means receive, and direction = 0 means disabled.

Caller must constrain that direction is in {-1, 0, 1}.

Trait Implementations

impl Clone for PermutationCheckBus

fn clone(&self) -> PermutationCheckBus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PermutationCheckBus

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

Formats the value using the given formatter.

impl PartialEq for PermutationCheckBus

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

impl Eq for PermutationCheckBus

impl StructuralPartialEq for PermutationCheckBus