Skip to main content

IRGroup

Struct IRGroup 

Source
pub struct IRGroup<E> { /* private fields */ }
Expand description

Body of a group.

Implementations§

Source§

impl<E> IRGroup<E>

Source

pub fn new(name: String, id: usize) -> Self

Creates a new empty group.

Source

pub fn with_input_count(self, input_count: usize) -> Self

Updates the input count of the group.

Source

pub fn with_output_count(self, output_count: usize) -> Self

Updates the output count of the group.

Source

pub fn with_key(self, key: Option<GroupKey>) -> Self

Updates the group key.

Source

pub fn no_key(self) -> Self

Removes the group key.

Source

pub fn with_gates(self, gates: impl IntoIterator<Item = IRStmt<E>>) -> Self

Updates the IR of the PLONK gates.

Source

pub fn with_copy_constraints( self, constraints: impl IntoIterator<Item = IRStmt<E>>, ) -> Self

Updates the IR of the copy constraints.

Source

pub fn with_callsites( self, callsites: impl IntoIterator<Item = CallSite<E>>, ) -> Self

Adds a callsite to the group.

Source

pub fn with_lookups(self, lookups: impl IntoIterator<Item = IRStmt<E>>) -> Self

Updates the IR of the lookups.

Source

pub fn inject(&mut self, ir: IRStmt<E>)

Injects IR into the body of the group.

Source

pub fn injected_count(&self) -> usize

Returns the number of statements injected into this group.

Source

pub fn do_debug_comments(self, do_it: bool) -> Self

Sets the flag that control the generation of debug comments.

Source

pub fn is_main(&self) -> bool

Returns true if the group is the top-level.

Source

pub fn name(&self) -> &str

Returns the name of the group.

Source

pub fn name_mut(&mut self) -> &mut String

Returns a mutable reference to the group’s name.

Source

pub fn id(&self) -> usize

Returns the id of the group.

Source

pub fn set_id(&mut self, id: usize)

Sets the id of the group.

Source

pub fn input_count(&self) -> usize

Returns the number of inputs.

Source

pub fn output_count(&self) -> usize

Returns the number of outputs.

Source

pub fn key(&self) -> Option<GroupKey>

Returns the key of the group.

Source

pub fn callsites(&self) -> &[CallSite<E>]

Returns a referece to the callsites.

Source

pub fn callsites_mut(&mut self) -> &mut Vec<CallSite<E>>

Returns a mutable referece to the callsites.

Source

pub fn statements(&self) -> impl Iterator<Item = &IRStmt<E>>

Returns an iterator with all the IRStmt in the group.

Source

pub fn try_map<O, Err>( self, f: &mut impl FnMut(E) -> Result<O, Err>, ) -> Result<IRGroup<O>, Err>

Tries to convert the inner expression type to another.

Source

pub fn eq_constraints_mut(&mut self) -> &mut IRStmt<E>

Returns a mutable reference to the copy constraints.

Trait Implementations§

Source§

impl<E> Canonicalize for IRGroup<E>

Source§

fn canonicalize(&mut self)

Canonicalizes the object in-place.
Source§

fn canonicalized(self) -> Self
where Self: Sized,

Transforms the object into its canonical version.
Source§

impl<E: Clone> Clone for IRGroup<E>

Source§

fn clone(&self) -> IRGroup<E>

Returns a duplicate 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<E: ConstantFolding> ConstantFolding for IRGroup<E>

Source§

type Error = ConstantFoldingError<E>

Error type.
Source§

type T = ()

Object’s type for constants.
Source§

fn constant_fold(&mut self) -> Result<(), Self::Error>

Folds the object in-place.
Source§

fn constant_folded(self) -> Result<Self, Self::Error>
where Self: Sized,

Moves the object after folding it.
Source§

fn const_value(&self) -> Option<Self::T>

May return the object as a constant value.
Source§

impl<E: Debug> Debug for IRGroup<E>

Source§

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

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

impl<E> EqvRelation<IRGroup<E>> for SymbolicEqv

Source§

fn equivalent(lhs: &IRGroup<E>, rhs: &IRGroup<E>) -> bool

Two groups are equivalent if the code they represent is equivalent and have the same key.

Special case is main which is never equivalent to anything.

Source§

impl<E: IRPrintable> IRPrintable for IRGroup<E>

Source§

fn fmt(&self, ctx: &mut IRPrinterCtx<'_, '_>) -> Result

Format the IR object using the given context.
Source§

fn depth(&self) -> usize

Computes the depth of the IR tree to give hints to the printer.
Source§

impl<E> LowerableStmt for IRGroup<E>

Source§

fn lower<L>(self, l: &L) -> Result<()>
where L: Lowering + ?Sized,

Emits a statement from the value.
Source§

impl<E> Validatable for IRGroup<E>
where IRStmt<E>: Validatable<Diagnostic = SimpleDiagnostic, Context = ()>,

Source§

type Diagnostic = SimpleDiagnostic

The type used to represent diagnostics.
Source§

type Context = [IRGroup<E>]

Context necessary for validating the IR.
Source§

fn validate_with_context( &self, groups: &Self::Context, ) -> Result<Vec<Self::Diagnostic>, Vec<Self::Diagnostic>>

Performs validation checks, returning either Ok with a list of non-error diagnostics or Err with a list of all the diagnostics.

Auto Trait Implementations§

§

impl<E> Freeze for IRGroup<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for IRGroup<E>
where E: RefUnwindSafe,

§

impl<E> Send for IRGroup<E>
where E: Send,

§

impl<E> Sync for IRGroup<E>
where E: Sync,

§

impl<E> Unpin for IRGroup<E>
where E: Unpin,

§

impl<E> UnwindSafe for IRGroup<E>
where E: UnwindSafe,

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, dest: *mut u8)

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

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T, O> EquivalentTo<O> for T

Source§

fn is_equiv<E>(&self, other: &O) -> bool
where E: EqvRelation<T, O>,

Returns true if self is equivalent to other.
Source§

impl<L, R, E> EqvRelation<&[L], &[R]> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &&[L], rhs: &&[R]) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<&L, &R> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &&L, rhs: &&R) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<&mut L, &mut R> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &&mut L, rhs: &&mut R) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E, const N: usize> EqvRelation<[L; N], [R; N]> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &[L; N], rhs: &[R; N]) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<Box<L>, Box<R>> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Box<L>, rhs: &Box<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<'l, 'r, L, R, E> EqvRelation<Cow<'l, L>, Cow<'r, R>> for E
where L: ToOwned, R: ToOwned, E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Cow<'l, L>, rhs: &Cow<'r, R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<Option<L>, Option<R>> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Option<L>, rhs: &Option<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<Rc<L>, Rc<R>> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Rc<L>, rhs: &Rc<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, LErr, R, RErr, E> EqvRelation<Result<L, LErr>, Result<R, RErr>> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Result<L, LErr>, rhs: &Result<R, RErr>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<L, R, E> EqvRelation<Vec<L>, Vec<R>> for E
where E: EqvRelation<L, R>,

Source§

fn equivalent(lhs: &Vec<L>, rhs: &Vec<R>) -> bool

Returns true if L and R are equivalent under the implementation’s definition of equivalency.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.