Rename AffineElement to AffinePoint to match min_curve

penumbra-zone · Jan 31, 2024 · e7f7093 · e7f7093
1 parent 018c2ee
commit e7f7093
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 126 deletions.
diff --git a/src/ark_curve/edwards.rs b/src/ark_curve/edwards.rs
@@ -12,7 +12,7 @@ pub struct Decaf377EdwardsConfig;
 // These types should not be exported. They are similar to `EdwardsAffine` and
 // `EdwardsProjective` from the `ark_ed_on_bls12_377` crate, except using our own
 // `Decaf377Config` that has the cofactor set to 1. Consumers of this
-// library should use the `AffineElement` and `Element` (projective)
+// library should use the `AffinePoint` and `Element` (projective)
 // types.
 pub type EdwardsAffine = Affine<Decaf377EdwardsConfig>;
 pub type EdwardsProjective = Projective<Decaf377EdwardsConfig>;

diff --git a/src/ark_curve/element.rs b/src/ark_curve/element.rs
@@ -10,7 +10,7 @@ use crate::{
 pub mod affine;
 pub mod projective;
 
-pub use affine::AffineElement;
+pub use affine::AffinePoint;
 pub use projective::Element;
 
 impl Valid for Element {
@@ -20,7 +20,7 @@ impl Valid for Element {
 }
 
 impl ScalarMul for Element {
-    type MulBase = AffineElement;
+    type MulBase = AffinePoint;
 
     const NEGATION_IS_CHEAP: bool = true;
 
@@ -29,7 +29,7 @@ impl ScalarMul for Element {
         let result = EdwardsProjective::batch_convert_to_mul_base(&bases_inner[..]);
         result
             .into_iter()
-            .map(|g| AffineElement { inner: g })
+            .map(|g| AffinePoint { inner: g })
             .collect::<Vec<_>>()
     }
 }
@@ -64,19 +64,19 @@ impl CurveGroup for Element {
 
     type BaseField = Fq;
 
-    type Affine = AffineElement;
+    type Affine = AffinePoint;
 
     // This type is supposed to represent an element of the entire elliptic
     // curve group, not just the prime-order subgroup. Since this is decaf,
     // this is just an `Element` again.
-    type FullGroup = AffineElement;
+    type FullGroup = AffinePoint;
 
-    fn normalize_batch(v: &[Self]) -> Vec<AffineElement> {
+    fn normalize_batch(v: &[Self]) -> Vec<AffinePoint> {
         let v_inner = v.iter().map(|g| g.inner).collect::<Vec<_>>();
         let result = EdwardsProjective::normalize_batch(&v_inner[..]);
         result
             .into_iter()
-            .map(|g| AffineElement { inner: g })
+            .map(|g| AffinePoint { inner: g })
             .collect::<Vec<_>>()
     }
 
@@ -85,13 +85,13 @@ impl CurveGroup for Element {
     }
 }
 
-impl Valid for AffineElement {
+impl Valid for AffinePoint {
     fn check(&self) -> Result<(), ark_serialize::SerializationError> {
         Ok(())
     }
 }
 
-impl AffineRepr for AffineElement {
+impl AffineRepr for AffinePoint {
     type Config = Decaf377EdwardsConfig;
 
     type ScalarField = Fr;
@@ -105,7 +105,7 @@ impl AffineRepr for AffineElement {
     }
 
     fn zero() -> Self {
-        AffineElement {
+        AffinePoint {
             inner: EdwardsAffine::zero(),
         }
     }
@@ -115,7 +115,7 @@ impl AffineRepr for AffineElement {
     }
 
     fn from_random_bytes(bytes: &[u8]) -> Option<Self> {
-        EdwardsAffine::from_random_bytes(bytes).map(|inner| AffineElement { inner })
+        EdwardsAffine::from_random_bytes(bytes).map(|inner| AffinePoint { inner })
     }
 
     fn mul_bigint(&self, other: impl AsRef<[u64]>) -> Self::Group {
@@ -134,32 +134,32 @@ impl AffineRepr for AffineElement {
     }
 }
 
-impl From<Element> for AffineElement {
+impl From<Element> for AffinePoint {
     fn from(point: Element) -> Self {
         Self {
             inner: point.inner.into(),
         }
     }
 }
 
-impl From<AffineElement> for Element {
-    fn from(point: AffineElement) -> Self {
+impl From<AffinePoint> for Element {
+    fn from(point: AffinePoint) -> Self {
         Self {
             inner: point.inner.into(),
         }
     }
 }
 
-impl From<&Element> for AffineElement {
+impl From<&Element> for AffinePoint {
     fn from(point: &Element) -> Self {
         Self {
             inner: point.inner.into(),
         }
     }
 }
 
-impl From<&AffineElement> for Element {
-    fn from(point: &AffineElement) -> Self {
+impl From<&AffinePoint> for Element {
+    fn from(point: &AffinePoint) -> Self {
         Self {
             inner: point.inner.into(),
         }

diff --git a/src/ark_curve/element/affine.rs b/src/ark_curve/element/affine.rs
@@ -9,65 +9,65 @@ use zeroize::Zeroize;
 use crate::Element;
 
 #[derive(Copy, Clone)]
-pub struct AffineElement {
+pub struct AffinePoint {
     pub(crate) inner: EdwardsAffine,
 }
 
-impl Hash for AffineElement {
+impl Hash for AffinePoint {
     fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
         self.inner.hash(state);
     }
 }
 
-impl Default for AffineElement {
+impl Default for AffinePoint {
     fn default() -> Self {
         Element::default().into()
     }
 }
 
-impl core::iter::Sum<AffineElement> for Element {
-    fn sum<I: Iterator<Item = AffineElement>>(iter: I) -> Self {
+impl core::iter::Sum<AffinePoint> for Element {
+    fn sum<I: Iterator<Item = AffinePoint>>(iter: I) -> Self {
         iter.fold(Self::zero(), core::ops::Add::add)
     }
 }
 
-impl<'a> core::iter::Sum<&'a AffineElement> for Element {
-    fn sum<I: Iterator<Item = &'a AffineElement>>(iter: I) -> Self {
+impl<'a> core::iter::Sum<&'a AffinePoint> for Element {
+    fn sum<I: Iterator<Item = &'a AffinePoint>>(iter: I) -> Self {
         iter.fold(Self::zero(), core::ops::Add::add)
     }
 }
 
-impl PartialEq for AffineElement {
-    fn eq(&self, other: &AffineElement) -> bool {
+impl PartialEq for AffinePoint {
+    fn eq(&self, other: &AffinePoint) -> bool {
         // Section 4.5 of Decaf paper
         self.inner.x * other.inner.y == self.inner.y * other.inner.x
     }
 }
 
-impl Eq for AffineElement {}
+impl Eq for AffinePoint {}
 
-impl core::fmt::Debug for AffineElement {
+impl core::fmt::Debug for AffinePoint {
     fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
         let element: Element = self.into();
         f.write_fmt(format_args!(
-            "decaf377::AffineElement({})",
+            "decaf377::AffinePoint({})",
             hex::encode(&element.vartime_compress().0[..])
         ))
     }
 }
 
-impl Display for AffineElement {
+impl Display for AffinePoint {
     fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
         let element: Element = self.into();
         write!(
             f,
-            "decaf377::AffineElement({})",
+            "decaf377::AffinePoint({})",
             hex::encode(&element.vartime_compress().0[..])
         )
     }
 }
 
-impl Zeroize for AffineElement {
+impl Zeroize for AffinePoint {
     fn zeroize(&mut self) {
         self.inner.zeroize()
     }

diff --git a/src/ark_curve/mod.rs b/src/ark_curve/mod.rs
@@ -12,7 +12,7 @@ pub mod serialize;
 
 pub use constants::ZETA;
 pub(crate) use edwards::{Decaf377EdwardsConfig, EdwardsProjective};
-pub use element::{AffineElement, Element};
+pub use element::{AffinePoint, Element};
 pub use encoding::Encoding;
 
 mod on_curve;