version 5.1.2 (#11)

Author: anderspkd

CMakeLists.txt

@@ -16,7 +16,7 @@
 
 cmake_minimum_required( VERSION 3.14 )
 
-project( scl VERSION 5.1.1 DESCRIPTION "Secure Computation Library" )
+project( scl VERSION 5.1.2 DESCRIPTION "Secure Computation Library" )
 
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE Release)

RELEASE.txt

@@ -1,3 +1,6 @@
+5.1.2: Style changes
+- Change naming style of private field members.
+
 5.1.1: Bug fixes and simplifications
 - Simplifed the NextToRun logic because a greedy strategy too often results in
   rollbacks.

include/scl/math/curves/secp256k1.h

@@ -41,17 +41,17 @@ struct Secp256k1 {
     /**
      * @brief Name of the secp256k1 field.
      */
-    constexpr static const char* kName = "secp256k1_field";
+    constexpr static const char* NAME = "secp256k1_field";
 
     /**
      * @brief Byte size of a secp256k1 field element.
      */
-    constexpr static const std::size_t kByteSize = 4 * sizeof(mp_limb_t);
+    constexpr static const std::size_t BYTE_SIZE = 4 * sizeof(mp_limb_t);
 
     /**
      * @brief Bit size of a secp256k1 field element.
      */
-    constexpr static const std::size_t kBitSize = 8 * kByteSize;
+    constexpr static const std::size_t BIT_SIZE = 8 * BYTE_SIZE;
   };
 
   /**
@@ -66,17 +66,17 @@ struct Secp256k1 {
     /**
      * @brief Name of the field.
      */
-    constexpr static const char* kName = "secp256k1_order";
+    constexpr static const char* NAME = "secp256k1_order";
 
     /**
      * @brief Size of an element in bytes.
      */
-    constexpr static const std::size_t kByteSize = 4 * sizeof(mp_limb_t);
+    constexpr static const std::size_t BYTE_SIZE = 4 * sizeof(mp_limb_t);
 
     /**
      * @brief Size of an element in bits.
      */
-    constexpr static const std::size_t kBitSize = 8 * kByteSize;
+    constexpr static const std::size_t BIT_SIZE = 8 * BYTE_SIZE;
   };
 
   /**
@@ -87,7 +87,7 @@ struct Secp256k1 {
   /**
    * @brief Name of the secp256k1 curve.
    */
-  constexpr static const char* kName = "secp256k1";
+  constexpr static const char* NAME = "secp256k1";
 };
 
 }  // namespace scl::math

include/scl/math/ec.h

@@ -67,15 +67,15 @@ class EC {
    * @brief A string indicating which curve this is.
    */
   constexpr static const char* Name() {
-    return Curve::kName;
+    return Curve::NAME;
   };
 
   /**
    * @brief Get the generator of this curve.
    */
   constexpr static EC Generator() {
     EC g;
-    CurveSetGenerator<Curve>(g.mValue);
+    CurveSetGenerator<Curve>(g.m_value);
     return g;
   };
 
@@ -86,7 +86,7 @@ class EC {
    */
   static EC Read(const unsigned char* src) {
     EC e;
-    CurveFromBytes<Curve>(e.mValue, src);
+    CurveFromBytes<Curve>(e.m_value, src);
     return e;
   };
 
@@ -95,15 +95,15 @@ class EC {
    */
   static EC FromAffine(const Field& x, const Field& y) {
     EC e;
-    CurveSetAffine<Curve>(e.mValue, x, y);
+    CurveSetAffine<Curve>(e.m_value, x, y);
     return e;
   };
 
   /**
    * @brief Create a new point equal to the point at infinity.
    */
   explicit constexpr EC() {
-    CurveSetPointAtInfinity<Curve>(mValue);
+    CurveSetPointAtInfinity<Curve>(m_value);
   };
 
   /**
@@ -112,7 +112,7 @@ class EC {
    * @return this
    */
   EC& operator+=(const EC& other) {
-    CurveAdd<Curve>(mValue, other.mValue);
+    CurveAdd<Curve>(m_value, other.m_value);
     return *this;
   };
 
@@ -132,7 +132,7 @@ class EC {
    * @return this after doubling.
    */
   EC& DoubleInPlace() {
-    CurveDouble<Curve>(mValue);
+    CurveDouble<Curve>(m_value);
     return *this;
   };
 
@@ -151,7 +151,7 @@ class EC {
    * @return this.
    */
   EC& operator-=(const EC& other) {
-    CurveSubtract<Curve>(mValue, other.mValue);
+    CurveSubtract<Curve>(m_value, other.m_value);
     return *this;
   };
 
@@ -172,7 +172,7 @@ class EC {
    * @return this.
    */
   EC& operator*=(const Number& scalar) {
-    CurveScalarMultiply<Curve>(mValue, scalar);
+    CurveScalarMultiply<Curve>(m_value, scalar);
     return *this;
   };
 
@@ -182,7 +182,7 @@ class EC {
    * @return this.
    */
   EC& operator*=(const Order& scalar) {
-    CurveScalarMultiply<Curve>(mValue, scalar);
+    CurveScalarMultiply<Curve>(m_value, scalar);
     return *this;
   };
 
@@ -234,7 +234,7 @@ class EC {
    * @return this.
    */
   EC& Negate() {
-    CurveNegate<Curve>(mValue);
+    CurveNegate<Curve>(m_value);
     return *this;
   }
 
@@ -253,7 +253,7 @@ class EC {
    * @return true if the two points are equal and false otherwise.
    */
   bool Equal(const EC& other) const {
-    return CurveEqual<Curve>(mValue, other.mValue);
+    return CurveEqual<Curve>(m_value, other.m_value);
   };
 
   /**
@@ -275,22 +275,22 @@ class EC {
    * @return true if this point is equal to the point at inifity.
    */
   bool PointAtInfinity() const {
-    return CurveIsPointAtInfinity<Curve>(mValue);
+    return CurveIsPointAtInfinity<Curve>(m_value);
   };
 
   /**
    * @brief Return this point as a pair of affine coordinates.
    * @return this point as a pair of affine coordinates.
    */
   std::array<Field, 2> ToAffine() const {
-    return CurveToAffine<Curve>(mValue);
+    return CurveToAffine<Curve>(m_value);
   };
 
   /**
    * @brief Output this point as a string.
    */
   std::string ToString() const {
-    return CurveToString<Curve>(mValue);
+    return CurveToString<Curve>(m_value);
   };
 
   /**
@@ -307,11 +307,11 @@ class EC {
    * @param compress whether to compress the point
    */
   void Write(unsigned char* dest, bool compress = true) const {
-    CurveToBytes<Curve>(dest, mValue, compress);
+    CurveToBytes<Curve>(dest, m_value, compress);
   };
 
  private:
-  typename Curve::ValueType mValue;
+  typename Curve::ValueType m_value;
 };
 
 /**

include/scl/math/ff.h

@@ -41,21 +41,21 @@ class FF final : Ring<FF<Field>> {
    * @brief Size in bytes of a field element.
    */
   constexpr static std::size_t ByteSize() {
-    return Field::kByteSize;
+    return Field::BYTE_SIZE;
   };
 
   /**
    * @brief Actual bit size of an element.
    */
   constexpr static std::size_t BitSize() {
-    return Field::kBitSize;
+    return Field::BIT_SIZE;
   };
 
   /**
    * @brief A short string representation of this field.
    */
   constexpr static const char* Name() {
-    return Field::kName;
+    return Field::NAME;
   };
 
   /**
@@ -66,7 +66,7 @@ class FF final : Ring<FF<Field>> {
    */
   static FF Read(const unsigned char* src) {
     FF e;
-    FieldFromBytes<Field>(e.mValue, src);
+    FieldFromBytes<Field>(e.m_value, src);
     return e;
   }
 
@@ -89,7 +89,7 @@ class FF final : Ring<FF<Field>> {
    */
   static FF FromString(const std::string& str) {
     FF e;
-    FieldFromString<Field>(e.mValue, str);
+    FieldFromString<Field>(e.m_value, str);
     return e;
   };
 
@@ -115,7 +115,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldConvertIn
    */
   explicit constexpr FF(int value) {
-    FieldConvertIn<Field>(mValue, value);
+    FieldConvertIn<Field>(m_value, value);
   };
 
   /**
@@ -130,7 +130,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldAdd
    */
   FF& operator+=(const FF& other) {
-    FieldAdd<Field>(mValue, other.mValue);
+    FieldAdd<Field>(m_value, other.m_value);
     return *this;
   };
 
@@ -141,7 +141,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldSubtract
    */
   FF& operator-=(const FF& other) {
-    FieldSubtract<Field>(mValue, other.mValue);
+    FieldSubtract<Field>(m_value, other.m_value);
     return *this;
   };
 
@@ -152,7 +152,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldMultiply
    */
   FF& operator*=(const FF& other) {
-    FieldMultiply<Field>(mValue, other.mValue);
+    FieldMultiply<Field>(m_value, other.m_value);
     return *this;
   };
 
@@ -175,7 +175,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldNegate
    */
   FF& Negate() {
-    FieldNegate<Field>(mValue);
+    FieldNegate<Field>(m_value);
     return *this;
   };
 
@@ -185,10 +185,10 @@ class FF final : Ring<FF<Field>> {
    * @see FF::Negate
    */
   FF Negated() const {
-    auto copy = mValue;
+    auto copy = m_value;
     FF r;
     FieldNegate<Field>(copy);
-    r.mValue = copy;
+    r.m_value = copy;
     return r;
   };
 
@@ -198,7 +198,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldInvert
    */
   FF& Invert() {
-    FieldInvert<Field>(mValue);
+    FieldInvert<Field>(m_value);
     return *this;
   };
 
@@ -219,7 +219,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldEqual
    */
   bool Equal(const FF& other) const {
-    return FieldEqual<Field>(mValue, other.mValue);
+    return FieldEqual<Field>(m_value, other.m_value);
   };
 
   /**
@@ -228,7 +228,7 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldToString
    */
   std::string ToString() const {
-    return FieldToString<Field>(mValue);
+    return FieldToString<Field>(m_value);
   };
 
   /**
@@ -237,11 +237,11 @@ class FF final : Ring<FF<Field>> {
    * @see scl::FieldToBytes
    */
   void Write(unsigned char* dest) const {
-    FieldToBytes<Field>(dest, mValue);
+    FieldToBytes<Field>(dest, m_value);
   };
 
  private:
-  typename Field::ValueType mValue;
+  typename Field::ValueType m_value;
 
   template <typename T>
   friend class FFAccess;

include/scl/math/fields/mersenne127.h

@@ -34,17 +34,17 @@ struct Mersenne127 {
   /**
    * @brief The name of this field.
    */
-  constexpr static const char* kName = "Mersenne127";
+  constexpr static const char* NAME = "Mersenne127";
 
   /**
    * @brief The size of field elements of this field in bytes.
    */
-  constexpr static const std::size_t kByteSize = sizeof(ValueType);
+  constexpr static const std::size_t BYTE_SIZE = sizeof(ValueType);
 
   /**
    * @brief The size of field elements of this field in bits.
    */
-  constexpr static const std::size_t kBitSize = 127;
+  constexpr static const std::size_t BIT_SIZE = 127;
 };
 
 }  // namespace scl::math

include/scl/math/fields/mersenne61.h

@@ -35,17 +35,17 @@ struct Mersenne61 {
   /**
    * @brief The name of this field.
    */
-  constexpr static const char* kName = "Mersenne61";
+  constexpr static const char* NAME = "Mersenne61";
 
   /**
    * @brief The size of field elements of this field in bytes.
    */
-  constexpr static const std::size_t kByteSize = sizeof(ValueType);
+  constexpr static const std::size_t BYTE_SIZE = sizeof(ValueType);
 
   /**
    * @brief The size of field elements of this field in bits.
    */
-  constexpr static const std::size_t kBitSize = 61;
+  constexpr static const std::size_t BIT_SIZE = 61;
 };
 
 }  // namespace scl::math