Struct bellpepper::gadgets::num::AllocatedNum
source · pub struct AllocatedNum<Scalar>where
Scalar: PrimeField,{ /* private fields */ }
Implementations§
source§impl<Scalar> AllocatedNum<Scalar>where
Scalar: PrimeField,
impl<Scalar> AllocatedNum<Scalar>where
Scalar: PrimeField,
sourcepub fn alloc<CS, F>(
cs: CS,
value: F,
) -> Result<AllocatedNum<Scalar>, SynthesisError>
pub fn alloc<CS, F>( cs: CS, value: F, ) -> Result<AllocatedNum<Scalar>, SynthesisError>
Allocate a Variable(Aux)
in a ConstraintSystem
.
sourcepub fn alloc_input<CS, F>(
cs: CS,
value: F,
) -> Result<AllocatedNum<Scalar>, SynthesisError>
pub fn alloc_input<CS, F>( cs: CS, value: F, ) -> Result<AllocatedNum<Scalar>, SynthesisError>
Allocate a Variable(Input)
in a ConstraintSystem
.
sourcepub fn alloc_maybe_input<CS, F>(
cs: CS,
is_input: bool,
value: F,
) -> Result<AllocatedNum<Scalar>, SynthesisError>
pub fn alloc_maybe_input<CS, F>( cs: CS, is_input: bool, value: F, ) -> Result<AllocatedNum<Scalar>, SynthesisError>
Allocate a Variable
of either Aux
or Input
in a
ConstraintSystem
. The Variable
is a an Input
if is_input
is
true. This allows uniform creation of circuits containing components
which may or may not be public inputs.
pub fn inputize<CS>(&self, cs: CS) -> Result<(), SynthesisError>where
CS: ConstraintSystem<Scalar>,
sourcepub fn to_bits_le_strict<CS>(
&self,
cs: CS,
) -> Result<Vec<Boolean>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
Scalar: PrimeFieldBits,
pub fn to_bits_le_strict<CS>(
&self,
cs: CS,
) -> Result<Vec<Boolean>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
Scalar: PrimeFieldBits,
Deconstructs this allocated number into its boolean representation in little-endian bit order, requiring that the representation strictly exists “in the field” (i.e., a congruency is not allowed.)
sourcepub fn to_bits_le<CS>(&self, cs: CS) -> Result<Vec<Boolean>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
Scalar: PrimeFieldBits,
pub fn to_bits_le<CS>(&self, cs: CS) -> Result<Vec<Boolean>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
Scalar: PrimeFieldBits,
Convert the allocated number into its little-endian representation. Note that this does not strongly enforce that the commitment is “in the field.”
pub fn mul<CS>(
&self,
cs: CS,
other: &AllocatedNum<Scalar>,
) -> Result<AllocatedNum<Scalar>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
pub fn square<CS>(&self, cs: CS) -> Result<AllocatedNum<Scalar>, SynthesisError>where
CS: ConstraintSystem<Scalar>,
pub fn assert_nonzero<CS>(&self, cs: CS) -> Result<(), SynthesisError>where
CS: ConstraintSystem<Scalar>,
sourcepub fn conditionally_reverse<CS>(
cs: CS,
a: &AllocatedNum<Scalar>,
b: &AllocatedNum<Scalar>,
condition: &Boolean,
) -> Result<(AllocatedNum<Scalar>, AllocatedNum<Scalar>), SynthesisError>where
CS: ConstraintSystem<Scalar>,
pub fn conditionally_reverse<CS>(
cs: CS,
a: &AllocatedNum<Scalar>,
b: &AllocatedNum<Scalar>,
condition: &Boolean,
) -> Result<(AllocatedNum<Scalar>, AllocatedNum<Scalar>), SynthesisError>where
CS: ConstraintSystem<Scalar>,
Takes two allocated numbers (a, b) and returns (b, a) if the condition is true, and (a, b) otherwise.
pub fn get_value(&self) -> Option<Scalar>
pub fn get_variable(&self) -> Variable
Trait Implementations§
source§impl<Scalar> Clone for AllocatedNum<Scalar>where
Scalar: PrimeField,
impl<Scalar> Clone for AllocatedNum<Scalar>where
Scalar: PrimeField,
source§fn clone(&self) -> AllocatedNum<Scalar>
fn clone(&self) -> AllocatedNum<Scalar>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'de, Scalar> Deserialize<'de> for AllocatedNum<Scalar>where
Scalar: PrimeField + Deserialize<'de>,
impl<'de, Scalar> Deserialize<'de> for AllocatedNum<Scalar>where
Scalar: PrimeField + Deserialize<'de>,
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<AllocatedNum<Scalar>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<AllocatedNum<Scalar>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl<Scalar> From<AllocatedNum<Scalar>> for Num<Scalar>where
Scalar: PrimeField,
impl<Scalar> From<AllocatedNum<Scalar>> for Num<Scalar>where
Scalar: PrimeField,
source§fn from(num: AllocatedNum<Scalar>) -> Num<Scalar>
fn from(num: AllocatedNum<Scalar>) -> Num<Scalar>
source§impl<Scalar> Serialize for AllocatedNum<Scalar>where
Scalar: PrimeField + Serialize,
impl<Scalar> Serialize for AllocatedNum<Scalar>where
Scalar: PrimeField + Serialize,
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl<Scalar> Freeze for AllocatedNum<Scalar>where
Scalar: Freeze,
impl<Scalar> RefUnwindSafe for AllocatedNum<Scalar>where
Scalar: RefUnwindSafe,
impl<Scalar> Send for AllocatedNum<Scalar>
impl<Scalar> Sync for AllocatedNum<Scalar>
impl<Scalar> Unpin for AllocatedNum<Scalar>where
Scalar: Unpin,
impl<Scalar> UnwindSafe for AllocatedNum<Scalar>where
Scalar: 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,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.