Struct snarkos_models::curves::fp6_3over2::Fp6

pub struct Fp6<P: Fp6Parameters> {
    pub c0: Fp2<P::Fp2Params>,
    pub c1: Fp2<P::Fp2Params>,
    pub c2: Fp2<P::Fp2Params>,
    // some fields omitted
}

An element of Fp6, represented by c0 + c1 * v + c2 * v^(2).

Fields

c0: Fp2<P::Fp2Params>

c1: Fp2<P::Fp2Params>

c2: Fp2<P::Fp2Params>

Implementations

impl<P: Fp6Parameters> Fp6<P>

pub fn new(
    c0: Fp2<P::Fp2Params>,
    c1: Fp2<P::Fp2Params>,
    c2: Fp2<P::Fp2Params>
) -> Self

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

Trait Implementations

impl<'a, P: Fp6Parameters> Add<&'a Fp6<P>> for Fp6<P>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: Fp6Parameters> AddAssign<&'a Fp6<P>> for Fp6<P>

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

Performs the += operation.

impl<P, F: PrimeField> AllocGadget<Fp6<P>, F> for Fp6Gadget<P, F> where
    P: Fp6Parameters,
    P::Fp2Params: Fp2Parameters<Fp = F>, 

fn alloc<Fn, T, CS: ConstraintSystem<F>>(
    cs: CS,
    value_gen: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    T: Borrow<Fp6<P>>, 

fn alloc_input<Fn, T, CS: ConstraintSystem<F>>(
    cs: CS,
    value_gen: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    T: Borrow<Fp6<P>>, 

fn alloc_checked<Fn: FnOnce() -> Result<T, SynthesisError>, T: Borrow<V>, CS: ConstraintSystem<F>>(
    cs: CS,
    f: Fn
) -> Result<Self, SynthesisError>

fn alloc_input_checked<Fn: FnOnce() -> Result<T, SynthesisError>, T: Borrow<V>, CS: ConstraintSystem<F>>(
    cs: CS,
    f: Fn
) -> Result<Self, SynthesisError>

impl<P: Fp6Parameters> CanonicalDeserialize for Fp6<P>

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

Reads Self from reader.

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

Reads Self from reader without compression.

impl<P: Fp6Parameters> CanonicalDeserializeWithFlags for Fp6<P>

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

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

impl<P: Fp6Parameters> CanonicalSerialize for Fp6<P>

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

Serializes self into writer.

fn serialized_size(&self) -> usize

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

Serializes self into writer without compression.

fn uncompressed_size(&self) -> usize

impl<P: Fp6Parameters> CanonicalSerializeWithFlags for Fp6<P>

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

Serializes self and flags into writer.

impl<P: Fp6Parameters> Clone for Fp6<P> where
    P: Fp6Parameters, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Fp6Parameters> ConstantSerializedSize for Fp6<P>

const SERIALIZED_SIZE: usize

const UNCOMPRESSED_SIZE: usize

impl<P: Fp6Parameters> Copy for Fp6<P> where
    P: Fp6Parameters, 

impl<P: Fp6Parameters> Debug for Fp6<P> where
    P: Fp6Parameters, 

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

Formats the value using the given formatter.

impl<P: Fp6Parameters> Default for Fp6<P> where
    P: Fp6Parameters, 

fn default() -> Self

Returns the "default value" for a type.

impl<'de, P: Fp6Parameters> Deserialize<'de> for Fp6<P>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<P: Fp6Parameters> Display for Fp6<P>

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

Formats the value using the given formatter.

impl<P: Fp6Parameters> Distribution<Fp6<P>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Fp6<P>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl<'a, P: Fp6Parameters> Div<&'a Fp6<P>> for Fp6<P>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, P: Fp6Parameters> DivAssign<&'a Fp6<P>> for Fp6<P>

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

Performs the /= operation.

impl<P: Fp6Parameters> Eq for Fp6<P> where
    P: Fp6Parameters, 

impl<P: Fp6Parameters> Field for Fp6<P>

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

Returns the characteristic of the field.

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(bytes: &[u8]) -> Option<(Self, u8)>

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 pow<S: AsRef<[u64]>>(&self, exp: S) -> Self

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

impl<P, F: PrimeField> FieldGadget<Fp6<P>, F> for Fp6Gadget<P, F> where
    P: Fp6Parameters,
    P::Fp2Params: Fp2Parameters<Fp = F>, 

type Variable = ((ConstraintVar<F>, ConstraintVar<F>), (ConstraintVar<F>, ConstraintVar<F>), (ConstraintVar<F>, ConstraintVar<F>))

fn get_value(&self) -> Option<Fp6<P>>

fn get_variable(&self) -> Self::Variable

fn zero<CS: ConstraintSystem<F>>(cs: CS) -> Result<Self, SynthesisError>

fn one<CS: ConstraintSystem<F>>(cs: CS) -> Result<Self, SynthesisError>

fn conditionally_add_constant<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    bit: &Boolean,
    coeff: Fp6<P>
) -> Result<Self, SynthesisError>

fn add<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Self, SynthesisError>

fn sub<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Self, SynthesisError>

fn negate<CS: ConstraintSystem<F>>(
    &self,
    cs: CS
) -> Result<Self, SynthesisError>

fn negate_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS
) -> Result<&mut Self, SynthesisError>

fn mul<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Self, SynthesisError>

Use the Toom-Cook-3x method to compute multiplication.

fn square<CS: ConstraintSystem<F>>(
    &self,
    cs: CS
) -> Result<Self, SynthesisError>

Use the Toom-Cook-3x method to compute multiplication.

fn inverse<CS: ConstraintSystem<F>>(
    &self,
    cs: CS
) -> Result<Self, SynthesisError>

fn add_constant<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Fp6<P>
) -> Result<Self, SynthesisError>

fn add_constant_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &Fp6<P>
) -> Result<&mut Self, SynthesisError>

fn mul_by_constant<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Fp6<P>
) -> Result<Self, SynthesisError>

Use the Toom-Cook-3x method to compute multiplication.

fn frobenius_map<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    power: usize
) -> Result<Self, SynthesisError>

fn frobenius_map_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    power: usize
) -> Result<&mut Self, SynthesisError>

fn cost_of_mul() -> usize

fn cost_of_inv() -> usize

fn add_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError>

fn double<CS: ConstraintSystem<F>>(
    &self,
    cs: CS
) -> Result<Self, SynthesisError>

fn double_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS
) -> Result<&mut Self, SynthesisError>

fn sub_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError>

fn mul_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &Self
) -> Result<&mut Self, SynthesisError>

fn square_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS
) -> Result<&mut Self, SynthesisError>

fn mul_equals<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self,
    result: &Self
) -> Result<(), SynthesisError>

fn square_equals<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    result: &Self
) -> Result<(), SynthesisError>

fn sub_constant<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    fe: &NativeF
) -> Result<Self, SynthesisError>

fn sub_constant_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &NativeF
) -> Result<&mut Self, SynthesisError>

fn mul_by_constant_in_place<CS: ConstraintSystem<F>>(
    &mut self,
    cs: CS,
    other: &NativeF
) -> Result<&mut Self, SynthesisError>

fn pow<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    bits: &[Boolean]
) -> Result<Self, SynthesisError>

Accepts as input a list of bits which, when interpreted in big-endian form, are a scalar.

impl<'a, P: Fp6Parameters> From<&'a [bool]> for Fp6<P>

fn from(_bits: &[bool]) -> Self

Performs the conversion.

impl<P: Fp6Parameters> From<u128> for Fp6<P>

fn from(other: u128) -> Self

Performs the conversion.

impl<P: Fp6Parameters> From<u16> for Fp6<P>

fn from(other: u16) -> Self

Performs the conversion.

impl<P: Fp6Parameters> From<u32> for Fp6<P>

fn from(other: u32) -> Self

Performs the conversion.

impl<P: Fp6Parameters> From<u64> for Fp6<P>

fn from(other: u64) -> Self

Performs the conversion.

impl<P: Fp6Parameters> From<u8> for Fp6<P>

fn from(other: u8) -> Self

Performs the conversion.

impl<P: Fp6Parameters> FromBytes for Fp6<P>

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

Reads Self from reader.

impl<P: Fp6Parameters> Hash for Fp6<P> where
    P: Fp6Parameters, 

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

Feeds this value into the given [Hasher].

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: Fp6Parameters> Mul<&'a Fp6<P>> for Fp6<P>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, P: Fp6Parameters> MulAssign<&'a Fp6<P>> for Fp6<P>

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

Performs the *= operation.

impl<P: Fp6Parameters> Neg for Fp6<P>

type Output = Self

The resulting type after applying the - operator.

#[must_use]fn neg(self) -> Self

Performs the unary - operation.

impl<P: Fp6Parameters> One for Fp6<P>

fn one() -> Self

fn is_one(&self) -> bool

impl<P: Fp6Parameters> Ord for Fp6<P>

Fp3 elements are ordered lexicographically.

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<P: Fp6Parameters> PartialEq<Fp6<P>> for Fp6<P> where
    P: Fp6Parameters, 

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

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

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

This method tests for !=.

impl<P: Fp6Parameters> PartialOrd<Fp6<P>> for Fp6<P>

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<P: Fp6Parameters> Serialize for Fp6<P>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a, P: Fp6Parameters> Sub<&'a Fp6<P>> for Fp6<P>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, P: Fp6Parameters> SubAssign<&'a Fp6<P>> for Fp6<P>

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

Performs the -= operation.

impl<P: Fp6Parameters> ToBytes for Fp6<P>

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

Serializes self into writer.

impl<P: Fp6Parameters> Zero for Fp6<P>

fn zero() -> Self

fn is_zero(&self) -> bool