Struct PairingOutput

pub struct PairingOutput<P>(pub <P as Pairing>::TargetField)
where
    P: Pairing;

Represents the target group of a pairing. This struct is a wrapper around the field that the target group is embedded in.

Tuple Fields

0: <P as Pairing>::TargetField

Trait Implementations

impl<'a, 'b, P> Add<&'a PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: &'a PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<'a, P> Add<&'a PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: &'a PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<'a, 'b, P> Add<&'a mut PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: &'a mut PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<'a, P> Add<&'a mut PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: &'a mut PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<'b, P> Add<PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<P> Add for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the + operator.

fn add(self, other: PairingOutput<P>) -> PairingOutput<P>

Performs the + operation.

impl<'a, P> AddAssign<&'a PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

fn add_assign(&mut self, other: &'a PairingOutput<P>)

Performs the += operation.

impl<'a, P> AddAssign<&'a mut PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

fn add_assign(&mut self, other: &'a mut PairingOutput<P>)

Performs the += operation.

impl<P> AddAssign for PairingOutput<P>

where P: Pairing,

fn add_assign(&mut self, other: PairingOutput<P>)

Performs the += operation.

impl<P> AdditiveGroup for PairingOutput<P>

where P: Pairing,

const ZERO: PairingOutput<P> = _

The additive identity of the field.

type Scalar = <P as Pairing>::ScalarField

fn double_in_place(&mut self) -> &mut PairingOutput<P>

Doubles self in place.

fn double(&self) -> Self

Doubles self.

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

Negates self in place.

impl<P> CanonicalDeserialize for PairingOutput<P>

where P: Pairing,

fn deserialize_with_mode<R>( reader: R, compress: Compress, validate: Validate, ) -> Result<PairingOutput<P>, SerializationError>

where R: Read,

The general deserialize method that takes in customization flags.

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

where R: Read,

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

where R: Read,

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

where R: Read,

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

where R: Read,

impl<P> CanonicalSerialize for PairingOutput<P>

where P: Pairing,

fn serialize_with_mode<W>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

where W: Write,

The general serialize method that takes in customization flags.

fn serialized_size(&self, compress: Compress) -> usize

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

where W: Write,

fn compressed_size(&self) -> usize

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

where W: Write,

fn uncompressed_size(&self) -> usize

impl<P> Clone for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Copy,

fn clone(&self) -> PairingOutput<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Debug for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Debug,

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

Formats the value using the given formatter.

impl<P> Default for PairingOutput<P>

where P: Pairing,

fn default() -> PairingOutput<P>

Returns the “default value” for a type.

impl<P> Display for PairingOutput<P>

where P: Pairing,

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

Formats the value using the given formatter.

impl<P> Hash for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P, T> Mul<T> for PairingOutput<P>

where P: Pairing, T: Borrow<<P as Pairing>::ScalarField>,

type Output = PairingOutput<P>

The resulting type after applying the * operator.

fn mul(self, other: T) -> PairingOutput<P>

Performs the * operation.

impl<P, T> MulAssign<T> for PairingOutput<P>

where P: Pairing, T: Borrow<<P as Pairing>::ScalarField>,

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<P> Neg for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn neg(self) -> PairingOutput<P>

Performs the unary - operation.

impl<P> Ord for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Ord, PairingOutput<P>: Eq,

fn cmp(&self, other: &PairingOutput<P>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<P> PartialEq for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: PartialEq,

fn eq(&self, other: &PairingOutput<P>) -> 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<P> PartialOrd for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Ord, PairingOutput<P>: Eq,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<P> PrimeGroup for PairingOutput<P>

where P: Pairing,

type ScalarField = <P as Pairing>::ScalarField

The scalar field F_r, where r is the order of this group.

fn generator() -> PairingOutput<P>

Returns a fixed generator of this group.

fn mul_bigint(&self, other: impl AsRef<[u64]>) -> PairingOutput<P>

Performs scalar multiplication of this element.

fn mul_bits_be(&self, other: impl Iterator<Item = bool>) -> PairingOutput<P>

Computes other * self, where other is a big-endian bit representation of some integer.

impl<P> ScalarMul for PairingOutput<P>

where P: Pairing,

const NEGATION_IS_CHEAP: bool = <P::TargetField>::INVERSE_IS_FAST

type MulBase = PairingOutput<P>

fn batch_convert_to_mul_base( bases: &[PairingOutput<P>], ) -> Vec<<PairingOutput<P> as ScalarMul>::MulBase>

fn batch_mul(self, v: &[Self::ScalarField]) -> Vec<Self::MulBase>

Compute the vector v[0].G, v[1].G, …, v[n-1].G, given:

fn batch_mul_with_preprocessing( table: &BatchMulPreprocessing<Self>, v: &[Self::ScalarField], ) -> Vec<Self::MulBase>

Compute the vector v[0].G, v[1].G, …, v[n-1].G, given:

impl<'a, 'b, P> Sub<&'a PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: &'a PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<'a, P> Sub<&'a PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: &'a PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<'a, 'b, P> Sub<&'a mut PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: &'a mut PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<'a, P> Sub<&'a mut PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: &'a mut PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<'b, P> Sub<PairingOutput<P>> for &'b PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<P> Sub for PairingOutput<P>

where P: Pairing,

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn sub(self, other: PairingOutput<P>) -> PairingOutput<P>

Performs the - operation.

impl<'a, P> SubAssign<&'a PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

fn sub_assign(&mut self, other: &'a PairingOutput<P>)

Performs the -= operation.

impl<'a, P> SubAssign<&'a mut PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

fn sub_assign(&mut self, other: &'a mut PairingOutput<P>)

Performs the -= operation.

impl<P> SubAssign for PairingOutput<P>

where P: Pairing,

fn sub_assign(&mut self, other: PairingOutput<P>)

Performs the -= operation.

impl<'a, P> Sum<&'a PairingOutput<P>> for PairingOutput<P>

where P: Pairing,

fn sum<I>(iter: I) -> PairingOutput<P>

where I: Iterator<Item = &'a PairingOutput<P>>,

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

impl<P> Sum for PairingOutput<P>

where P: Pairing,

fn sum<I>(iter: I) -> PairingOutput<P>

where I: Iterator<Item = PairingOutput<P>>,

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

impl<P> Valid for PairingOutput<P>

where P: Pairing,

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<P> VariableBaseMSM for PairingOutput<P>

where P: Pairing,

fn msm_unchecked(bases: &[Self::MulBase], scalars: &[Self::ScalarField]) -> Self

Computes an inner product between the PrimeField elements in scalars and the corresponding group elements in bases.

fn msm( bases: &[Self::MulBase], scalars: &[Self::ScalarField], ) -> Result<Self, usize>

Performs multi-scalar multiplication.

fn msm_bigint( bases: &[Self::MulBase], bigints: &[<Self::ScalarField as PrimeField>::BigInt], ) -> Self

Optimized implementation of multi-scalar multiplication.

fn msm_chunks<I, J>(bases_stream: &J, scalars_stream: &I) -> Self

where I: Iterable + ?Sized, <I as Iterable>::Item: Borrow<Self::ScalarField>, J: Iterable, <J as Iterable>::Item: Borrow<Self::MulBase>,

Streaming multi-scalar multiplication algorithm with hard-coded chunk size.

impl<P> Zero for PairingOutput<P>

where P: Pairing,

fn zero() -> PairingOutput<P>

The identity element, or “zero”, of the group is the identity element of the multiplicative group of the underlying field, i.e., P::TargetField::one().

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

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

impl<P> Zeroize for PairingOutput<P>

where P: Pairing,

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.

impl<P> Copy for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: Copy,

impl<P> Eq for PairingOutput<P>

where P: Pairing, <P as Pairing>::TargetField: PartialEq,