Struct PairingOutput 

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

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::TargetField

Trait Implementations

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

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: Pairing> Add<&'a PairingOutput<P>> for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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: Pairing> Add<&'a mut PairingOutput<P>> for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = PairingOutput<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: Pairing> Add for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

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

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

Performs the += operation.

impl<P: Pairing> AddAssign for PairingOutput<P>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<P: Pairing> AdditiveGroup for PairingOutput<P>

const ZERO: Self

The additive identity of the field.

type Scalar = <P as Pairing>::ScalarField

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

Doubles self in place.

fn double(&self) -> Self

Doubles self.

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

Negates self in place.

impl<P: Pairing> CanonicalDeserialize for PairingOutput<P>

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

The general deserialize method that takes in customization flags.

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

where R: Read,

Reads Self from reader using the compressed form if applicable. Performs validation if applicable.

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

where R: Read,

Reads Self from reader using the compressed form if applicable, without validating the deserialized value.

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

where R: Read,

Reads Self from reader using the uncompressed form. Performs validation if applicable.

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

where R: Read,

Reads Self from reader using the uncompressed form, without validating the deserialized value.

impl<P: Pairing> CanonicalSerialize for PairingOutput<P>

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

The general serialize method that takes in customization flags.

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

Returns the size in bytes of the serialized version of self with the given compression mode.

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

where W: Write,

Serializes self into writer using the compressed form if applicable.

fn compressed_size(&self) -> usize

Returns the size in bytes of the compressed serialized version of self.

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

where W: Write,

Serializes self into writer using the uncompressed form.

fn uncompressed_size(&self) -> usize

Returns the size in bytes of the uncompressed serialized version of self.

impl<P: Pairing> Clone for PairingOutput<P>

where P::TargetField: Copy,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Pairing> Debug for PairingOutput<P>

where P::TargetField: Debug,

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

Formats the value using the given formatter.

impl<P: Pairing> Default for PairingOutput<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: Pairing> Display for PairingOutput<P>

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

Formats the value using the given formatter.

impl<P: Pairing> Distribution<PairingOutput<P>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> PairingOutput<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, Self: Sized,

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

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<P: Pairing> Hash for PairingOutput<P>

where P::TargetField: Hash,

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

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: Pairing, T: Borrow<P::ScalarField>> Mul<T> for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P: Pairing, T: Borrow<P::ScalarField>> MulAssign<T> for PairingOutput<P>

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<P: Pairing> Neg for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<P: Pairing> Ord for PairingOutput<P>

where P::TargetField: Ord, Self: Eq,

fn cmp(&self, other: &Self) -> 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: Pairing> PartialEq for PairingOutput<P>

where P::TargetField: PartialEq,

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

where P::TargetField: Ord, Self: Eq,

fn partial_cmp(&self, other: &Self) -> 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: Pairing> PrimeGroup for PairingOutput<P>

type ScalarField = <P as Pairing>::ScalarField

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

fn generator() -> Self

Returns a fixed generator of this group.

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

Performs scalar multiplication of this element.

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

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

impl<P: Pairing> ScalarMul for PairingOutput<P>

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

type MulBase = PairingOutput<P>

fn batch_convert_to_mul_base(bases: &[Self]) -> Vec<Self::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: Pairing> Sub<&'a PairingOutput<P>> for &'b PairingOutput<P>

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: Pairing> Sub<&'a PairingOutput<P>> for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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: Pairing> Sub<&'a mut PairingOutput<P>> for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = PairingOutput<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: Pairing> Sub for PairingOutput<P>

type Output = PairingOutput<P>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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

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

Performs the -= operation.

impl<P: Pairing> SubAssign for PairingOutput<P>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

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

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

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

impl<P: Pairing> Sum for PairingOutput<P>

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

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

impl<P: Pairing> Valid for PairingOutput<P>

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

Checks whether self is valid. If self is valid, returns Ok(()). Otherwise, returns an error describing the failure. This method is called by deserialize_with_mode if validate is Validate::Yes.

const TRIVIAL_CHECK: bool = false

Whether the check method is trivial (i.e. always returns Ok(())). If this is true, the batch_check method will skip all checks and return Ok(()). This should be set to true for types where check is trivial, e.g. integers, field elements, etc. This is false by default. This is primarily an optimization to skip unnecessary checks in batch_check.

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

where Self: 'a,

Checks whether all items in batch are valid. If all items are valid, returns Ok(()). Otherwise, returns an error describing the first failure.

impl<P: Pairing> VariableBaseMSM for PairingOutput<P>

const ZERO_BUCKET: Self::Bucket = Self::ZERO

type Bucket = PairingOutput<P>

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_u1(bases: &[Self::MulBase], scalars: &[bool]) -> Self

Performs multi-scalar multiplication when the scalars are known to be boolean. The default implementation is faster than Self::msm_bigint.

fn msm_u8(bases: &[Self::MulBase], scalars: &[u8]) -> Self

Performs multi-scalar multiplication when the scalars are known to be u8-sized. The default implementation is faster than Self::msm_bigint.

fn msm_u16(bases: &[Self::MulBase], scalars: &[u16]) -> Self

Performs multi-scalar multiplication when the scalars are known to be u16-sized. The default implementation is faster than Self::msm_bigint.

fn msm_u32(bases: &[Self::MulBase], scalars: &[u32]) -> Self

Performs multi-scalar multiplication when the scalars are known to be u32-sized. The default implementation is faster than Self::msm_bigint.

fn msm_u64(bases: &[Self::MulBase], scalars: &[u64]) -> Self

Performs multi-scalar multiplication when the scalars are known to be u64-sized. The default implementation is faster than Self::msm_bigint.

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

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

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

impl<P: Pairing> Zero for PairingOutput<P>

fn zero() -> Self

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: Pairing> Zeroize for PairingOutput<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.

impl<P: Pairing> Copy for PairingOutput<P>

where P::TargetField: Copy,

impl<P: Pairing> Eq for PairingOutput<P>

where P::TargetField: PartialEq,