halo2curves_axiom::bn256

Struct Fq12

Source
pub struct Fq12 {
    pub c0: Fq6,
    pub c1: Fq6,
}
Expand description

-GAMMA is a quadratic non-residue in Fp6. Fp12 = Fp6[X]/(X^2 + GAMMA) We introduce the variable w such that w^2 = -GAMMA An element of Fq12, represented by c0 + c1 * w.

Fields§

§c0: Fq6§c1: Fq6

Implementations§

Source§

impl Fq12

Source

pub const fn zero() -> Self

Source

pub const fn one() -> Self

Source

pub fn mul_assign(&mut self, other: &Self)

Source

pub fn square_assign(&mut self)

Source

pub fn double(&self) -> Self

Source

pub fn double_assign(&mut self)

Source

pub fn add(&self, other: &Self) -> Self

Source

pub fn sub(&self, other: &Self) -> Self

Source

pub fn mul(&self, other: &Self) -> Self

Source

pub fn square(&self) -> Self

Source

pub fn neg(&self) -> Self

Source

pub fn conjugate(&mut self)

Source

pub fn frobenius_map(&mut self, power: usize)

Source

pub fn mul_by_014(&mut self, c0: &Fq2, c1: &Fq2, c4: &Fq2)

Source

pub fn mul_by_034(&mut self, c0: &Fq2, c3: &Fq2, c4: &Fq2)

Source

pub fn invert(&self) -> CtOption<Self>

Source

pub fn cyclotomic_square(&mut self)

Trait Implementations§

Source§

impl<'a, 'b> Add<&'b Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &'b Fq12) -> Fq12

Performs the + operation. Read more
Source§

impl<'b> Add<&'b Fq12> for Fq12

Source§

type Output = Fq12

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &'b Fq12) -> Fq12

Performs the + operation. Read more
Source§

impl<'a> Add<Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Fq12) -> Fq12

Performs the + operation. Read more
Source§

impl Add for Fq12

Source§

type Output = Fq12

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Fq12) -> Fq12

Performs the + operation. Read more
Source§

impl<'b> AddAssign<&'b Fq12> for Fq12

Source§

fn add_assign(&mut self, rhs: &'b Fq12)

Performs the += operation. Read more
Source§

impl AddAssign for Fq12

Source§

fn add_assign(&mut self, rhs: Fq12)

Performs the += operation. Read more
Source§

impl Clone for Fq12

Source§

fn clone(&self) -> Fq12

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 ConditionallySelectable for Fq12

Source§

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice. Read more
Source§

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice. Read more
Source§

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves. Read more
Source§

impl ConstantTimeEq for Fq12

Source§

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal. Read more
Source§

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal. Read more
Source§

impl Debug for Fq12

Source§

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

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

impl Default for Fq12

Source§

fn default() -> Fq12

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

impl Field for Fq12

Source§

const ZERO: Self = _

The zero element of the field, the additive identity.
Source§

const ONE: Self = _

The one element of the field, the multiplicative identity.
Source§

fn random(rng: impl RngCore) -> Self

Returns an element chosen uniformly at random using a user-provided RNG.
Source§

fn is_zero(&self) -> Choice

Returns true iff this element is zero.
Source§

fn square(&self) -> Self

Squares this element.
Source§

fn double(&self) -> Self

Doubles this element.
Source§

fn sqrt(&self) -> CtOption<Self>

Returns the square root of the field element, if it is quadratic residue. Read more
Source§

fn sqrt_ratio(_num: &Self, _div: &Self) -> (Choice, Self)

Computes: Read more
Source§

fn invert(&self) -> CtOption<Self>

Computes the multiplicative inverse of this element, failing if the element is zero.
Source§

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero. Read more
Source§

fn cube(&self) -> Self

Cubes this element.
Source§

fn sqrt_alt(&self) -> (Choice, Self)

Equivalent to Self::sqrt_ratio(self, one()). Read more
Source§

fn pow<S>(&self, exp: S) -> Self
where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent. Read more
Source§

fn pow_vartime<S>(&self, exp: S) -> Self
where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent. Read more
Source§

impl<'a, 'b> Mul<&'b Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &'b Fq12) -> Fq12

Performs the * operation. Read more
Source§

impl<'b> Mul<&'b Fq12> for Fq12

Source§

type Output = Fq12

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &'b Fq12) -> Fq12

Performs the * operation. Read more
Source§

impl<'a> Mul<Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Fq12) -> Fq12

Performs the * operation. Read more
Source§

impl Mul for Fq12

Source§

type Output = Fq12

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Fq12) -> Fq12

Performs the * operation. Read more
Source§

impl<'b> MulAssign<&'b Fq12> for Fq12

Source§

fn mul_assign(&mut self, rhs: &'b Fq12)

Performs the *= operation. Read more
Source§

impl MulAssign for Fq12

Source§

fn mul_assign(&mut self, rhs: Fq12)

Performs the *= operation. Read more
Source§

impl<'a> Neg for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn neg(self) -> Fq12

Performs the unary - operation. Read more
Source§

impl Neg for Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn neg(self) -> Fq12

Performs the unary - operation. Read more
Source§

impl PartialEq for Fq12

Source§

fn eq(&self, other: &Fq12) -> 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<T: Borrow<Fq12>> Product<T> for Fq12

Source§

fn product<I: Iterator<Item = T>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<'a, 'b> Sub<&'b Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &'b Fq12) -> Fq12

Performs the - operation. Read more
Source§

impl<'b> Sub<&'b Fq12> for Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &'b Fq12) -> Fq12

Performs the - operation. Read more
Source§

impl<'a> Sub<Fq12> for &'a Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Fq12) -> Fq12

Performs the - operation. Read more
Source§

impl Sub for Fq12

Source§

type Output = Fq12

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Fq12) -> Fq12

Performs the - operation. Read more
Source§

impl<'b> SubAssign<&'b Fq12> for Fq12

Source§

fn sub_assign(&mut self, rhs: &'b Fq12)

Performs the -= operation. Read more
Source§

impl SubAssign for Fq12

Source§

fn sub_assign(&mut self, rhs: Fq12)

Performs the -= operation. Read more
Source§

impl<T: Borrow<Fq12>> Sum<T> for Fq12

Source§

fn sum<I: Iterator<Item = T>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl Copy for Fq12

Source§

impl Eq for Fq12

Source§

impl StructuralPartialEq for Fq12

Auto Trait Implementations§

§

impl Freeze for Fq12

§

impl RefUnwindSafe for Fq12

§

impl Send for Fq12

§

impl Sync for Fq12

§

impl Unpin for Fq12

§

impl UnwindSafe for Fq12

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 T)

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

impl<T> ConditionallyNegatable for T
where T: ConditionallySelectable, &'a T: for<'a> Neg<Output = T>,

Source§

fn conditional_negate(&mut self, choice: Choice)

Negate self if choice == Choice(1); otherwise, leave it unchanged. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .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
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .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
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T, Scalar> FftGroup<Scalar> for T
where Scalar: Field, T: Copy + Send + Sync + 'static + GroupOpsOwned + ScalarMulOwned<Scalar>,

Source§

impl<T, Rhs, Output> GroupOps<Rhs, Output> for T
where T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,

Source§

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T
where T: for<'r> GroupOps<&'r Rhs, Output>,

Source§

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T
where T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,

Source§

impl<T, Rhs, Output> ScalarMulOwned<Rhs, Output> for T
where T: for<'r> ScalarMul<&'r Rhs, Output>,