pub struct Fp2Chip<'a, F: PrimeField, FpChip: FieldChip<F>, Fp2>(pub FieldVectorChip<'a, F, FpChip>, _);Expand description
Represent Fp2 point as FieldVector with degree = 2
Fp2 = Fp[u] / (u^2 + 1)
This implementation assumes p = 3 (mod 4) in order for the polynomial u^2 + 1 to be irreducible over Fp; i.e., in order for -1 to not be a square (quadratic residue) in Fp
This means we store an Fp2 point as a_0 + a_1 * u where a_0, a_1 in Fp
Tuple Fields
0: FieldVectorChip<'a, F, FpChip>Implementations
sourceimpl<'a, F: PrimeField, FpChip: PrimeFieldChip<F>, Fp2: Field> Fp2Chip<'a, F, FpChip, Fp2>where
FpChip::FieldType: PrimeField,
impl<'a, F: PrimeField, FpChip: PrimeFieldChip<F>, Fp2: Field> Fp2Chip<'a, F, FpChip, Fp2>where
FpChip::FieldType: PrimeField,
sourcepub fn new(fp_chip: &'a FpChip) -> Self
pub fn new(fp_chip: &'a FpChip) -> Self
User must construct an FpChip first using a config. This is intended so everything shares a single FlexGateChip, which is needed for the column allocation to work.
pub fn fp_chip(&self) -> &FpChip
pub fn conjugate(
&self,
ctx: &mut Context<F>,
a: FieldVector<FpChip::FieldPoint>
) -> FieldVector<FpChip::FieldPoint>
pub fn neg_conjugate(
&self,
ctx: &mut Context<F>,
a: FieldVector<FpChip::FieldPoint>
) -> FieldVector<FpChip::FieldPoint>
Trait Implementations
sourceimpl<'a, F: Clone + PrimeField, FpChip: Clone + FieldChip<F>, Fp2: Clone> Clone for Fp2Chip<'a, F, FpChip, Fp2>
impl<'a, F: Clone + PrimeField, FpChip: Clone + FieldChip<F>, Fp2: Clone> Clone for Fp2Chip<'a, F, FpChip, Fp2>
sourceimpl<'a, F: Debug + PrimeField, FpChip: Debug + FieldChip<F>, Fp2: Debug> Debug for Fp2Chip<'a, F, FpChip, Fp2>
impl<'a, F: Debug + PrimeField, FpChip: Debug + FieldChip<F>, Fp2: Debug> Debug for Fp2Chip<'a, F, FpChip, Fp2>
sourceimpl<'a, F, FpChip, Fp2> FieldChip<F> for Fp2Chip<'a, F, FpChip, Fp2>where
F: PrimeField,
FpChip::FieldType: PrimeField,
FpChip: PrimeFieldChip<F>,
Fp2: Field + FieldExtConstructor<FpChip::FieldType, 2>,
FieldVector<FpChip::UnsafeFieldPoint>: From<FieldVector<FpChip::FieldPoint>>,
FieldVector<FpChip::FieldPoint>: From<FieldVector<FpChip::ReducedFieldPoint>>,
impl<'a, F, FpChip, Fp2> FieldChip<F> for Fp2Chip<'a, F, FpChip, Fp2>where
F: PrimeField,
FpChip::FieldType: PrimeField,
FpChip: PrimeFieldChip<F>,
Fp2: Field + FieldExtConstructor<FpChip::FieldType, 2>,
FieldVector<FpChip::UnsafeFieldPoint>: From<FieldVector<FpChip::FieldPoint>>,
FieldVector<FpChip::FieldPoint>: From<FieldVector<FpChip::ReducedFieldPoint>>,
const PRIME_FIELD_NUM_BITS: u32 = <FpChip::FieldType>::NUM_BITS
type UnsafeFieldPoint = FieldVector<<FpChip as FieldChip<F>>::UnsafeFieldPoint>
type UnsafeFieldPoint = FieldVector<<FpChip as FieldChip<F>>::UnsafeFieldPoint>
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 = FieldVector<<FpChip as FieldChip<F>>::FieldPoint>
type FieldPoint = FieldVector<<FpChip as FieldChip<F>>::FieldPoint>
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 = FieldVector<<FpChip as FieldChip<F>>::ReducedFieldPoint>
type ReducedFieldPoint = FieldVector<<FpChip as FieldChip<F>>::ReducedFieldPoint>
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 = Fp2
type FieldType = Fp2
A type implementing
Field trait to help with witness generation (for example with inverse)type RangeChip = <FpChip as FieldChip<F>>::RangeChip
fn get_assigned_value(&self, x: &Self::UnsafeFieldPoint) -> Fp2
fn mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::UnsafeFieldPoint
fn native_modulus(&self) -> &BigUint
fn range(&self) -> &Self::RangeChip
fn limb_bits(&self) -> usize
sourcefn load_private(
&self,
ctx: &mut Context<F>,
fe: Self::FieldType
) -> Self::FieldPoint
fn load_private(
&self,
ctx: &mut Context<F>,
fe: Self::FieldType
) -> Self::FieldPoint
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>,
fe: Self::FieldType
) -> Self::FieldPoint
fn load_constant(
&self,
ctx: &mut Context<F>,
fe: Self::FieldType
) -> Self::FieldPoint
Assigns
fe as constant.fn add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::UnsafeFieldPoint
sourcefn add_constant_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
c: Self::FieldType
) -> Self::UnsafeFieldPoint
fn add_constant_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
c: Self::FieldType
) -> Self::UnsafeFieldPoint
output:
a + cfn sub_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>
) -> Self::UnsafeFieldPoint
fn negate(&self, ctx: &mut Context<F>, a: Self::FieldPoint) -> Self::FieldPoint
sourcefn scalar_mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
c: i64
) -> Self::UnsafeFieldPoint
fn scalar_mul_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
c: i64
) -> Self::UnsafeFieldPoint
a * c
sourcefn scalar_mul_and_add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>,
c: i64
) -> Self::UnsafeFieldPoint
fn scalar_mul_and_add_no_carry(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
b: impl Into<Self::UnsafeFieldPoint>,
c: i64
) -> Self::UnsafeFieldPoint
a * c + b
fn check_carry_mod_to_zero(&self, ctx: &mut Context<F>, a: Self::UnsafeFieldPoint)
fn carry_mod(
&self,
ctx: &mut Context<F>,
a: Self::UnsafeFieldPoint
) -> Self::FieldPoint
fn range_check(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::UnsafeFieldPoint>,
max_bits: usize
)
sourcefn enforce_less_than(
&self,
ctx: &mut Context<F>,
a: Self::FieldPoint
) -> Self::ReducedFieldPoint
fn enforce_less_than(
&self,
ctx: &mut Context<F>,
a: Self::FieldPoint
) -> Self::ReducedFieldPoint
Constrains that
a is a reduced representation and returns the wrapped a.fn is_soft_zero(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>
) -> AssignedValue<F>
fn is_soft_nonzero(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>
) -> AssignedValue<F>
fn is_zero(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>
) -> AssignedValue<F>
fn is_equal_unenforced(
&self,
ctx: &mut Context<F>,
a: Self::ReducedFieldPoint,
b: Self::ReducedFieldPoint
) -> AssignedValue<F>
fn assert_equal(
&self,
ctx: &mut Context<F>,
a: impl Into<Self::FieldPoint>,
b: impl Into<Self::FieldPoint>
)
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
impl<'a, F: Copy + PrimeField, FpChip: Copy + FieldChip<F>, Fp2: Copy> Copy for Fp2Chip<'a, F, FpChip, Fp2>
Auto Trait Implementations
impl<'a, F, FpChip, Fp2> RefUnwindSafe for Fp2Chip<'a, F, FpChip, Fp2>where
F: RefUnwindSafe,
Fp2: RefUnwindSafe,
FpChip: RefUnwindSafe,
impl<'a, F, FpChip, Fp2> Send for Fp2Chip<'a, F, FpChip, Fp2>where
Fp2: Send,
impl<'a, F, FpChip, Fp2> Sync for Fp2Chip<'a, F, FpChip, Fp2>where
Fp2: Sync,
impl<'a, F, FpChip, Fp2> Unpin for Fp2Chip<'a, F, FpChip, Fp2>where
F: Unpin,
Fp2: Unpin,
impl<'a, F, FpChip, Fp2> UnwindSafe for Fp2Chip<'a, F, FpChip, Fp2>where
F: UnwindSafe,
Fp2: UnwindSafe,
FpChip: RefUnwindSafe,
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