Struct Fq6

pub struct Fq6 {
    pub c0: Fq2,
    pub c1: Fq2,
    pub c2: Fq2,
}

-BETA is a cubic non-residue in Fp2. Fp6 = Fp2[X]/(X^3 + BETA) We introduce the variable v such that v^3 = -BETA An element of Fq6, represented by c0 + c1 * v + c2 * v^2.

Fields

c0: Fq2

c1: Fq2

c2: Fq2

Implementations

impl Fq6

pub const fn zero() -> Self

pub const fn one() -> Self

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

pub fn square_assign(&mut self)

pub fn double(&self) -> Self

pub fn double_assign(&mut self)

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

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

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

pub fn square(&self) -> Self

pub fn neg(&self) -> Self

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

pub fn mul_by_nonresidue(&mut self)

Multiply by cubic nonresidue v.

pub fn mul_by_1(&mut self, c1: &Fq2)

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

Trait Implementations

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

type Output = Fq6

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Fq6

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Fq6

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Fq6

type Output = Fq6

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign for Fq6

fn add_assign(&mut self, rhs: Fq6)

Performs the += operation.

impl Clone for Fq6

fn clone(&self) -> Fq6

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConditionallySelectable for Fq6

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

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

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

impl ConstantTimeEq for Fq6

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

Determine if two items are equal.

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

Determine if two items are NOT equal.

impl Debug for Fq6

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

Formats the value using the given formatter.

impl Default for Fq6

fn default() -> Fq6

Returns the “default value” for a type.

impl Field for Fq6

const ZERO: Self = _

The zero element of the field, the additive identity.

const ONE: Self = _

The one element of the field, the multiplicative identity.

fn random(rng: impl RngCore) -> Self

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

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn square(&self) -> Self

Squares this element.

fn double(&self) -> Self

Doubles this element.

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

Returns the square root of the field element, if it is quadratic residue.

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

Computes:

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

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

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

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

Equivalent to Self::sqrt_ratio(self, one()).

fn pow<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

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.

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

type Output = Fq6

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Fq6

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Fq6

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Fq6

type Output = Fq6

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

impl MulAssign for Fq6

fn mul_assign(&mut self, rhs: Fq6)

Performs the *= operation.

impl<'a> Neg for &'a Fq6

type Output = Fq6

The resulting type after applying the - operator.

fn neg(self) -> Fq6

Performs the unary - operation.

impl Neg for Fq6

type Output = Fq6

The resulting type after applying the - operator.

fn neg(self) -> Fq6

Performs the unary - operation.

impl PartialEq for Fq6

fn eq(&self, other: &Fq6) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Borrow<Fq6>> Product<T> for Fq6

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

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

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

type Output = Fq6

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Fq6

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Fq6

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Fq6

type Output = Fq6

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

impl SubAssign for Fq6

fn sub_assign(&mut self, rhs: Fq6)

Performs the -= operation.

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

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

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

impl Copy for Fq6

impl Eq for Fq6

impl StructuralPartialEq for Fq6