Skip to main content

AssignedVector

midnight_circuits::vec::vector

Struct AssignedVector 

Source 
pub struct AssignedVector<F: CircuitField, T: Vectorizable, const M: usize, const A: usize> { /* private fields */ }
Expand description

A variable-length vector of elements of type T, with size bound M.

  • len is the (potentially secret) effective length of the vector, its value is guaranteed to be in the range [0, M].
  • buffer is the padded payload of this vector; it contains the effective data of the vector as well as filler values, which are UNCONSTRAINED.

The effective payload in the data is aligned in A sized chunks. This enables more efficient implementations of instructions like hashing over this type. As a result of this alignment, the data may contain filler values before and after the effective payload. The padding in front of the payload will always be 0 mod A, so that the payload begins aligned in A sized chunks. The padding at the end of the payload will have a size in [0, A) such that | front_pad | + | payload | + | back_pad | = M.

Invariant: M must be a multiple of A (and A > 0, M >= A). Several operations (padding_flag, get_limits, hashing, …) rely on this to guarantee that the buffer decomposes into exactly M / A full chunks and that a full-capacity vector (len == M) can always be placed without overflow. This is enforced by the entry points assign_with_filler and assign.

Trait Implementations§

Source§

impl<F, T, const M: usize, const A: usize> AssertionInstructions<F, AssignedVector<F, T, M, A>> for VectorGadget<F>
where F: CircuitField, T: Vectorizable, T::Element: Copy, Self: VectorInstructions<F, T, M, A> + EqualityInstructions<F, AssignedVector<F, T, M, A>>, NativeGadget<F, P2RDecompositionChip<F>, NativeChip<F>>: ArithInstructions<F, AssignedNative<F>> + EqualityInstructions<F, T> + EqualityInstructions<F, AssignedNative<F>> + AssertionInstructions<F, AssignedBit<F>> + AssertionInstructions<F, T> + BinaryInstructions<F>,

Source§

fn assert_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, y: &AssignedVector<F, T, M, A>, ) -> Result<(), Error>

Ensures that the given assigned elements are the same. Read more
Source§

fn assert_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, y: &AssignedVector<F, T, M, A>, ) -> Result<(), Error>

Ensures that the given assigned elements are different. Read more
Source§

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, constant: <AssignedVector<F, T, M, A> as InnerValue>::Element, ) -> Result<(), Error>

Ensures that the given assigned element is equal to the given constant. Read more
Source§

fn assert_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, constant: <AssignedVector<F, T, M, A> as InnerValue>::Element, ) -> Result<(), Error>

Ensures that the given assigned element is different from the given constant. Read more
Source§

impl<F, const M: usize, T, const A: usize> AssignmentInstructions<F, AssignedVector<F, T, M, A>> for VectorGadget<F>
where F: CircuitField, T: Vectorizable, T::Element: Copy, Self: VectorInstructions<F, T, M, A>,

Source§

fn assign_fixed( &self, _layouter: &mut impl Layouter<F>, _constant: <AssignedVector<F, T, M, A> as InnerValue>::Element, ) -> Result<AssignedVector<F, T, M, A>, Error>

Assigns a fixed (constant) element. Read more
Source§

fn assign( &self, layouter: &mut impl Layouter<F>, value: Value<<AssignedVector<F, T, M, A> as InnerValue>::Element>, ) -> Result<AssignedVector<F, T, M, A>, Error>

Assigns an element as a private input to the circuit. Read more
Source§

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<Assigned::Element>], ) -> Result<Vec<Assigned>, Error>

Assigns several elements as private inputs to the circuit. Read more
Source§

fn assign_many_fixed( &self, layouter: &mut impl Layouter<F>, values: &[Assigned::Element], ) -> Result<Vec<Assigned>, Error>

Assigns several elements fixed values to the circuit. Read more
Source§

impl<F: Clone + CircuitField, T: Clone + Vectorizable, const M: usize, const A: usize> Clone for AssignedVector<F, T, M, A>

Source§

fn clone(&self) -> AssignedVector<F, T, M, A>

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<F: Debug + CircuitField, T: Debug + Vectorizable, const M: usize, const A: usize> Debug for AssignedVector<F, T, M, A>

Source§

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

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

impl<F, const M: usize, T, const A: usize> EqualityInstructions<F, AssignedVector<F, T, M, A>> for VectorGadget<F>
where F: CircuitField, T: Vectorizable, T::Element: Copy, Self: VectorInstructions<F, T, M, A>, NativeGadget<F, P2RDecompositionChip<F>, NativeChip<F>>: ArithInstructions<F, AssignedNative<F>> + EqualityInstructions<F, T> + EqualityInstructions<F, AssignedNative<F>> + BinaryInstructions<F>,

Source§

fn is_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, y: &AssignedVector<F, T, M, A>, ) -> Result<AssignedBit<F>, Error>

Returns 1 if the elements are equal, returns 0 otherwise. Read more
Source§

fn is_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, y: &AssignedVector<F, T, M, A>, ) -> Result<AssignedBit<F>, Error>

Returns 0 if the elements are equal, returns 1 otherwise.
Source§

fn is_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, constant: Vec<T::Element>, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element equals the given constant. Read more
Source§

fn is_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedVector<F, T, M, A>, constant: Vec<T::Element>, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element is not equal to the given constant.
Source§

impl<F: CircuitField, const M: usize, const A: usize> From<Base64Vec<F, M, A>> for AssignedVector<F, AssignedByte<F>, M, A>

Source§

fn from(value: Base64Vec<F, M, A>) -> Self

Converts to this type from the input type.
Source§

impl<F: CircuitField, const M: usize, T: Vectorizable, const A: usize> InnerValue for AssignedVector<F, T, M, A>

Source§

type Element = Vec<<T as InnerValue>::Element>

Represents the unassigned type corresponding to the InnerValue
Source§

fn value(&self) -> Value<Self::Element>

Returns the value of the assigned element.

Auto Trait Implementations§

§

impl<F, T, const M: usize, const A: usize> Freeze for AssignedVector<F, T, M, A>
where F: Freeze,

§

impl<F, T, const M: usize, const A: usize> RefUnwindSafe for AssignedVector<F, T, M, A>
where F: RefUnwindSafe, T: RefUnwindSafe,

§

impl<F, T, const M: usize, const A: usize> Send for AssignedVector<F, T, M, A>
where T: Send,

§

impl<F, T, const M: usize, const A: usize> Sync for AssignedVector<F, T, M, A>
where T: Sync,

§

impl<F, T, const M: usize, const A: usize> Unpin for AssignedVector<F, T, M, A>
where F: Unpin,

§

impl<F, T, const M: usize, const A: usize> UnsafeUnpin for AssignedVector<F, T, M, A>
where F: UnsafeUnpin,

§

impl<F, T, const M: usize, const A: usize> UnwindSafe for AssignedVector<F, T, M, A>
where F: UnwindSafe, T: 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> 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> 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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.
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
Source§

impl<T> SyncDeps for T