Struct ark_ec::models::short_weierstrass_jacobian::GroupAffine

#[must_use]
pub struct GroupAffine<P: Parameters> {
    pub x: P::BaseField,
    pub y: P::BaseField,
    pub infinity: bool,
    // some fields omitted
}

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

Fields

x: P::BaseField

y: P::BaseField

infinity: bool

Implementations

impl<P: Parameters> GroupAffine<P>

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

pub fn scale_by_cofactor(&self) -> GroupProjective<P>

Multiply self by the cofactor of the curve, P::COFACTOR.

pub fn get_point_from_x(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 is_on_curve(&self) -> bool

Checks if self is a valid point on the curve.

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<P: Parameters> Add<GroupAffine<P>> for GroupAffine<P>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, P: Parameters> AddAssign<&'a GroupAffine<P>> for GroupAffine<P>

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

Performs the += operation.

impl<P: Parameters> AffineCurve for GroupAffine<P>

const COFACTOR: &'static [u64]

type BaseField = P::BaseField

type ScalarField = P::ScalarField

type Projective = GroupProjective<P>

fn prime_subgroup_generator() -> Self

Returns a fixed generator of unknown exponent.

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<S: Into<<Self::ScalarField as PrimeField>::BigInt>>(
    &self,
    by: S
) -> GroupProjective<P>

Performs scalar multiplication of this element with mixed addition.

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

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

fn mul_by_cofactor_inv(&self) -> Self

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

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

Converts self into the projective representation.

#[must_use]

fn mul_by_cofactor(&self) -> Self

Multiply this element by the cofactor.

impl<P: Parameters> CanonicalDeserialize for GroupAffine<P>

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

Reads Self from reader.

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

Reads Self from reader without compression.

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

Reads self from reader without compression, and without performing validity checks. Should be used only when the input is trusted.

impl<P: Parameters> CanonicalSerialize for GroupAffine<P>

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

Serializes self into writer. It is left up to a particular type for how it strikes the serialization efficiency vs compression tradeoff. For standard types (e.g. bool, lengths, etc.) typically an uncompressed form is used, whereas for algebraic types compressed forms are used.

fn serialized_size(&self) -> usize

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

Serializes self into writer without compression.

fn uncompressed_size(&self) -> usize

fn serialize_unchecked<W>(&self, writer: W) -> Result<(), SerializationError> where
    W: Write, 

Serializes self into writer without compression, and without performing validity checks. Should be used only when there is no danger of adversarial manipulation of the output.

impl<P: Parameters> Clone for GroupAffine<P> where
    P: Parameters, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Parameters> Debug for GroupAffine<P> where
    P: Parameters, 

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

Formats the value using the given formatter.

impl<P: Parameters> Default for GroupAffine<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: Parameters> Display for GroupAffine<P>

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

Formats the value using the given formatter.

impl<P: BW6Parameters> From<GroupAffine<<P as BW6Parameters>::G1Parameters>> for G1Prepared<P>

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

Performs the conversion.

impl<P: BW6Parameters> From<GroupAffine<<P as BW6Parameters>::G2Parameters>> for G2Prepared<P>

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

Performs the conversion.

impl<P: Bls12Parameters> From<GroupAffine<<P as Bls12Parameters>::G1Parameters>> for G1Prepared<P>

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

Performs the conversion.

impl<P: Bls12Parameters> From<GroupAffine<<P as Bls12Parameters>::G2Parameters>> for G2Prepared<P>

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

Performs the conversion.

impl<P: BnParameters> From<GroupAffine<<P as BnParameters>::G1Parameters>> for G1Prepared<P>

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

Performs the conversion.

impl<P: BnParameters> From<GroupAffine<<P as BnParameters>::G2Parameters>> for G2Prepared<P>

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

Performs the conversion.

impl<P: MNT4Parameters> From<GroupAffine<<P as MNT4Parameters>::G1Parameters>> for G1Prepared<P>

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

Performs the conversion.

impl<P: MNT4Parameters> From<GroupAffine<<P as MNT4Parameters>::G2Parameters>> for G2Prepared<P>

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

Performs the conversion.

impl<P: MNT6Parameters> From<GroupAffine<<P as MNT6Parameters>::G1Parameters>> for G1Prepared<P>

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

Performs the conversion.

impl<P: MNT6Parameters> From<GroupAffine<<P as MNT6Parameters>::G2Parameters>> for G2Prepared<P>

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

Performs the conversion.

impl<P: Parameters> From<GroupAffine<P>> for GroupProjective<P>

fn from(p: GroupAffine<P>) -> GroupProjective<P>

Performs the conversion.

impl<P: Parameters> From<GroupProjective<P>> for GroupAffine<P>

fn from(p: GroupProjective<P>) -> GroupAffine<P>

Performs the conversion.

impl<P: Parameters> FromBytes for GroupAffine<P>

fn read<R: Read>(reader: R) -> IoResult<Self>

Reads Self from reader.

impl<P: Parameters> Hash for GroupAffine<P> where
    P: Parameters, 

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, 

Feeds a slice of this type into the given Hasher.

impl<P: Parameters> Neg for GroupAffine<P>

fn neg(self) -> Self

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

type Output = Self

The resulting type after applying the - operator.

impl<P: Parameters> PartialEq<GroupAffine<P>> for GroupAffine<P> where
    P: Parameters, 

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<P: Parameters> PartialEq<GroupAffine<P>> for GroupProjective<P>

fn eq(&self, other: &GroupAffine<P>) -> 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<P: Parameters> PartialEq<GroupProjective<P>> for GroupAffine<P>

fn eq(&self, other: &GroupProjective<P>) -> 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, P: Parameters> Sum<&'a GroupAffine<P>> for GroupAffine<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: Parameters> Sum<GroupAffine<P>> for GroupAffine<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: Parameters> ToBytes for GroupAffine<P>

fn write<W: Write>(&self, writer: W) -> IoResult<()>

Serializes self into writer.

impl<M: Parameters, ConstraintF: Field> ToConstraintField<ConstraintF> for GroupAffine<M> where
    M::BaseField: ToConstraintField<ConstraintF>, 

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

impl<P: Parameters> Zero for GroupAffine<P>

fn zero() -> Self

Returns the point at infinity. Note that in affine coordinates, the point at infinity does not lie on the curve, and this is indicated by setting the infinity flag to true.

fn is_zero(&self) -> bool

Checks if self is the point at infinity.

fn set_zero(&mut self)

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

impl<P: Parameters> Zeroize for GroupAffine<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: Parameters> Copy for GroupAffine<P> where
    P: Parameters, 

impl<P: Parameters> Eq for GroupAffine<P> where
    P: Parameters,