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>
impl<F: PrimeField> FpElemVar<F>
Sourcepub fn new_unchecked(
cs: &mut PlonkCircuit<F>,
var: Variable,
m: usize,
two_power_m: Option<F>,
) -> Result<Self, CircuitError>
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).
Sourcepub fn convert_to_var(
&self,
cs: &mut PlonkCircuit<F>,
) -> Result<Variable, CircuitError>
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]
Sourcepub fn new_from_field_element(
cs: &mut PlonkCircuit<F>,
f: &F,
m: usize,
two_power_m: Option<F>,
) -> Result<Self, CircuitError>
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.
Sourcepub fn new_from_fp_elem(
cs: &mut PlonkCircuit<F>,
fp_elem: &FpElem<F>,
m: usize,
two_power_m: Option<F>,
) -> Result<Self, CircuitError>
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.
Sourcepub fn witness_fp_elem(
&self,
cs: &PlonkCircuit<F>,
) -> Result<FpElem<F>, CircuitError>
pub fn witness_fp_elem( &self, cs: &PlonkCircuit<F>, ) -> Result<FpElem<F>, CircuitError>
Get the witness in FpElem form from the variables
Sourcepub fn witness(&self, cs: &PlonkCircuit<F>) -> Result<F, CircuitError>
pub fn witness(&self, cs: &PlonkCircuit<F>) -> Result<F, CircuitError>
Get the witness from the variables
Sourcepub fn components(&self) -> (Variable, Variable)
pub fn components(&self) -> (Variable, Variable)
Expose the field element variables components
Sourcepub fn two_power_m(&self) -> F
pub fn two_power_m(&self) -> F
Expose 2^m parameter
Sourcepub fn zero(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self
pub fn zero(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self
An FpElemVar that represents a 0
Sourcepub fn one(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self
pub fn one(cs: &PlonkCircuit<F>, m: usize, two_power_m: Option<F>) -> Self
An FpElemVar that represents a 1
Sourcepub fn enforce_equal(
&self,
circuit: &mut PlonkCircuit<F>,
other: &Self,
) -> Result<(), CircuitError>
pub fn enforce_equal( &self, circuit: &mut PlonkCircuit<F>, other: &Self, ) -> Result<(), CircuitError>
Enforce self == other.
Trait Implementations§
impl<F: Copy + PrimeField> Copy for FpElemVar<F>
impl<F: Eq + PrimeField> Eq for FpElemVar<F>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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