openvm_stark_backend::interaction

Struct PermutationCheckBus

Source
pub struct PermutationCheckBus {
    pub index: BusIndex,
}
Expand description

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§

Source§

impl PermutationCheckBus

Source

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

Source

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.

Source

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.

Source

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.

Source

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§

Source§

impl Clone for PermutationCheckBus

Source§

fn clone(&self) -> PermutationCheckBus

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PermutationCheckBus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PermutationCheckBus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PermutationCheckBus

Source§

impl Eq for PermutationCheckBus

Source§

impl StructuralPartialEq for PermutationCheckBus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more