Struct snarkvm_curves::templates::twisted_edwards_extended::GroupAffine

pub struct GroupAffine<P: Parameters> {
    pub x: P::BaseField,
    pub y: P::BaseField,
    // some fields omitted
}

Fields

x: P::BaseField

y: P::BaseField

Implementations

impl<P: Parameters> GroupAffine<P>

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

#[must_use]

pub fn scale_by_cofactor(&self) -> <Self as AffineCurve>::Projective

pub fn is_on_curve(&self) -> bool

Checks that the current point is on the elliptic curve.

Trait Implementations

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

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &'a 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>

fn from_x_coordinate(x: Self::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.

fn from_y_coordinate(y: Self::BaseField, greatest: bool) -> Option<Self>

Attempts to construct an affine point given a y-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.

fn is_on_curve(&self) -> bool

Checks that the current point is on the elliptic curve.

type BaseField = P::BaseField

type Projective = GroupProjective<P>

type ScalarField = P::ScalarField

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 add(self, other: &Self) -> Self

Performs the standard addition operation of this element with a given other element.

fn mul<S: Into<<Self::ScalarField as PrimeField>::BigInteger>>(
    &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 modulo the size of Self::ScalarField.

fn into_projective(&self) -> GroupProjective<P>

Converts this element into its projective representation.

fn is_in_correct_subgroup_assuming_on_curve(&self) -> bool

Checks that the point is in the prime order subgroup given the point on the curve.

fn to_x_coordinate(&self) -> Self::BaseField

Returns the x-coordinate of the point.

fn to_y_coordinate(&self) -> Self::BaseField

Returns the y-coordinate of the point.

#[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: &mut R) -> Result<Self, SerializationError>

Reads Self from reader.

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

Reads Self from reader without compression.

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

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

Serializes self into writer.

fn serialized_size(&self) -> usize

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

Serializes self into writer without compression.

fn uncompressed_size(&self) -> usize

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> ConstantSerializedSize for GroupAffine<P>

const SERIALIZED_SIZE: usize

const UNCOMPRESSED_SIZE: usize

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<'de, P: Parameters> Deserialize<'de> for GroupAffine<P> where
    P::BaseField: Deserialize<'de>,
    P::BaseField: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

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> Group for GroupAffine<P>

type ScalarField = P::ScalarField

#[must_use]

fn double(&self) -> Self

Returns self + self.

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

Sets self := self + self.

#[must_use]

fn mul(&self, other: &Self::ScalarField) -> Self

fn mul_assign(&mut self, other: &Self::ScalarField)

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<'a, P: Parameters> Mul<&'a <P as ModelParameters>::ScalarField> for GroupAffine<P>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: &'a P::ScalarField) -> Self

Performs the * operation.

impl<'a, P: Parameters> MulAssign<&'a <P as ModelParameters>::ScalarField> for GroupAffine<P>

fn mul_assign(&mut self, other: &'a P::ScalarField)

Performs the *= operation.

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

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

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> Serialize for GroupAffine<P> where
    P::BaseField: Serialize,
    P::BaseField: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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

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

Serializes self into writer.

impl<M: TEModelParameters, F: Field> ToConstraintField<F> for TEAffine<M> where
    M::BaseField: ToConstraintField<F>, 

fn to_field_elements(&self) -> Result<Vec<F>, ConstraintFieldError>

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

fn zero() -> Self

fn is_zero(&self) -> bool

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

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