Struct Affine 

pub struct Affine<P: SWCurveConfig> { /* private fields */ }

Affine coordinates for a point on an elliptic curve in short Weierstrass form, over the base field P::BaseField.

Implementations

impl<P: SWCurveConfig> Affine<P>

pub fn new(x: P::BaseField, y: P::BaseField) -> Self

Constructs a group element from x and y coordinates. Performs checks to ensure that the point is on the curve and is in the right subgroup.

pub const fn new_unchecked(x: P::BaseField, y: P::BaseField) -> Self

Constructs a group element from x and y coordinates.

Warning

Does not perform any checks to ensure the point is in the curve or is in the right subgroup.

pub const fn identity() -> Self

pub fn get_point_from_x_unchecked( x: P::BaseField, greatest: bool, ) -> Option<Self>

Attempts to construct an affine point given an x-coordinate. The point is not guaranteed to be in the prime order subgroup.

If and only if greatest is set will the lexicographically largest y-coordinate be selected.

pub fn get_ys_from_x_unchecked( x: P::BaseField, ) -> Option<(P::BaseField, P::BaseField)>

Returns the two possible y-coordinates corresponding to the given x-coordinate. The corresponding points are not guaranteed to be in the prime-order subgroup, but are guaranteed to be on the curve. That is, this method returns None if the x-coordinate corresponds to a non-curve point.

The results are sorted by lexicographical order. This means that, if P::BaseField: PrimeField, the results are sorted as integers.

pub fn is_on_curve(&self) -> bool

Checks if self is a valid point on the curve.

pub fn to_flags(&self) -> SWFlags

pub fn double_to_bucket(&self) -> Bucket<P>

impl<P: SWCurveConfig> Affine<P>

pub fn is_in_correct_subgroup_assuming_on_curve(&self) -> bool

Checks if self is in the subgroup having order that equaling that of P::ScalarField.

Trait Implementations

impl<'a, P: SWCurveConfig> Add<&'a Projective<P>> for Affine<P>

type Output = Projective<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: SWCurveConfig> Add<Projective<P>> for Affine<P>

type Output = Projective<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: SWCurveConfig, T: Borrow<Self>> Add<T> for Affine<P>

type Output = Projective<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: SWCurveConfig> AffineRepr for Affine<P>

fn mul_by_cofactor_to_group(&self) -> Self::Group

Multiplies this element by the cofactor and output the resulting projective element.

fn clear_cofactor(&self) -> Self

Performs cofactor clearing. The default method is simply to multiply by the cofactor. Some curves can implement a more efficient algorithm.

const GENERATOR: Self = P::GENERATOR

const ZERO: Self

type Config = P

type BaseField = <P as CurveConfig>::BaseField

The finite field over which this curve is defined.

type ScalarField = <P as CurveConfig>::ScalarField

type Group = Projective<P>

The projective representation of points on this curve.

fn xy(&self) -> Option<(Self::BaseField, Self::BaseField)>

Returns the x and y coordinates of this affine point.

fn generator() -> Self

Returns a fixed generator of unknown exponent.

fn zero() -> Self

Returns the point at infinity.

fn is_zero(&self) -> bool

Is self the point at infinity?

fn from_random_bytes(bytes: &[u8]) -> Option<Self>

Returns a group element if the set of bytes forms a valid group element, otherwise returns None. This function is primarily intended for sampling random group elements from a hash-function or RNG output.

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

Performs scalar multiplication of this element with mixed addition.

fn x(&self) -> Option<Self::BaseField>

Returns the x coordinate of this affine point.

fn y(&self) -> Option<Self::BaseField>

Returns the y coordinate of this affine point.

fn into_group(self) -> Self::Group

Converts self into the projective representation.

fn mul_by_cofactor(&self) -> Self

Multiplies this element by the cofactor.

fn mul_by_cofactor_inv(&self) -> Self

Multiplies this element by the inverse of the cofactor in Self::ScalarField.

impl<P: SWCurveConfig> CanonicalDeserialize for Affine<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: SWCurveConfig> CanonicalSerialize for Affine<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: SWCurveConfig> Clone for Affine<P>

where P::BaseField: Copy, P::ZeroFlag: 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: SWCurveConfig> Debug for Affine<P>

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

Formats the value using the given formatter.

impl<P: SWCurveConfig> Default for Affine<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: SWCurveConfig> Display for Affine<P>

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

Formats the value using the given formatter.

impl<P: SWCurveConfig> Distribution<Affine<P>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Affine<P>

Generates a uniformly random instance of the curve.

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<'a, P: BW6Config> From<&'a Affine<<P as BW6Config>::G1Config>> for G1Prepared<P>

fn from(other: &'a G1Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: BW6Config> From<&'a Affine<<P as BW6Config>::G2Config>> for G2Prepared<P>

fn from(q: &'a G2Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: Bls12Config> From<&'a Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>

fn from(other: &'a G1Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: Bls12Config> From<&'a Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>

fn from(other: &'a G2Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: BnConfig> From<&'a Affine<<P as BnConfig>::G1Config>> for G1Prepared<P>

fn from(other: &'a G1Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: BnConfig> From<&'a Affine<<P as BnConfig>::G2Config>> for G2Prepared<P>

fn from(other: &'a G2Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: MNT4Config> From<&'a Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>

fn from(g1: &'a G1Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: MNT4Config> From<&'a Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>

fn from(g2: &'a G2Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: MNT6Config> From<&'a Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>

fn from(g1: &'a G1Affine<P>) -> Self

Converts to this type from the input type.

impl<'a, P: MNT6Config> From<&'a Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>

fn from(g2: &'a G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: BW6Config> From<Affine<<P as BW6Config>::G1Config>> for G1Prepared<P>

fn from(other: G1Affine<P>) -> Self

Converts to this type from the input type.

impl<P: BW6Config> From<Affine<<P as BW6Config>::G2Config>> for G2Prepared<P>

fn from(q: G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: Bls12Config> From<Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>

fn from(other: G1Affine<P>) -> Self

Converts to this type from the input type.

impl<P: Bls12Config> From<Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>

fn from(q: G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: BnConfig> From<Affine<<P as BnConfig>::G1Config>> for G1Prepared<P>

fn from(other: G1Affine<P>) -> Self

Converts to this type from the input type.

impl<P: BnConfig> From<Affine<<P as BnConfig>::G2Config>> for G2Prepared<P>

fn from(q: G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: MNT4Config> From<Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>

fn from(g1: G1Affine<P>) -> Self

Converts to this type from the input type.

impl<P: MNT4Config> From<Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>

fn from(g: G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: MNT6Config> From<Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>

fn from(g1: G1Affine<P>) -> Self

Converts to this type from the input type.

impl<P: MNT6Config> From<Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>

fn from(g: G2Affine<P>) -> Self

Converts to this type from the input type.

impl<P: SWCurveConfig> From<Affine<P>> for Bucket<P>

fn from(p: Affine<P>) -> Self

Converts to this type from the input type.

impl<P: SWCurveConfig> From<Affine<P>> for Projective<P>

fn from(p: Affine<P>) -> Self

Converts to this type from the input type.

impl<P: SWCurveConfig> From<Bucket<P>> for Affine<P>

fn from(p: Bucket<P>) -> Self

Converts to this type from the input type.

impl<P: SWCurveConfig> From<Projective<P>> for Affine<P>

fn from(p: Projective<P>) -> Self

Converts to this type from the input type.

impl<P: SWCurveConfig> Hash for Affine<P>

where P::BaseField: Hash, P::ZeroFlag: 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: SWCurveConfig, T: Borrow<P::ScalarField>> Mul<T> for Affine<P>

type Output = Projective<P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<P: SWCurveConfig> Neg for Affine<P>

fn neg(self) -> Self

If self.is_zero(), returns self (== Self::zero()). Else, returns (x, -y), where self = (x, y).

type Output = Affine<P>

The resulting type after applying the - operator.

impl<P: SWCurveConfig> PartialEq<Affine<P>> for Projective<P>

fn eq(&self, other: &Affine<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: SWCurveConfig> PartialEq<Projective<P>> for Affine<P>

fn eq(&self, other: &Projective<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: SWCurveConfig> PartialEq for Affine<P>

where P::BaseField: PartialEq, P::ZeroFlag: 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<'a, P: SWCurveConfig> Sub<&'a Projective<P>> for Affine<P>

type Output = Projective<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: SWCurveConfig> Sub<Projective<P>> for Affine<P>

type Output = Projective<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: SWCurveConfig, T: Borrow<Self>> Sub<T> for Affine<P>

type Output = Projective<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<M: SWCurveConfig, ConstraintF: Field> ToConstraintField<ConstraintF> for Affine<M>

where M::BaseField: ToConstraintField<ConstraintF>,

fn to_field_elements(&self) -> Option<Vec<ConstraintF>>

impl<P: SWCurveConfig> Valid for Affine<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: SWCurveConfig> Zeroize for Affine<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: SWCurveConfig> Copy for Affine<P>

where P::BaseField: Copy, P::ZeroFlag: Copy,

impl<P: SWCurveConfig> Eq for Affine<P>

where P::BaseField: PartialEq, P::ZeroFlag: PartialEq,