Struct ark_test_curves::short_weierstrass::Affine
source · pub struct Affine<P>where
P: SWCurveConfig,{ /* private fields */ }
Expand description
Affine coordinates for a point on an elliptic curve in short Weierstrass
form, over the base field P::BaseField
.
Implementations§
source§impl<P> Affine<P>where
P: SWCurveConfig,
impl<P> Affine<P>where P: SWCurveConfig,
sourcepub fn new(
x: <P as CurveConfig>::BaseField,
y: <P as CurveConfig>::BaseField
) -> Affine<P>
pub fn new( x: <P as CurveConfig>::BaseField, y: <P as CurveConfig>::BaseField ) -> Affine<P>
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.
sourcepub const fn new_unchecked(
x: <P as CurveConfig>::BaseField,
y: <P as CurveConfig>::BaseField
) -> Affine<P>
pub const fn new_unchecked( x: <P as CurveConfig>::BaseField, y: <P as CurveConfig>::BaseField ) -> Affine<P>
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() -> Affine<P>
sourcepub fn get_point_from_x_unchecked(
x: <P as CurveConfig>::BaseField,
greatest: bool
) -> Option<Affine<P>>
pub fn get_point_from_x_unchecked( x: <P as CurveConfig>::BaseField, greatest: bool ) -> Option<Affine<P>>
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.
sourcepub fn get_ys_from_x_unchecked(
x: <P as CurveConfig>::BaseField
) -> Option<(<P as CurveConfig>::BaseField, <P as CurveConfig>::BaseField)>
pub fn get_ys_from_x_unchecked( x: <P as CurveConfig>::BaseField ) -> Option<(<P as CurveConfig>::BaseField, <P as CurveConfig>::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.
sourcepub fn is_on_curve(&self) -> bool
pub fn is_on_curve(&self) -> bool
Checks if self
is a valid point on the curve.
pub fn to_flags(&self) -> SWFlags
source§impl<P> Affine<P>where
P: SWCurveConfig,
impl<P> Affine<P>where P: SWCurveConfig,
sourcepub fn is_in_correct_subgroup_assuming_on_curve(&self) -> bool
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§
source§impl<'a, P> Add<&'a Projective<P>> for Affine<P>where
P: SWCurveConfig,
impl<'a, P> Add<&'a Projective<P>> for Affine<P>where P: SWCurveConfig,
§type Output = Projective<P>
type Output = Projective<P>
+
operator.source§fn add(self, other: &'a Projective<P>) -> Projective<P>
fn add(self, other: &'a Projective<P>) -> Projective<P>
+
operation. Read moresource§impl<P> Add<Projective<P>> for Affine<P>where
P: SWCurveConfig,
impl<P> Add<Projective<P>> for Affine<P>where P: SWCurveConfig,
§type Output = Projective<P>
type Output = Projective<P>
+
operator.source§fn add(self, other: Projective<P>) -> Projective<P>
fn add(self, other: Projective<P>) -> Projective<P>
+
operation. Read moresource§impl<P, T> Add<T> for Affine<P>where
P: SWCurveConfig,
T: Borrow<Affine<P>>,
impl<P, T> Add<T> for Affine<P>where P: SWCurveConfig, T: Borrow<Affine<P>>,
§type Output = Projective<P>
type Output = Projective<P>
+
operator.source§fn add(self, other: T) -> Projective<P>
fn add(self, other: T) -> Projective<P>
+
operation. Read moresource§impl<P> AffineRepr for Affine<P>where
P: SWCurveConfig,
impl<P> AffineRepr for Affine<P>where P: SWCurveConfig,
source§fn mul_by_cofactor_to_group(&self) -> <Affine<P> as AffineRepr>::Group
fn mul_by_cofactor_to_group(&self) -> <Affine<P> as AffineRepr>::Group
Multiplies this element by the cofactor and output the resulting projective element.
source§fn clear_cofactor(&self) -> Affine<P>
fn clear_cofactor(&self) -> Affine<P>
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 = <P as CurveConfig>::BaseField
type BaseField = <P as CurveConfig>::BaseField
type ScalarField = <P as CurveConfig>::ScalarField
§type Group = Projective<P>
type Group = Projective<P>
source§fn xy(
&self
) -> Option<(&<Affine<P> as AffineRepr>::BaseField, &<Affine<P> as AffineRepr>::BaseField)>
fn xy( &self ) -> Option<(&<Affine<P> as AffineRepr>::BaseField, &<Affine<P> as AffineRepr>::BaseField)>
source§fn from_random_bytes(bytes: &[u8]) -> Option<Affine<P>>
fn from_random_bytes(bytes: &[u8]) -> Option<Affine<P>>
source§fn mul_bigint(&self, by: impl AsRef<[u64]>) -> <Affine<P> as AffineRepr>::Group
fn mul_bigint(&self, by: impl AsRef<[u64]>) -> <Affine<P> as AffineRepr>::Group
source§fn into_group(self) -> Self::Group
fn into_group(self) -> Self::Group
source§fn mul_by_cofactor(&self) -> Self
fn mul_by_cofactor(&self) -> Self
source§fn mul_by_cofactor_inv(&self) -> Self
fn mul_by_cofactor_inv(&self) -> Self
Self::ScalarField
.source§impl<P> CanonicalDeserialize for Affine<P>where
P: SWCurveConfig,
impl<P> CanonicalDeserialize for Affine<P>where P: SWCurveConfig,
source§fn deserialize_with_mode<R>(
reader: R,
compress: Compress,
validate: Validate
) -> Result<Affine<P>, SerializationError>where
R: Read,
fn deserialize_with_mode<R>( reader: R, compress: Compress, validate: Validate ) -> Result<Affine<P>, SerializationError>where R: Read,
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,
source§impl<P> CanonicalSerialize for Affine<P>where
P: SWCurveConfig,
impl<P> CanonicalSerialize for Affine<P>where P: SWCurveConfig,
source§fn serialize_with_mode<W>(
&self,
writer: W,
compress: Compress
) -> Result<(), SerializationError>where
W: Write,
fn serialize_with_mode<W>( &self, writer: W, compress: Compress ) -> Result<(), SerializationError>where W: Write,
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
source§impl<P> Clone for Affine<P>where
P: SWCurveConfig,
impl<P> Clone for Affine<P>where P: SWCurveConfig,
source§impl<P> Debug for Affine<P>where
P: SWCurveConfig,
impl<P> Debug for Affine<P>where P: SWCurveConfig,
source§impl<P> Default for Affine<P>where
P: SWCurveConfig,
impl<P> Default for Affine<P>where P: SWCurveConfig,
source§impl<P> Display for Affine<P>where
P: SWCurveConfig,
impl<P> Display for Affine<P>where P: SWCurveConfig,
source§impl<'a, P> From<&'a Affine<<P as BW6Config>::G1Config>> for G1Prepared<P>where
P: BW6Config,
impl<'a, P> From<&'a Affine<<P as BW6Config>::G1Config>> for G1Prepared<P>where P: BW6Config,
source§impl<'a, P> From<&'a Affine<<P as BW6Config>::G2Config>> for G2Prepared<P>where
P: BW6Config,
impl<'a, P> From<&'a Affine<<P as BW6Config>::G2Config>> for G2Prepared<P>where P: BW6Config,
source§impl<'a, P> From<&'a Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>where
P: Bls12Config,
impl<'a, P> From<&'a Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>where P: Bls12Config,
source§fn from(other: &'a Affine<<P as Bls12Config>::G1Config>) -> G1Prepared<P>
fn from(other: &'a Affine<<P as Bls12Config>::G1Config>) -> G1Prepared<P>
source§impl<'a, P> From<&'a Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>where
P: Bls12Config,
impl<'a, P> From<&'a Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>where P: Bls12Config,
source§fn from(other: &'a Affine<<P as Bls12Config>::G2Config>) -> G2Prepared<P>
fn from(other: &'a Affine<<P as Bls12Config>::G2Config>) -> G2Prepared<P>
source§impl<'a, P> From<&'a Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>where
P: MNT4Config,
impl<'a, P> From<&'a Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>where P: MNT4Config,
source§fn from(g1: &'a Affine<<P as MNT4Config>::G1Config>) -> G1Prepared<P>
fn from(g1: &'a Affine<<P as MNT4Config>::G1Config>) -> G1Prepared<P>
source§impl<'a, P> From<&'a Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>where
P: MNT4Config,
impl<'a, P> From<&'a Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>where P: MNT4Config,
source§fn from(g2: &'a Affine<<P as MNT4Config>::G2Config>) -> G2Prepared<P>
fn from(g2: &'a Affine<<P as MNT4Config>::G2Config>) -> G2Prepared<P>
source§impl<'a, P> From<&'a Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>where
P: MNT6Config,
impl<'a, P> From<&'a Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>where P: MNT6Config,
source§fn from(g1: &'a Affine<<P as MNT6Config>::G1Config>) -> G1Prepared<P>
fn from(g1: &'a Affine<<P as MNT6Config>::G1Config>) -> G1Prepared<P>
source§impl<'a, P> From<&'a Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>where
P: MNT6Config,
impl<'a, P> From<&'a Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>where P: MNT6Config,
source§fn from(g2: &'a Affine<<P as MNT6Config>::G2Config>) -> G2Prepared<P>
fn from(g2: &'a Affine<<P as MNT6Config>::G2Config>) -> G2Prepared<P>
source§impl<P> From<Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>where
P: Bls12Config,
impl<P> From<Affine<<P as Bls12Config>::G1Config>> for G1Prepared<P>where P: Bls12Config,
source§fn from(other: Affine<<P as Bls12Config>::G1Config>) -> G1Prepared<P>
fn from(other: Affine<<P as Bls12Config>::G1Config>) -> G1Prepared<P>
source§impl<P> From<Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>where
P: Bls12Config,
impl<P> From<Affine<<P as Bls12Config>::G2Config>> for G2Prepared<P>where P: Bls12Config,
source§fn from(q: Affine<<P as Bls12Config>::G2Config>) -> G2Prepared<P>
fn from(q: Affine<<P as Bls12Config>::G2Config>) -> G2Prepared<P>
source§impl<P> From<Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>where
P: MNT4Config,
impl<P> From<Affine<<P as MNT4Config>::G1Config>> for G1Prepared<P>where P: MNT4Config,
source§fn from(g1: Affine<<P as MNT4Config>::G1Config>) -> G1Prepared<P>
fn from(g1: Affine<<P as MNT4Config>::G1Config>) -> G1Prepared<P>
source§impl<P> From<Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>where
P: MNT4Config,
impl<P> From<Affine<<P as MNT4Config>::G2Config>> for G2Prepared<P>where P: MNT4Config,
source§fn from(g: Affine<<P as MNT4Config>::G2Config>) -> G2Prepared<P>
fn from(g: Affine<<P as MNT4Config>::G2Config>) -> G2Prepared<P>
source§impl<P> From<Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>where
P: MNT6Config,
impl<P> From<Affine<<P as MNT6Config>::G1Config>> for G1Prepared<P>where P: MNT6Config,
source§fn from(g1: Affine<<P as MNT6Config>::G1Config>) -> G1Prepared<P>
fn from(g1: Affine<<P as MNT6Config>::G1Config>) -> G1Prepared<P>
source§impl<P> From<Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>where
P: MNT6Config,
impl<P> From<Affine<<P as MNT6Config>::G2Config>> for G2Prepared<P>where P: MNT6Config,
source§fn from(g: Affine<<P as MNT6Config>::G2Config>) -> G2Prepared<P>
fn from(g: Affine<<P as MNT6Config>::G2Config>) -> G2Prepared<P>
source§impl<P> From<Affine<P>> for Projective<P>where
P: SWCurveConfig,
impl<P> From<Affine<P>> for Projective<P>where P: SWCurveConfig,
source§fn from(p: Affine<P>) -> Projective<P>
fn from(p: Affine<P>) -> Projective<P>
source§impl<P> From<Projective<P>> for Affine<P>where
P: SWCurveConfig,
impl<P> From<Projective<P>> for Affine<P>where P: SWCurveConfig,
source§fn from(p: Projective<P>) -> Affine<P>
fn from(p: Projective<P>) -> Affine<P>
source§impl<P> Hash for Affine<P>where
P: SWCurveConfig,
impl<P> Hash for Affine<P>where P: SWCurveConfig,
source§impl<P, T> Mul<T> for Affine<P>where
P: SWCurveConfig,
T: Borrow<<P as CurveConfig>::ScalarField>,
impl<P, T> Mul<T> for Affine<P>where P: SWCurveConfig, T: Borrow<<P as CurveConfig>::ScalarField>,
source§impl<P> Neg for Affine<P>where
P: SWCurveConfig,
impl<P> Neg for Affine<P>where P: SWCurveConfig,
source§impl<P> PartialEq<Affine<P>> for Affine<P>where
P: SWCurveConfig,
impl<P> PartialEq<Affine<P>> for Affine<P>where P: SWCurveConfig,
source§impl<P> PartialEq<Affine<P>> for Projective<P>where
P: SWCurveConfig,
impl<P> PartialEq<Affine<P>> for Projective<P>where P: SWCurveConfig,
source§impl<P> PartialEq<Projective<P>> for Affine<P>where
P: SWCurveConfig,
impl<P> PartialEq<Projective<P>> for Affine<P>where P: SWCurveConfig,
source§fn eq(&self, other: &Projective<P>) -> bool
fn eq(&self, other: &Projective<P>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<P, T> Sub<T> for Affine<P>where
P: SWCurveConfig,
T: Borrow<Affine<P>>,
impl<P, T> Sub<T> for Affine<P>where P: SWCurveConfig, T: Borrow<Affine<P>>,
§type Output = Projective<P>
type Output = Projective<P>
-
operator.source§fn sub(self, other: T) -> Projective<P>
fn sub(self, other: T) -> Projective<P>
-
operation. Read more