Merge in binary fields from libiop, make API consistent between fields, add tests, etc

.gitignore

@@ -1,2 +1,4 @@
 /build/
-/.idea/
+/.idea/
+.DS_Store
+.vscode

.gitmodules

@@ -1,3 +1,6 @@
+[submodule "depends/gtest"]
+	path = depends/gtest
+	url = https://github.com/google/googletest.git
 [submodule "depends/ate-pairing"]
 	path = depends/ate-pairing
 	url = https://github.com/herumi/ate-pairing.git

CMakeLists.txt

@@ -191,6 +191,7 @@ endif()
 
 if("${USE_ASM}")
   add_definitions(-DUSE_ASM)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mpclmul -msse4.1") # used for binary fields
 endif()
 
 # Configure CCache if available

README.md

@@ -54,6 +54,7 @@ The library has the following dependencies:
 * [CMake](http://cmake.org/)
 * [GMP](http://gmplib.org/)
 * [libprocps](http://packages.ubuntu.com/trusty/libprocps-dev)
+* [libsodium](https://libsodium.gitbook.io/doc/)
 
 The library has been tested on Linux, but it is compatible with Windows and Mac OS X.
 
@@ -65,6 +66,9 @@ On Ubuntu 14.04 LTS:
 sudo apt-get install build-essential git libboost-all-dev cmake libgmp3-dev libssl-dev libprocps3-dev pkg-config
 ```
 
+
+On Mac OS X, all of the libraries from the previous section can be installed with brew, except for `libprocps`. You will need to turn that off for Mac OS X.
+
 Fetch dependencies from their GitHub repos:
 
 ```
@@ -82,6 +86,11 @@ Optionally, you can specify the install location by providing the desired instal
 ```
 cmake .. -DCMAKE_INSTALL_PREFIX=/install/path
 ```
+On Mac OS X, you may also need to turn off `libprocps` and/or provide the path to openssl (your exact path may vary):
+```
+cmake -DWITH_PROCPS=OFF -DOPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2s -DOPENSSL_LIBRARIES=/usr/local/Cellar/openssl/1.0.2s/lib ..
+```
+To enable asserts, use the `-DCMAKE_BUILD_TYPE=Debug` flag.
 
 Then, to compile and install the library, run this within the build directory:
 ```
@@ -93,7 +102,7 @@ This will install `libff.a` into `/install/path/lib`; so your application should
 
 ## Testing
 
-To execute the tests for this library, run:
+To build and execute the tests for this library, run:
 ```
 make check
 ```

depends/CMakeLists.txt

@@ -1,3 +1,7 @@
+# gtest for binary fields
+add_subdirectory(gtest EXCLUDE_FROM_ALL)
+
+
 if(${CURVE} STREQUAL "BN128")
   include_directories(ate-pairing/include)
   include_directories(xbyak)

libff/CMakeLists.txt

@@ -5,6 +5,7 @@ if(${CURVE} STREQUAL "BN128")
     FF_EXTRASRCS
 
     ${FF_EXTRASRCS}
+    algebra/curves/bn128/bn128_fields.cpp
     algebra/curves/bn128/bn128_g1.cpp
     algebra/curves/bn128/bn128_g2.cpp
     algebra/curves/bn128/bn128_gt.cpp
@@ -24,27 +25,32 @@ add_library(
   ff
   STATIC
 
+  algebra/curves/alt_bn128/alt_bn128_fields.cpp
   algebra/curves/alt_bn128/alt_bn128_g1.cpp
   algebra/curves/alt_bn128/alt_bn128_g2.cpp
   algebra/curves/alt_bn128/alt_bn128_init.cpp
   algebra/curves/alt_bn128/alt_bn128_pairing.cpp
   algebra/curves/alt_bn128/alt_bn128_pp.cpp
+  algebra/curves/edwards/edwards_fields.cpp
   algebra/curves/edwards/edwards_g1.cpp
   algebra/curves/edwards/edwards_g2.cpp
   algebra/curves/edwards/edwards_init.cpp
   algebra/curves/edwards/edwards_pairing.cpp
   algebra/curves/edwards/edwards_pp.cpp
+  algebra/curves/mnt/mnt4/mnt4_fields.cpp
   algebra/curves/mnt/mnt4/mnt4_g1.cpp
   algebra/curves/mnt/mnt4/mnt4_g2.cpp
   algebra/curves/mnt/mnt4/mnt4_init.cpp
   algebra/curves/mnt/mnt4/mnt4_pairing.cpp
   algebra/curves/mnt/mnt4/mnt4_pp.cpp
   algebra/curves/mnt/mnt46_common.cpp
+  algebra/curves/mnt/mnt6/mnt6_fields.cpp
   algebra/curves/mnt/mnt6/mnt6_g1.cpp
   algebra/curves/mnt/mnt6/mnt6_g2.cpp
   algebra/curves/mnt/mnt6/mnt6_init.cpp
   algebra/curves/mnt/mnt6/mnt6_pairing.cpp
   algebra/curves/mnt/mnt6/mnt6_pp.cpp
+
   common/double.cpp
   common/profiling.cpp
   common/utils.cpp
@@ -63,6 +69,35 @@ target_include_directories(
   PUBLIC ..
 )
 
+# sodium for binary fields
+find_path(
+  SODIUM_INCLUDE_DIR
+  sodium.h
+  HINTS ${LIBSODIUM_INCLUDE_DIRS}
+  /usr/local/include /opt/local/include /opt/include
+)
+find_library(
+  SODIUM_LIBRARY
+  NAMES sodium
+  HINTS ${LIBSODIUM_LIBRARY_DIRS}
+  /usr/local/lib /opt/local/lib /opt/lib
+)
+
+target_include_directories(
+  ff
+  PUBLIC
+  ${SODIUM_INCLUDE_DIR}
+)
+target_compile_options(
+  ff
+  PUBLIC
+  ${LIBSODIUM_CFLAGS} ${LIBSODIUM_CFLAGS_OTHER}
+)
+target_link_libraries(
+  ff
+  ${SODIUM_LIBRARY} ${LIBSODIUM_LDFLAGS_OTHER}
+)
+
 install(
   DIRECTORY "" DESTINATION "include/libff"
   FILES_MATCHING
@@ -78,6 +113,7 @@ install(
 
 # Tests
 if ("${IS_LIBFF_PARENT}")
+  # Tests for prime fields
   add_executable(
     algebra_bilinearity_test
     EXCLUDE_FROM_ALL
@@ -88,6 +124,7 @@ if ("${IS_LIBFF_PARENT}")
     algebra_bilinearity_test
 
     ff
+    gtest_main
   )
 
   add_executable(
@@ -100,18 +137,46 @@ if ("${IS_LIBFF_PARENT}")
     algebra_groups_test
 
     ff
+    gtest_main
+  )
+
+  add_executable(
+    algebra_prime_fields_test
+    EXCLUDE_FROM_ALL
+
+    algebra/fields/tests/test_prime_fields.cpp
+  )
+  target_link_libraries(
+    algebra_prime_fields_test
+
+    ff
+    gtest_main
+  )
+
+  add_executable(
+    algebra_all_fields_test
+    EXCLUDE_FROM_ALL
+
+    algebra/fields/tests/test_all_fields.cpp
+  )
+  target_link_libraries(
+    algebra_all_fields_test
+
+    ff
+    gtest_main
   )
 
   add_executable(
-    algebra_fields_test
+    algebra_field_utils_test
     EXCLUDE_FROM_ALL
 
-    algebra/fields/tests/test_fields.cpp
+    algebra/field_utils/tests/test_field_utils.cpp
   )
   target_link_libraries(
-    algebra_fields_test
+    algebra_field_utils_test
 
     ff
+    gtest_main
   )
 
   include(CTest)
@@ -124,14 +189,46 @@ if ("${IS_LIBFF_PARENT}")
     COMMAND algebra_groups_test
   )
   add_test(
-    NAME algebra_fields_test
-    COMMAND algebra_fields_test
+    NAME algebra_prime_fields_test
+    COMMAND algebra_prime_fields_test
+  )
+  add_test(
+    NAME algebra_all_fields_test
+    COMMAND algebra_all_fields_test
+  )
+  add_test(
+    NAME algebra_field_utils_test
+    COMMAND algebra_field_utils_test
   )
 
   add_dependencies(check algebra_bilinearity_test)
   add_dependencies(check algebra_groups_test)
-  add_dependencies(check algebra_fields_test)
+  add_dependencies(check algebra_prime_fields_test)
+  add_dependencies(check algebra_all_fields_test)
+  add_dependencies(check algebra_field_utils_test)
+
+  # Tests for binary fields
+  add_executable(
+    algebra_binary_fields_test
+    EXCLUDE_FROM_ALL
+
+    algebra/fields/tests/test_binary_fields.cpp
+  )
+  target_link_libraries(
+    algebra_binary_fields_test
+
+    ff
+    gtest_main
+  )
+
+  add_test(
+    NAME algebra_binary_fields_test
+    COMMAND algebra_binary_fields_test
+  )
+
+  add_dependencies(check algebra_binary_fields_test)
 
+  # Profiling for prime fields
   add_executable(
     multiexp_profile
     EXCLUDE_FROM_ALL