Struct ark_ec::models::short_weierstrass::Affine

impl<P: SWCurveConfig> Affine

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

impl<P: SWCurveConfig> Affine

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> for Affine

type Output = Projective

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

type Output = Projective

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

type Output = Projective

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl<P: SWCurveConfig> AffineRepr for Affine

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.

type Config = P

type BaseField = ::BaseField

The finite field over which this curve is defined.

type ScalarField = ::ScalarField

type Group = Projective

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 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 is_zero(&self) -> bool

Is self the point at infinity?

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

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: SWCurveConfig> CanonicalSerialize for Affine

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 Clone for Affinewhere P: SWCurveConfig,

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<P: SWCurveConfig> Debug for Affine

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

Formats the value using the given formatter. Read more

impl<P: SWCurveConfig> Default for Affine

fn default() -> Self

Returns the “default value” for a type. Read more

impl<P: SWCurveConfig> Display for Affine

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

Formats the value using the given formatter. Read more

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

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

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. Read more

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 Read more