jf_relation::gadgets::ultraplonk::mod_arith

Struct FpElemVar

Source
pub struct FpElemVar<F: PrimeField> { /* private fields */ }
Expand description

Represent variable of an Fp element: elem = witness[vars.0] + 2^m * witness[vars.1] Warning: for performance reasons, when this struct is used, we will assume 2^m - two_power_m without checking.

Implementations§

Source§

impl<F: PrimeField> FpElemVar<F>

Source

pub fn new_unchecked( cs: &mut PlonkCircuit<F>, var: Variable, m: usize, two_power_m: Option<F>, ) -> Result<Self, CircuitError>

Create an FpElemVar from Fp element variable var and split parameter m. Does not perform range checks on the resulting variables. To create an FpElemVar from a field element, consider to use new_from_field_element instead (which comes with a range proof for the field element).

Source

pub fn convert_to_var( &self, cs: &mut PlonkCircuit<F>, ) -> Result<Variable, CircuitError>

Convert into a single variable with value witness[vars.0] + 2^m * witness[vars.1]

Source

pub fn new_from_field_element( cs: &mut PlonkCircuit<F>, f: &F, m: usize, two_power_m: Option<F>, ) -> Result<Self, CircuitError>

Create an FpElemVar from field element and split parameter m. This function is built with range-check proofs. requires lookup table.

Source

pub fn new_from_fp_elem( cs: &mut PlonkCircuit<F>, fp_elem: &FpElem<F>, m: usize, two_power_m: Option<F>, ) -> Result<Self, CircuitError>

Create an FpElemVar from FpElem form field element . This function is built with range-check proofs. requires lookup table.

Source

pub fn witness_fp_elem( &self, cs: &PlonkCircuit<F>, ) -> Result<FpElem<F>, CircuitError>

Get the witness in FpElem form from the variables

Source

pub fn witness(&self, cs: &PlonkCircuit<F>) -> Result<F, CircuitError>

Get the witness from the variables

Source

pub fn components(&self) -> (Variable, Variable)

Expose the field element variables components

Source

pub fn param_m(&self) -> usize

Expose the m parameter

Source

pub fn two_power_m(&self) -> F

Expose 2^m parameter

Source

pub fn zero(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self

An FpElemVar that represents a 0

Source

pub fn one(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self

An FpElemVar that represents a 1

Source

pub fn enforce_equal( &self, circuit: &mut PlonkCircuit<F>, other: &Self, ) -> Result<(), CircuitError>

Enforce self == other.

Trait Implementations§

Source§

impl<F: Clone + PrimeField> Clone for FpElemVar<F>

Source§

fn clone(&self) -> FpElemVar<F>

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<F: Debug + PrimeField> Debug for FpElemVar<F>

Source§

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

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

impl<F: Default + PrimeField> Default for FpElemVar<F>

Source§

fn default() -> FpElemVar<F>

Returns the “default value” for a type. Read more
Source§

impl<F: PartialEq + PrimeField> PartialEq for FpElemVar<F>

Source§

fn eq(&self, other: &FpElemVar<F>) -> 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<F: Copy + PrimeField> Copy for FpElemVar<F>

Source§

impl<F: Eq + PrimeField> Eq for FpElemVar<F>

Source§

impl<F: PrimeField> StructuralPartialEq for FpElemVar<F>

Auto Trait Implementations§

§

impl<F> Freeze for FpElemVar<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for FpElemVar<F>
where F: RefUnwindSafe,

§

impl<F> Send for FpElemVar<F>

§

impl<F> Sync for FpElemVar<F>

§

impl<F> Unpin for FpElemVar<F>
where F: Unpin,

§

impl<F> UnwindSafe for FpElemVar<F>
where F: 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, dst: *mut u8)

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

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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> 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.
§

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

§

fn vzip(self) -> V