Merge pull request #21 from AntelopeIO/operator_equal

Add missing `fp::operator==()`
AntelopeIO · Dec 16, 2023 · 397cfe1 · 397cfe1
2 parents b179f9b + c333790
commit 397cfe1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/include/bls12-381/fp.hpp b/include/bls12-381/fp.hpp
@@ -76,10 +76,11 @@ class fp
     template<size_t N> static fp modPrime(const std::array<uint64_t, N>& k);
 
     // Those operators are defined to support set and map.
-    // They are mathematically correctly in certain cases.
+    // They are mathematically correct in certain cases.
     // However, there are still ambiguity there as the fp can be in Montgomery form or not.
     // Please avoid using those operators.
     constexpr std::strong_ordering operator<=>(const fp& e) const { return cmp(e); }
+    constexpr bool operator==(const fp& e) const { return cmp(e) == std::strong_ordering::equal; }
 
     static const fp MODULUS;                            // base field modulus: p = 4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787 or 0x1A0111EA397FE69A4B1BA7B6434BACD764774B84F38512BF6730D2A0F6B0F6241EABFFFEB153FFFFB9FEFFFFFFFFAAAB
     static const uint64_t INP;                          // INP = -(p^{-1} mod 2^64) mod 2^64

diff --git a/test/unittests.cpp b/test/unittests.cpp
@@ -634,6 +634,14 @@ void TestFieldElementSerialization()
             {
                 throw invalid_argument("BE: bad serialization");
             }
+            if( a != b )
+            {
+               throw invalid_argument("BE: bad serialization");
+            }
+            if(!(a == b))
+            {
+               throw invalid_argument("BE: bad serialization");
+            }
         }
         for(size_t i = 0; i < fuz; i++)
         {
@@ -683,6 +691,14 @@ void TestG1Serialization()
         g1 a = random_g1();
         array<uint8_t, 144> buf = a.toJacobianBytesBE();
         g1 b = g1::fromJacobianBytesBE(buf).value();
+        if(a != b)
+        {
+            throw invalid_argument("g1, jacobian: bad serialization from/to");
+        }
+        if(!(a == b))
+        {
+            throw invalid_argument("g1, jacobian: bad serialization from/to");
+        }
         if(!a.equal(b))
         {
             throw invalid_argument("g1, jacobian: bad serialization from/to");