Merge branch 'master' into glv-for-simple-curves

ec/src/models/short_weierstrass/group.rs

@@ -1,3 +1,9 @@
+use super::{Affine, SWCurveConfig};
+use crate::{
+    scalar_mul::{variable_base::VariableBaseMSM, ScalarMul},
+    AffineRepr, CurveGroup, PrimeGroup,
+};
+use ark_ff::{fields::Field, AdditiveGroup, PrimeField, ToConstraintField, UniformRand};
 use ark_serialize::{
     CanonicalDeserialize, CanonicalSerialize, Compress, SerializationError, Valid, Validate,
 };
@@ -14,20 +20,10 @@ use ark_std::{
     vec::Vec,
     One, Zero,
 };
-
-use ark_ff::{fields::Field, AdditiveGroup, PrimeField, ToConstraintField, UniformRand};
-
 use derivative::Derivative;
-use zeroize::Zeroize;
-
 #[cfg(feature = "parallel")]
 use rayon::prelude::*;
-
-use super::{Affine, SWCurveConfig};
-use crate::{
-    scalar_mul::{variable_base::VariableBaseMSM, ScalarMul},
-    AffineRepr, CurveGroup, PrimeGroup,
-};
+use zeroize::Zeroize;
 
 /// Jacobian coordinates for a point on an elliptic curve in short Weierstrass
 /// form, over the base field `P::BaseField`. This struct implements arithmetic
@@ -362,12 +358,15 @@ impl<P: SWCurveConfig, T: Borrow<Affine<P>>> AddAssign<T> for Projective<P> {
             s2 *= &other_y;
             s2 *= &z1z1;
 
-            if self.x == u2 && self.y == s2 {
-                // The two points are equal, so we double.
-                self.double_in_place();
+            if self.x == u2 {
+                if self.y == s2 {
+                    // The two points are equal, so we double.
+                    self.double_in_place();
+                } else {
+                    // a + (-a) = 0
+                    *self = Self::zero()
+                }
             } else {
-                // If we're adding -a and a together, self.z becomes zero as H becomes zero.
-
                 // H = U2-X1
                 let mut h = u2;
                 h -= &self.x;
@@ -487,11 +486,14 @@ impl<'a, P: SWCurveConfig> AddAssign<&'a Self> for Projective<P> {
         s2 *= &z1z1;
 
         if u1 == u2 && s1 == s2 {
-            // The two points are equal, so we double.
-            self.double_in_place();
+            if s1 == s2 {
+                // The two points are equal, so we double.
+                self.double_in_place();
+            } else {
+                // a + (-a) = 0
+                *self = Self::zero();
+            }
         } else {
-            // If we're adding -a and a together, self.z becomes zero as H becomes zero.
-
             // H = U2-U1
             let mut h = u2;
             h -= &u1;

ff/README.md

@@ -150,10 +150,10 @@ to implement the [`PrimeField`][prime_field] trait for it. This provides access
 additional APIs:
 
 ```rust
-use ark_ff::{Field, PrimeField, FpConfig, BigInteger};
+use ark_ff::{Field, PrimeField, FpConfig, BigInteger, Zero};
 // Now we'll use the prime field underlying the BLS12-381 G1 curve.
 use ark_test_curves::bls12_381::Fq as F;
-use ark_std::{One, Zero, UniformRand};
+use ark_std::{One, UniformRand};
 
 let mut rng = ark_std::test_rng();
 let a = F::rand(&mut rng);

ff/src/fields/mod.rs

@@ -14,7 +14,7 @@ use ark_std::{
 };
 
 pub use ark_ff_macros;
-use num_traits::{One, Zero};
+pub use num_traits::{One, Zero};
 use zeroize::Zeroize;
 
 pub mod utils;

ff/src/fields/models/cubic_extension.rs

@@ -1,3 +1,7 @@
+use crate::{
+    fields::{Field, PrimeField},
+    AdditiveGroup, LegendreSymbol, One, SqrtPrecomputation, ToConstraintField, UniformRand, Zero,
+};
 use ark_serialize::{
     CanonicalDeserialize, CanonicalDeserializeWithFlags, CanonicalSerialize,
     CanonicalSerializeWithFlags, Compress, EmptyFlags, Flags, SerializationError, Valid, Validate,
@@ -8,22 +12,14 @@ use ark_std::{
     io::{Read, Write},
     iter::{Chain, IntoIterator},
     ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
+    rand::{
+        distributions::{Distribution, Standard},
+        Rng,
+    },
     vec::Vec,
 };
-
-use num_traits::{One, Zero};
 use zeroize::Zeroize;
 
-use ark_std::rand::{
-    distributions::{Distribution, Standard},
-    Rng,
-};
-
-use crate::{
-    fields::{Field, PrimeField},
-    AdditiveGroup, LegendreSymbol, SqrtPrecomputation, ToConstraintField, UniformRand,
-};
-
 /// Defines a Cubic extension field from a cubic non-residue.
 pub trait CubicExtConfig: 'static + Send + Sync + Sized {
     /// The prime field that this cubic extension is eventually an extension of.

ff/src/fields/models/fp/mod.rs

@@ -1,5 +1,7 @@
-use core::iter;
-
+use crate::{
+    AdditiveGroup, BigInt, BigInteger, FftField, Field, LegendreSymbol, One, PrimeField,
+    SqrtPrecomputation, Zero,
+};
 use ark_serialize::{
     buffer_byte_size, CanonicalDeserialize, CanonicalDeserializeWithFlags, CanonicalSerialize,
     CanonicalSerializeWithFlags, Compress, EmptyFlags, Flags, SerializationError, Valid, Validate,
@@ -11,17 +13,13 @@ use ark_std::{
     ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
     str::FromStr,
     string::ToString,
-    One, Zero,
 };
+use core::iter;
 
 #[macro_use]
 mod montgomery_backend;
 pub use montgomery_backend::*;
 
-use crate::{
-    AdditiveGroup, BigInt, BigInteger, FftField, Field, LegendreSymbol, PrimeField,
-    SqrtPrecomputation,
-};
 /// A trait that specifies the configuration of a prime field.
 /// Also specifies how to perform arithmetic on field elements.
 pub trait FpConfig<const N: usize>: Send + Sync + 'static + Sized {

ff/src/fields/models/fp/montgomery_backend.rs

@@ -1,8 +1,9 @@
-use ark_std::{marker::PhantomData, Zero};
-
 use super::{Fp, FpConfig};
-use crate::{biginteger::arithmetic as fa, BigInt, BigInteger, PrimeField, SqrtPrecomputation};
+use crate::{
+    biginteger::arithmetic as fa, BigInt, BigInteger, PrimeField, SqrtPrecomputation, Zero,
+};
 use ark_ff_macros::unroll_for_loops;
+use ark_std::marker::PhantomData;
 
 /// A trait that specifies the constants and arithmetic procedures
 /// for Montgomery arithmetic over the prime field defined by `MODULUS`.
@@ -161,9 +162,9 @@ pub trait MontConfig<const N: usize>: 'static + Sync + Send + Sized {
             {
                 #[cfg(
                     all(
-                        feature = "asm", 
-                        target_feature = "bmi2", 
-                        target_feature = "adx", 
+                        feature = "asm",
+                        target_feature = "bmi2",
+                        target_feature = "adx",
                         target_arch = "x86_64"
                     )
                 )]

ff/src/fields/models/fp12_2over3over2.rs

@@ -1,12 +1,10 @@
-use ark_std::Zero;
-
 use super::quadratic_extension::{QuadExtConfig, QuadExtField};
 use crate::{
     fields::{
         fp6_3over2::{Fp6, Fp6Config},
         Field, Fp2, Fp2Config as Fp2ConfigTrait,
     },
-    AdditiveGroup, CyclotomicMultSubgroup,
+    AdditiveGroup, CyclotomicMultSubgroup, Zero,
 };
 use core::{
     marker::PhantomData,

ff/src/fields/models/fp2.rs

@@ -1,7 +1,5 @@
-use ark_std::Zero;
-
 use super::quadratic_extension::{QuadExtConfig, QuadExtField};
-use crate::{fields::PrimeField, CyclotomicMultSubgroup};
+use crate::{fields::PrimeField, CyclotomicMultSubgroup, Zero};
 use core::{marker::PhantomData, ops::Not};
 
 /// Trait that specifies constants and methods for defining degree-two extension fields.

ff/src/fields/models/fp4.rs

@@ -1,12 +1,9 @@
-use ark_std::Zero;
-
 use super::quadratic_extension::{QuadExtConfig, QuadExtField};
-use core::{marker::PhantomData, ops::Not};
-
 use crate::{
     fields::{Fp2, Fp2Config},
-    CyclotomicMultSubgroup,
+    CyclotomicMultSubgroup, Zero,
 };
+use core::{marker::PhantomData, ops::Not};
 
 pub trait Fp4Config: 'static + Send + Sync {
     type Fp2Config: Fp2Config;

ff/src/fields/models/fp6_2over3.rs

@@ -1,16 +1,13 @@
-use ark_std::Zero;
-
 use super::quadratic_extension::{QuadExtConfig, QuadExtField};
+use crate::{
+    fields::{Fp3, Fp3Config},
+    CyclotomicMultSubgroup, Zero,
+};
 use core::{
     marker::PhantomData,
     ops::{MulAssign, Not},
 };
 
-use crate::{
-    fields::{Fp3, Fp3Config},
-    CyclotomicMultSubgroup,
-};
-
 pub trait Fp6Config: 'static + Send + Sync {
     type Fp3Config: Fp3Config;
 

ff/src/fields/models/quadratic_extension.rs

@@ -1,3 +1,8 @@
+use crate::{
+    biginteger::BigInteger,
+    fields::{Field, LegendreSymbol, PrimeField},
+    AdditiveGroup, One, SqrtPrecomputation, ToConstraintField, UniformRand, Zero,
+};
 use ark_serialize::{
     CanonicalDeserialize, CanonicalDeserializeWithFlags, CanonicalSerialize,
     CanonicalSerializeWithFlags, Compress, EmptyFlags, Flags, SerializationError, Valid, Validate,
@@ -8,23 +13,14 @@ use ark_std::{
     io::{Read, Write},
     iter::{Chain, IntoIterator},
     ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
+    rand::{
+        distributions::{Distribution, Standard},
+        Rng,
+    },
     vec::Vec,
 };
-
-use num_traits::{One, Zero};
 use zeroize::Zeroize;
 
-use ark_std::rand::{
-    distributions::{Distribution, Standard},
-    Rng,
-};
-
-use crate::{
-    biginteger::BigInteger,
-    fields::{Field, LegendreSymbol, PrimeField},
-    AdditiveGroup, SqrtPrecomputation, ToConstraintField, UniformRand,
-};
-
 /// Defines a Quadratic extension field from a quadratic non-residue.
 pub trait QuadExtConfig: 'static + Send + Sync + Sized {
     /// The prime field that this quadratic extension is eventually an extension of.

ff/src/fields/prime.rs

@@ -3,11 +3,11 @@ use crate::{BigInteger, FftField, Field};
 use ark_std::{cmp::min, str::FromStr};
 use num_bigint::BigUint;
 
-/// The interface for a prime field, i.e. the field of integers modulo a prime $p$.  
+/// The interface for a prime field, i.e. the field of integers modulo a prime $p$.
 /// In the following example we'll use the prime field underlying the BLS12-381 G1 curve.
 /// ```rust
-/// use ark_ff::{BigInteger, Field, PrimeField};
-/// use ark_std::{test_rng, One, UniformRand, Zero};
+/// use ark_ff::{BigInteger, Field, PrimeField, Zero};
+/// use ark_std::{test_rng, One, UniformRand};
 /// use ark_test_curves::bls12_381::Fq as F;
 ///
 /// let mut rng = test_rng();

ff/src/lib.rs

@@ -37,19 +37,16 @@ pub use ark_std::UniformRand;
 mod to_field_vec;
 pub use to_field_vec::ToConstraintField;
 
-pub use num_traits::{One, Zero};
-
 #[doc(hidden)]
 pub use ark_ff_asm::*;
 #[doc(hidden)]
 pub use ark_std::vec;
 
 pub mod prelude {
-    pub use crate::biginteger::BigInteger;
-
-    pub use crate::fields::{Field, PrimeField};
-
+    pub use crate::{
+        biginteger::BigInteger,
+        fields::{Field, PrimeField},
+        One, Zero,
+    };
     pub use ark_std::UniformRand;
-
-    pub use num_traits::{One, Zero};
 }

rustfmt.toml

@@ -1,15 +1,9 @@
 edition = "2021"
 
-condense_wildcard_suffixes = true
 match_block_trailing_comma = true
 
 reorder_imports = true
-imports_granularity = "Crate"
 
 use_field_init_shorthand = true
 use_try_shorthand = true
 
-normalize_comments = true
-
-format_macro_bodies = true
-format_code_in_doc_comments = true