Struct ark_ff::fields::models::cubic_extension::CubicExtField

pub struct CubicExtField<P: CubicExtParameters> {
    pub c0: P::BaseField,
    pub c1: P::BaseField,
    pub c2: P::BaseField,
    // some fields omitted
}

Fields

c0: P::BaseField

c1: P::BaseField

c2: P::BaseField

Implementations

impl<P: Fp3Parameters> CubicExtField<Fp3ParamsWrapper<P>>

pub fn mul_assign_by_fp(&mut self, value: &P::Fp)

pub fn qnr_to_t() -> Self

Returns the value of QNR^T.

impl<P: Fp6Parameters> CubicExtField<Fp6ParamsWrapper<P>>

pub fn mul_assign_by_fp2(&mut self, other: Fp2<P::Fp2Params>)

pub fn mul_by_fp(&mut self, element: &<P::Fp2Params as Fp2Parameters>::Fp)

pub fn mul_by_fp2(&mut self, element: &Fp2<P::Fp2Params>)

pub fn mul_by_1(&mut self, c1: &Fp2<P::Fp2Params>)

pub fn mul_by_01(&mut self, c0: &Fp2<P::Fp2Params>, c1: &Fp2<P::Fp2Params>)

impl<P: CubicExtParameters> CubicExtField<P>

pub fn new(c0: P::BaseField, c1: P::BaseField, c2: P::BaseField) -> Self

pub fn mul_assign_by_base_field(&mut self, value: &P::BaseField)

pub fn norm(&self) -> P::BaseField

Calculate the norm of an element with respect to the base field P::BaseField.

Trait Implementations

impl<'a, P: CubicExtParameters> Add<&'a CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: CubicExtParameters> Add<&'a mut CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &'a mut Self) -> Self

Performs the + operation.

impl<P: CubicExtParameters> Add<CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: CubicExtParameters> AddAssign<&'a CubicExtField<P>> for CubicExtField<P>

fn add_assign(&mut self, other: &Self)

Performs the += operation.

impl<'a, P: CubicExtParameters> AddAssign<&'a mut CubicExtField<P>> for CubicExtField<P>

fn add_assign(&mut self, other: &'a mut Self)

Performs the += operation.

impl<P: CubicExtParameters> AddAssign<CubicExtField<P>> for CubicExtField<P>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<P: CubicExtParameters> CanonicalDeserialize for CubicExtField<P>

fn deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Reads Self from reader.

pub fn deserialize_uncompressed<R>(
    reader: R
) -> Result<Self, SerializationError> where
    R: Read, 

Reads Self from reader without compression.

pub fn deserialize_unchecked<R>(reader: R) -> Result<Self, SerializationError> where
    R: Read, 

Reads self from reader without compression, and without performing validity checks. Should be used only when the input is trusted.

impl<P: CubicExtParameters> CanonicalDeserializeWithFlags for CubicExtField<P>

fn deserialize_with_flags<R: Read, F: Flags>(
    reader: R
) -> Result<(Self, F), SerializationError>

Reads Self and Flags from reader. Returns empty flags by default.

impl<P: CubicExtParameters> CanonicalSerialize for CubicExtField<P>

fn serialize<W: Write>(&self, writer: W) -> Result<(), SerializationError>

Serializes self into writer. It is left up to a particular type for how it strikes the serialization efficiency vs compression tradeoff. For standard types (e.g. bool, lengths, etc.) typically an uncompressed form is used, whereas for algebraic types compressed forms are used.

fn serialized_size(&self) -> usize

pub fn serialize_uncompressed<W>(
    &self,
    writer: W
) -> Result<(), SerializationError> where
    W: Write, 

Serializes self into writer without compression.

pub fn serialize_unchecked<W>(
    &self,
    writer: W
) -> Result<(), SerializationError> where
    W: Write, 

Serializes self into writer without compression, and without performing validity checks. Should be used only when there is no danger of adversarial manipulation of the output.

pub fn uncompressed_size(&self) -> usize

impl<P: CubicExtParameters> CanonicalSerializeWithFlags for CubicExtField<P>

fn serialize_with_flags<W: Write, F: Flags>(
    &self,
    writer: W,
    flags: F
) -> Result<(), SerializationError>

Serializes self and flags into writer.

fn serialized_size_with_flags<F: Flags>(&self) -> usize

Serializes self and flags into writer.

impl<P: CubicExtParameters> Clone for CubicExtField<P> where
    P: CubicExtParameters, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: CubicExtParameters> Copy for CubicExtField<P> where
    P: CubicExtParameters, 

impl<P: CubicExtParameters> Debug for CubicExtField<P> where
    P: CubicExtParameters, 

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

Formats the value using the given formatter.

impl<P: CubicExtParameters> Default for CubicExtField<P> where
    P: CubicExtParameters, 

fn default() -> Self

Returns the “default value” for a type.

impl<P: CubicExtParameters> Display for CubicExtField<P>

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

Formats the value using the given formatter.

impl<'a, P: CubicExtParameters> Div<&'a CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: &Self) -> Self

Performs the / operation.

impl<'a, P: CubicExtParameters> Div<&'a mut CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: &'a mut Self) -> Self

Performs the / operation.

impl<P: CubicExtParameters> Div<CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl<'a, P: CubicExtParameters> DivAssign<&'a CubicExtField<P>> for CubicExtField<P>

fn div_assign(&mut self, other: &Self)

Performs the /= operation.

impl<'a, P: CubicExtParameters> DivAssign<&'a mut CubicExtField<P>> for CubicExtField<P>

fn div_assign(&mut self, other: &'a mut Self)

Performs the /= operation.

impl<P: CubicExtParameters> DivAssign<CubicExtField<P>> for CubicExtField<P>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<P: CubicExtParameters> Eq for CubicExtField<P> where
    P: CubicExtParameters, 

impl<P: CubicExtParameters> Field for CubicExtField<P>

type BasePrimeField = P::BasePrimeField

fn extension_degree() -> u64

Returns the extension degree of this field with respect to Self::BasePrimeField.

fn from_base_prime_field_elems(elems: &[Self::BasePrimeField]) -> Option<Self>

Convert a slice of base prime field elements into a field element. If the slice length != Self::extension_degree(), must return None.

fn double(&self) -> Self

Returns self + self.

fn double_in_place(&mut self) -> &mut Self

Doubles self in place.

fn from_random_bytes_with_flags<F: Flags>(bytes: &[u8]) -> Option<(Self, F)>

Returns a field element with an extra sign bit used for group parsing if the set of bytes forms a valid field element, otherwise returns None. This function is primarily intended for sampling random field elements from a hash-function or RNG output.

fn from_random_bytes(bytes: &[u8]) -> Option<Self>

Returns a field element if the set of bytes forms a valid field element, otherwise returns None. This function is primarily intended for sampling random field elements from a hash-function or RNG output.

fn square(&self) -> Self

Returns self * self.

fn square_in_place(&mut self) -> &mut Self

Squares self in place.

fn inverse(&self) -> Option<Self>

Computes the multiplicative inverse of self if self is nonzero.

fn inverse_in_place(&mut self) -> Option<&mut Self>

fn frobenius_map(&mut self, power: usize)

Exponentiates this element by a power of the base prime modulus via the Frobenius automorphism.

fn characteristic<'a>() -> &'a [u64]

Returns the characteristic of the field, in little-endian representation.

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

Exponentiates this element by a number represented with u64 limbs, least significant limb first.

fn pow_with_table<S: AsRef<[u64]>>(powers_of_2: &[Self], exp: S) -> Option<Self>

Exponentiates a field element f by a number represented with u64 limbs, using a precomputed table containing as many powers of 2 of f as the 1 + the floor of log2 of the exponent exp, starting from the 1st power. That is, powers_of_2 should equal &[p, p^2, p^4, ..., p^(2^n)] when exp has at most n bits.

impl<P: CubicExtParameters> From<bool> for CubicExtField<P>

fn from(other: bool) -> Self

Performs the conversion.

impl<P: CubicExtParameters> From<u128> for CubicExtField<P>

fn from(other: u128) -> Self

Performs the conversion.

impl<P: CubicExtParameters> From<u16> for CubicExtField<P>

fn from(other: u16) -> Self

Performs the conversion.

impl<P: CubicExtParameters> From<u32> for CubicExtField<P>

fn from(other: u32) -> Self

Performs the conversion.

impl<P: CubicExtParameters> From<u64> for CubicExtField<P>

fn from(other: u64) -> Self

Performs the conversion.

impl<P: CubicExtParameters> From<u8> for CubicExtField<P>

fn from(other: u8) -> Self

Performs the conversion.

impl<P: CubicExtParameters> FromBytes for CubicExtField<P>

fn read<R: Read>(reader: R) -> IoResult<Self>

Reads Self from reader.

impl<P: CubicExtParameters> Hash for CubicExtField<P> where
    P: CubicExtParameters, 

fn hash<__HP>(&self, __state: &mut __HP) where
    __HP: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, P: CubicExtParameters> Mul<&'a CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P: CubicExtParameters> Mul<&'a mut CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: &'a mut Self) -> Self

Performs the * operation.

impl<P: CubicExtParameters> Mul<CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P: CubicExtParameters> MulAssign<&'a CubicExtField<P>> for CubicExtField<P>

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

Performs the *= operation.

impl<'a, P: CubicExtParameters> MulAssign<&'a mut CubicExtField<P>> for CubicExtField<P>

fn mul_assign(&mut self, other: &'a mut Self)

Performs the *= operation.

impl<P: CubicExtParameters> MulAssign<CubicExtField<P>> for CubicExtField<P>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<P: CubicExtParameters> Neg for CubicExtField<P>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<P: CubicExtParameters> One for CubicExtField<P>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

pub fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<P: CubicExtParameters> Ord for CubicExtField<P>

CubicExtField elements are ordered lexicographically.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<P: CubicExtParameters> PartialEq<CubicExtField<P>> for CubicExtField<P> where
    P: CubicExtParameters, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<P: CubicExtParameters> PartialOrd<CubicExtField<P>> for CubicExtField<P>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, P: CubicExtParameters> Product<&'a CubicExtField<P>> for CubicExtField<P>

fn product<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<P: CubicExtParameters> Product<CubicExtField<P>> for CubicExtField<P>

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<'a, P: CubicExtParameters> Sub<&'a CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P: CubicExtParameters> Sub<&'a mut CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &'a mut Self) -> Self

Performs the - operation.

impl<P: CubicExtParameters> Sub<CubicExtField<P>> for CubicExtField<P>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P: CubicExtParameters> SubAssign<&'a CubicExtField<P>> for CubicExtField<P>

fn sub_assign(&mut self, other: &Self)

Performs the -= operation.

impl<'a, P: CubicExtParameters> SubAssign<&'a mut CubicExtField<P>> for CubicExtField<P>

fn sub_assign(&mut self, other: &'a mut Self)

Performs the -= operation.

impl<P: CubicExtParameters> SubAssign<CubicExtField<P>> for CubicExtField<P>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, P: CubicExtParameters> Sum<&'a CubicExtField<P>> for CubicExtField<P>

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<P: CubicExtParameters> Sum<CubicExtField<P>> for CubicExtField<P>

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<P: CubicExtParameters> ToBytes for CubicExtField<P>

fn write<W: Write>(&self, writer: W) -> IoResult<()>

Serializes self into writer.

impl<P: CubicExtParameters> ToConstraintField<<P as CubicExtParameters>::BasePrimeField> for CubicExtField<P> where
    P::BaseField: ToConstraintField<P::BasePrimeField>, 

fn to_field_elements(&self) -> Option<Vec<P::BasePrimeField>>

impl<P: CubicExtParameters> Zero for CubicExtField<P>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<P: CubicExtParameters> Zeroize for CubicExtField<P>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.