Struct G2Affine

pub struct G2Affine {
    pub(crate) x: Fp2,
    pub(crate) y: Fp2,
    infinity: Choice,
}

This is an element of $\mathbb{G}_2$ represented in the affine coordinate space. It is ideal to keep elements in this representation to reduce memory usage and improve performance through the use of mixed curve model arithmetic.

Values of G2Affine are guaranteed to be in the $q$-order subgroup unless an “unchecked” API was misused.

Fields

x: Fp2

y: Fp2

infinity: Choice

Implementations

impl G2Affine

pub fn identity() -> G2Affine

Returns the identity of the group: the point at infinity.

pub fn generator() -> G2Affine

Returns a fixed generator of the group. See notes::design for how this generator is chosen.

pub fn to_compressed(&self) -> [u8; 96]

Serializes this element into compressed form. See notes::serialization for details about how group elements are serialized.

pub fn to_uncompressed(&self) -> [u8; 192]

Serializes this element into uncompressed form. See notes::serialization for details about how group elements are serialized.

pub fn from_uncompressed(bytes: &[u8; 192]) -> CtOption<G2Affine>

Attempts to deserialize an uncompressed element. See notes::serialization for details about how group elements are serialized.

pub fn from_uncompressed_unchecked(bytes: &[u8; 192]) -> CtOption<G2Affine>

Attempts to deserialize an uncompressed element, not checking if the element is on the curve and not checking if it is in the correct subgroup. This is dangerous to call unless you trust the bytes you are reading; otherwise, API invariants may be broken. Please consider using from_uncompressed() instead.

pub fn from_compressed(bytes: &[u8; 96]) -> CtOption<G2Affine>

Attempts to deserialize a compressed element. See notes::serialization for details about how group elements are serialized.

pub fn from_compressed_unchecked(bytes: &[u8; 96]) -> CtOption<G2Affine>

Attempts to deserialize an uncompressed element, not checking if the element is in the correct subgroup. This is dangerous to call unless you trust the bytes you are reading; otherwise, API invariants may be broken. Please consider using from_compressed() instead.

pub fn is_identity(&self) -> Choice

Returns true if this element is the identity (the point at infinity).

pub fn is_torsion_free(&self) -> Choice

Returns true if this point is free of an $h$-torsion component, and so it exists within the $q$-order subgroup $\mathbb{G}_2$. This should always return true unless an “unchecked” API was used.

pub fn is_on_curve(&self) -> Choice

Returns true if this point is on the curve. This should always return true unless an “unchecked” API was used.

Trait Implementations

impl<'a, 'b> Add<&'b G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for G2Affine

fn clone(&self) -> G2Affine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for G2Affine

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

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 G2Affine

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

Determine if two items are equal.

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

Determine if two items are NOT equal.

impl Debug for G2Affine

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

Formats the value using the given formatter.

impl Decodable for G2Affine

fn consensus_decode<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<G2Affine, DecodeError>

where D: Read,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode Self from a size-limited reader.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl Default for G2Affine

fn default() -> G2Affine

Returns the “default value” for a type.

impl Display for G2Affine

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

Formats the value using the given formatter.

impl Encodable for G2Affine

fn consensus_encode<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl<'a> From<&'a G2Projective> for G2Affine

fn from(p: &'a G2Projective) -> G2Affine

Converts to this type from the input type.

impl From<G2Projective> for G2Affine

fn from(p: G2Projective) -> G2Affine

Converts to this type from the input type.

impl GroupEncoding for G2Affine

type Repr = G2Compressed

The encoding of group elements.

fn from_bytes(bytes: &<G2Affine as GroupEncoding>::Repr) -> CtOption<G2Affine>

Attempts to deserialize a group element from its encoding.

fn from_bytes_unchecked( bytes: &<G2Affine as GroupEncoding>::Repr, ) -> CtOption<G2Affine>

Attempts to deserialize a group element, not checking if the element is valid.

fn to_bytes(&self) -> <G2Affine as GroupEncoding>::Repr

Converts this element into its byte encoding. This may or may not support encoding the identity.

impl<'a, 'b> Mul<&'b Scalar> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> <&'a G2Affine as Mul<&'b Scalar>>::Output

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<Scalar> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl<'a> Neg for &'a G2Affine

type Output = G2Affine

The resulting type after applying the - operator.

fn neg(self) -> G2Affine

Performs the unary - operation.

impl Neg for G2Affine

type Output = G2Affine

The resulting type after applying the - operator.

fn neg(self) -> G2Affine

Performs the unary - operation.

impl PairingCurveAffine for G2Affine

type Pair = G1Affine

type PairingResult = Gt

fn pairing_with( &self, other: &<G2Affine as PairingCurveAffine>::Pair, ) -> <G2Affine as PairingCurveAffine>::PairingResult

Perform a pairing

impl PartialEq for G2Affine

fn eq(&self, other: &G2Affine) -> 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 PrimeCurveAffine for G2Affine

type Scalar = Scalar

type Curve = G2Projective

fn identity() -> G2Affine

Returns the additive identity.

fn generator() -> G2Affine

Returns a fixed generator of unknown exponent.

fn is_identity(&self) -> Choice

Determines if this point represents the point at infinity; the additive identity.

fn to_curve(&self) -> <G2Affine as PrimeCurveAffine>::Curve

Converts this element to its curve representation.

impl<'a, 'b> Sub<&'b G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl UncompressedEncoding for G2Affine

type Uncompressed = G2Uncompressed

fn from_uncompressed( bytes: &<G2Affine as UncompressedEncoding>::Uncompressed, ) -> CtOption<G2Affine>

Attempts to deserialize an element from its uncompressed encoding.

fn from_uncompressed_unchecked( bytes: &<G2Affine as UncompressedEncoding>::Uncompressed, ) -> CtOption<G2Affine>

Attempts to deserialize an uncompressed element, not checking if the element is in the correct subgroup.

fn to_uncompressed(&self) -> <G2Affine as UncompressedEncoding>::Uncompressed

Converts this element into its uncompressed encoding, so long as it’s not the point at infinity.

impl Copy for G2Affine

impl DefaultIsZeroes for G2Affine

impl Eq for G2Affine