Struct blstrs::G2Affine

pub struct G2Affine(_);

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.

Implementations

impl G2Affine

pub fn zero() -> Self

Returns the additive identity.

pub fn one() -> Self

Returns a fixed generator of unknown exponent.

pub fn is_zero(&self) -> bool

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

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

Serializes this element into compressed form.

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

Serializes this element into uncompressed form.

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

Attempts to deserialize an uncompressed element.

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

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]) -> Option<Self>

Attempts to deserialize a compressed element.

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

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_torsion_free(&self) -> bool

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

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

pub fn from_raw_unchecked(x: Fp2, y: Fp2, _infinity: bool) -> Self

pub fn x(&self) -> Fp2

Returns the x coordinate.

pub fn y(&self) -> Fp2

Returns the y coordinate.

pub const fn uncompressed_size() -> usize

pub const fn compressed_size() -> usize

Trait Implementations

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

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

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<G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

fn add(self, rhs: G2Affine) -> 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<'b> AddAssign<&'b G2Affine> for G2Projective

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

Performs the += operation.

impl AddAssign<G2Affine> for G2Projective

fn add_assign(&mut self, rhs: G2Affine)

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 Copy for G2Affine

impl CurveAffine for G2Affine

type Engine = Bls12

type Scalar = Scalar

type Base = Fp2

type Projective = G2Projective

type Uncompressed = G2Uncompressed

type Compressed = G2Compressed

fn zero() -> Self

Returns the additive identity.

fn one() -> Self

Returns a fixed generator of unknown exponent.

fn is_zero(&self) -> bool

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

fn mul<S: Into<<Self::Scalar as PrimeField>::Repr>>(
    &self,
    by: S
) -> Self::Projective

Performs scalar multiplication of this element with mixed addition.

fn negate(&mut self)

Negates this element.

fn into_projective(&self) -> Self::Projective

Converts this element into its affine representation.

fn into_compressed(&self) -> Self::Compressed

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

fn into_uncompressed(&self) -> Self::Uncompressed

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

impl Debug for G2Affine

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

Formats the value using the given formatter.

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

Formats the value using the given formatter.

impl Eq for G2Affine

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

fn from(p: &G2Affine) -> G2Projective

Performs the conversion.

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

fn from(p: &G2Projective) -> G2Affine

Performs the conversion.

impl From<G2Affine> for G2Projective

fn from(p: G2Affine) -> G2Projective

Performs the conversion.

impl From<G2Projective> for G2Affine

fn from(p: G2Projective) -> G2Affine

Performs the conversion.

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) -> Self::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<'_> Neg for &'_ 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 Prepared = G2Prepared

type Pair = G1Affine

type PairingResult = Fp12

fn prepare(&self) -> Self::Prepared

Prepares this element for pairing purposes.

fn pairing_with(&self, other: &Self::Pair) -> Self::PairingResult

Perform a pairing

impl PartialEq<G2Affine> for G2Affine

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<'a, 'b> Sub<&'b G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

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<G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G2Affine) -> 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<'b> SubAssign<&'b G2Affine> for G2Projective

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

Performs the -= operation.

impl SubAssign<G2Affine> for G2Projective

fn sub_assign(&mut self, rhs: G2Affine)

Performs the -= operation.