Struct ark_ec::pairing::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<PairingOutput<P>> 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<PairingOutput<P>> for PairingOutput<P>

fn add_assign(&mut self, other: Self)

Performs the += operation.

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,

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

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,

fn clone(&self) -> Self

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,

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

Formats the value using the given formatter.

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

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> Group 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 double_in_place(&mut self) -> &mut Self

Double self in place.

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.

fn double(&self) -> Self

Doubles self.

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

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,
    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> Ord for PairingOutput<P>where
    P: Pairing,

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<P> PartialEq<PairingOutput<P>> for PairingOutput<P>where
    P: Pairing,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> PartialOrd<PairingOutput<P>> for PairingOutput<P>where
    P: Pairing,

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

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

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

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

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

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

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: Pairing> ScalarMul for PairingOutput<P>

type MulBase = PairingOutput<P>

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

fn batch_convert_to_mul_base(bases: &[Self]) -> Vec<Self::MulBase>

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<PairingOutput<P>> 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<PairingOutput<P>> 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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

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

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

Method which 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>

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

impl<P: Pairing> VariableBaseMSM for 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, without checking that bases.len() == scalars.len().

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) -> Selfwhere
    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> Copy for PairingOutput<P>where
    P: Pairing,

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