pub struct FpChip<'range, F: PrimeField, Fp: PrimeField> {
pub range: &'range RangeChip<F>,
pub limb_bits: usize,
pub num_limbs: usize,
pub num_limbs_bits: usize,
pub num_limbs_log2_ceil: usize,
pub limb_bases: Vec<F>,
pub limb_base_big: BigInt,
pub limb_mask: BigUint,
pub p: BigInt,
pub p_limbs: Vec<F>,
pub p_native: F,
pub native_modulus: BigUint,
/* private fields */
}
Fields
range: &'range RangeChip<F>
limb_bits: usize
num_limbs: usize
num_limbs_bits: usize
num_limbs_log2_ceil: usize
limb_bases: Vec<F>
limb_base_big: BigInt
limb_mask: BigUint
p: BigInt
p_limbs: Vec<F>
p_native: F
native_modulus: BigUint
Implementations
sourceimpl<'range, F: PrimeField, Fp: PrimeField> FpChip<'range, F, Fp>
impl<'range, F: PrimeField, Fp: PrimeField> FpChip<'range, F, Fp>
pub fn new(
range: &'range RangeChip<F>,
limb_bits: usize,
num_limbs: usize
) -> Self
pub fn enforce_less_than_p(&self, ctx: &mut Context<F>, a: ProperCrtUint<F>)
pub fn load_constant_uint(
&self,
ctx: &mut Context<F>,
a: BigUint
) -> ProperCrtUint<F>
Trait Implementations
sourceimpl<'range, F: Clone + PrimeField, Fp: Clone + PrimeField> Clone for FpChip<'range, F, Fp>
impl<'range, F: Clone + PrimeField, Fp: Clone + PrimeField> Clone for FpChip<'range, F, Fp>
sourceimpl<'range, F: Debug + PrimeField, Fp: Debug + PrimeField> Debug for FpChip<'range, F, Fp>
impl<'range, F: Debug + PrimeField, Fp: Debug + PrimeField> Debug for FpChip<'range, F, Fp>
sourceimpl<'range, F: PrimeField, Fp: PrimeField> FieldChip<F> for FpChip<'range, F, Fp>
impl<'range, F: PrimeField, Fp: PrimeField> FieldChip<F> for FpChip<'range, F, Fp>
sourcefn range_check(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
max_bits: usize
)
fn range_check(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
max_bits: usize
)
Assumptions
max_bits <= n * k
wheren = self.limb_bits
andk = self.num_limbs
a.truncation.limbs.len() = self.num_limbs
sourcefn is_soft_zero(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>
) -> AssignedValue<F>
fn is_soft_zero(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>
) -> AssignedValue<F>
Returns 1 iff a
is 0 as a BigUint. This means that even if a
is 0 modulo p
, this may return 0.
sourcefn is_soft_nonzero(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>
) -> AssignedValue<F>
fn is_soft_nonzero(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>
) -> AssignedValue<F>
Given proper CRT integer a
, returns 1 iff a < modulus::<F>()
and a != 0
as integers
Assumptions
a
is proper representation of BigUint
const PRIME_FIELD_NUM_BITS: u32 = Fp::NUM_BITS
type UnsafeFieldPoint = CRTInteger<F>
type UnsafeFieldPoint = CRTInteger<F>
A representation of a field element that is used for intermediate computations.
The representation can have “overflows” (e.g., overflow limbs or negative limbs). Read more
type FieldPoint = ProperCrtUint<F>
type FieldPoint = ProperCrtUint<F>
The “proper” representation of a field element. Allowed to be a non-unique representation of a field element (e.g., can be greater than modulus)
type ReducedFieldPoint = Reduced<ProperCrtUint<F>, Fp>
type ReducedFieldPoint = Reduced<ProperCrtUint<F>, Fp>
A proper representation of field elements that guarantees a unique representation of each field element. Typically this means Uints that are less than the modulus.
type FieldType = Fp
type FieldType = Fp
A type implementing
Field
trait to help with witness generation (for example with inverse)type RangeChip = RangeChip<F>
fn native_modulus(&self) -> &BigUint
fn range(&self) -> &'range Self::RangeChip
fn limb_bits(&self) -> usize
fn get_assigned_value(&self, x: &CRTInteger<F>) -> Fp
sourcefn load_private(&self, ctx: &mut Context<F>, a: Fp) -> ProperCrtUint<F>
fn load_private(&self, ctx: &mut Context<F>, a: Fp) -> ProperCrtUint<F>
Assigns
fe
as private witness. Note that the witness may not be constrained to be a unique representation of the field element fe
.sourcefn load_constant(&self, ctx: &mut Context<F>, a: Fp) -> ProperCrtUint<F>
fn load_constant(&self, ctx: &mut Context<F>, a: Fp) -> ProperCrtUint<F>
Assigns
fe
as constant.fn add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
b: impl Into<CRTInteger<F>>
) -> CRTInteger<F>
sourcefn add_constant_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
c: Fp
) -> CRTInteger<F>
fn add_constant_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
c: Fp
) -> CRTInteger<F>
output:
a + c
fn sub_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
b: impl Into<CRTInteger<F>>
) -> CRTInteger<F>
fn negate(&self, ctx: &mut Context<F>, a: ProperCrtUint<F>) -> ProperCrtUint<F>
sourcefn scalar_mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
c: i64
) -> CRTInteger<F>
fn scalar_mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
c: i64
) -> CRTInteger<F>
a * c
sourcefn scalar_mul_and_add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
b: impl Into<CRTInteger<F>>,
c: i64
) -> CRTInteger<F>
fn scalar_mul_and_add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
b: impl Into<CRTInteger<F>>,
c: i64
) -> CRTInteger<F>
a * c + b
fn mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<CRTInteger<F>>,
b: impl Into<CRTInteger<F>>
) -> CRTInteger<F>
fn check_carry_mod_to_zero(&self, ctx: &mut Context<F>, a: CRTInteger<F>)
fn carry_mod(&self, ctx: &mut Context<F>, a: CRTInteger<F>) -> ProperCrtUint<F>
sourcefn enforce_less_than(
&self,
ctx: &mut Context<F>,
a: ProperCrtUint<F>
) -> Reduced<ProperCrtUint<F>, Fp>
fn enforce_less_than(
&self,
ctx: &mut Context<F>,
a: ProperCrtUint<F>
) -> Reduced<ProperCrtUint<F>, Fp>
Constrains that
a
is a reduced representation and returns the wrapped a
.fn is_zero(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>
) -> AssignedValue<F>
fn is_equal_unenforced(
&self,
ctx: &mut Context<F>,
a: Reduced<ProperCrtUint<F>, Fp>,
b: Reduced<ProperCrtUint<F>, Fp>
) -> AssignedValue<F>
fn assert_equal(
&self,
ctx: &mut Context<F>,
a: impl Into<ProperCrtUint<F>>,
b: impl Into<ProperCrtUint<F>>
)
fn gate(&self) -> &<Self::RangeChip as RangeInstructions<F>>::Gate
sourcefn load_private_reduced(
&self,
ctx: &mut Context<F>,
fe: Self::FieldType
) -> Self::ReducedFieldPoint
fn load_private_reduced(
&self,
ctx: &mut Context<F>,
fe: Self::FieldType
) -> Self::ReducedFieldPoint
Assigns
fe
as private witness and contrains the witness to be in reduced form.fn is_equal(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
) -> AssignedValue<F>
sourcefn mul(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::FieldPoint
fn mul(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::FieldPoint
If using
UnsafeFieldPoint
, make sure multiplication does not cause overflow.sourcefn divide(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
) -> Self::FieldPoint
fn divide(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
) -> Self::FieldPoint
Constrains that
b
is nonzero as a field element and then returns a / b
.sourcefn divide_unsafe(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::FieldPoint
fn divide_unsafe(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::FieldPoint
sourcefn neg_divide(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
) -> Self::FieldPoint
fn neg_divide(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
) -> Self::FieldPoint
Constrains that
b
is nonzero as a field element and then returns -a / b
.fn neg_divide_unsafe(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::FieldPoint
sourceimpl<'range, F: PrimeField, Fp: PrimeField> PrimeFieldChip<F> for FpChip<'range, F, Fp>
impl<'range, F: PrimeField, Fp: PrimeField> PrimeFieldChip<F> for FpChip<'range, F, Fp>
sourceimpl<'range, F: PrimeField, Fp: PrimeField> Selectable<F, CRTInteger<F>> for FpChip<'range, F, Fp>
impl<'range, F: PrimeField, Fp: PrimeField> Selectable<F, CRTInteger<F>> for FpChip<'range, F, Fp>
fn select(
&self,
ctx: &mut Context<F>,
a: CRTInteger<F>,
b: CRTInteger<F>,
sel: AssignedValue<F>
) -> CRTInteger<F>
fn select_by_indicator(
&self,
ctx: &mut Context<F>,
a: &impl AsRef<[CRTInteger<F>]>,
coeffs: &[AssignedValue<F>]
) -> CRTInteger<F>
sourceimpl<'range, F: PrimeField, Fp: PrimeField> Selectable<F, ProperCrtUint<F>> for FpChip<'range, F, Fp>
impl<'range, F: PrimeField, Fp: PrimeField> Selectable<F, ProperCrtUint<F>> for FpChip<'range, F, Fp>
fn select(
&self,
ctx: &mut Context<F>,
a: ProperCrtUint<F>,
b: ProperCrtUint<F>,
sel: AssignedValue<F>
) -> ProperCrtUint<F>
fn select_by_indicator(
&self,
ctx: &mut Context<F>,
a: &impl AsRef<[ProperCrtUint<F>]>,
coeffs: &[AssignedValue<F>]
) -> ProperCrtUint<F>
Auto Trait Implementations
impl<'range, F, Fp> RefUnwindSafe for FpChip<'range, F, Fp>where
F: RefUnwindSafe,
Fp: RefUnwindSafe,
impl<'range, F, Fp> Send for FpChip<'range, F, Fp>
impl<'range, F, Fp> Sync for FpChip<'range, F, Fp>
impl<'range, F, Fp> Unpin for FpChip<'range, F, Fp>where
F: Unpin,
Fp: Unpin,
impl<'range, F, Fp> UnwindSafe for FpChip<'range, F, Fp>where
F: UnwindSafe + RefUnwindSafe,
Fp: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> FmtForward for T
impl<T> FmtForward for T
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
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,
Borrows
self
and passes that borrow into the pipe function. Read morefn 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,
Mutably borrows
self
and passes that borrow into the pipe function. Read morefn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows
self
, then passes self.as_ref()
into the pipe function.fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows
self
, then passes self.deref()
into the pipe function.impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<F, Fp, Pt, FC> Selectable<F, Reduced<Pt, Fp>> for FCwhere
F: PrimeField,
Pt: Clone,
FC: Selectable<F, Pt>,
impl<F, Fp, Pt, FC> Selectable<F, Reduced<Pt, Fp>> for FCwhere
F: PrimeField,
Pt: Clone,
FC: Selectable<F, Pt>,
fn select(
&self,
ctx: &mut Context<F>,
a: Reduced<Pt, Fp>,
b: Reduced<Pt, Fp>,
sel: AssignedValue<F>
) -> Reduced<Pt, Fp>
fn select_by_indicator(
&self,
ctx: &mut Context<F>,
a: &impl AsRef<[Reduced<Pt, Fp>]>,
coeffs: &[AssignedValue<F>]
) -> Reduced<Pt, Fp>
impl<T> Tap for T
impl<T> Tap for T
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Immutable access to the
Borrow<B>
of a value. Read morefn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the
BorrowMut<B>
of a value. Read morefn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Immutable access to the
AsRef<R>
view of a value. Read morefn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Mutable access to the
AsMut<R>
view of a value. Read morefn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the
Deref::Target
of a value. Read morefn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the
Deref::Target
of a value. Read morefn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds. Read morefn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds. Read morefn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read morefn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Calls
.tap_ref()
only in debug builds, and is erased in release
builds. Read morefn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more