update CMakeLists cmake_minimum_required to allow a policy up to 4.03 (the most recent CMake version I've verified works), and remove the CMakeLists.txt option to build/run dependencies' tests

Author: Jeffrey Hurchalla

CMakeLists.txt

@@ -7,7 +7,8 @@ if(TARGET hurchalla_factoring)
     return()
 endif()
 
-cmake_minimum_required(VERSION 3.14)
+# later versions are probably fine, but are untested
+cmake_minimum_required(VERSION 3.14...4.03)
 
 project(hurchalla_factoring VERSION 1.0.0 LANGUAGES CXX)
 
@@ -19,29 +20,17 @@ endif()
 
 
 # TODO: this section seems slightly messy for detecting/setting up testing
-# --------------------
-option(TEST_HURCHALLA_LIBS
-       "Build the tests for all Hurchalla library projects."
-       OFF)
-
+#
 # if this is the top level CMakeLists.txt, add testing options, and enable
 # testing when testing options have been set to ON.
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
     option(TEST_HURCHALLA_FACTORING
         "Build the tests for the Hurchalla modular arithmetic library project."
         ON)
-    if(TEST_HURCHALLA_FACTORING OR TEST_HURCHALLA_LIBS)
+    if(TEST_HURCHALLA_FACTORING)
         enable_testing()
         # include(CTest)
     endif()
-elseif(TEST_HURCHALLA_LIBS)
-    # If TEST_HURCHALLA_LIBS is set to ON, enable_testing() should have been
-    # called either directly or indirectly by the top level project. (Note that
-    # if a project calls include(CTest), the included CTest.cmake defines a
-    # BUILT_TESTING option and calls enable_testing if BUILD_TESTING is ON.)
-    if (NOT CMAKE_TESTING_ENABLED)
-        message(FATAL_ERROR "Fatal error: TEST_HURCHALLA_LIBS was set, but enable_testing() was never called")
-    endif()
 endif()
 
 
@@ -170,11 +159,9 @@ target_link_libraries(hurchalla_factoring
 
 # if this is the top level CMakeLists.txt
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-    if(TEST_HURCHALLA_FACTORING OR TEST_HURCHALLA_LIBS)
+    if(TEST_HURCHALLA_FACTORING)
         add_subdirectory(test)
     endif()
-elseif(TEST_HURCHALLA_LIBS)
-    add_subdirectory(test)
 endif()
 
 

README.md

@@ -2,7 +2,7 @@
 
 ![Alt text](images/epr.jpg?raw=true "Elliptic curve, and rho cycle")
 
-EPR is a high performance, easy to use factoring and primality checking C++ library (header-only) for any integer up to 128 bits in size.  At the time of this writing, EPR provides the fastest factoring functions known for 64 bit integers (i.e. types int64_t and uint64_t).  Note that for good performance you *must* ensure that the standard macro NDEBUG is defined when compiling - see [How to use the library](#how-to-use-the-library).
+EPR is a high performance, easy to use factoring and primality checking C++ library (header-only, written in C++17) for any integer up to 128 bits in size.  At the time of this writing, EPR provides the fastest factoring functions known for 64 bit integers (i.e. types int64_t and uint64_t).  Note that for good performance you *must* ensure that the standard macro NDEBUG is defined when compiling - see [How to use the library](#how-to-use-the-library).
 
 The name EPR is an abbreviation of Ecm and Pollard-Rho, since those are the two main algorithms this library uses for factoring.  It's also a play on [Einstein-Podolsky-Rosen](https://en.wikipedia.org/wiki/EPR_paradox) for fun ([for now](https://en.wikipedia.org/wiki/Shor%27s_algorithm)).
 
@@ -14,9 +14,11 @@ The goal for EPR was to create a correct and easy to use library with extremely
 
 ## Requirements
 
-The EPR library requires compiler support for C++17 (if you are not using CMake, you may need to specify the option *-std="c++17"* when compiling).  Compilers that are confirmed to build the library without warnings or errors on x86 include clang6, clang10, clang18, gcc7, gcc10, gcc13, intel compiler 19, and Microsoft Visual C++ 2017, 2019, 2022.  The library is intended for use on all architectures (e.g. x86/64, ARM, RISC-V, Power), but has been tested only on x86/x64.  
+The EPR library requires compiler support for C++17.  If you are not using CMake, you may need to specify the option *-std="c++17"* when compiling.  Any C++ version higher than C++17 is also fine.  
 
-For good performance you absolutely *must* ensure that the standard macro NDEBUG (see <cassert>) is defined when compiling.
+For good performance you absolutely *must* ensure that the standard macro NDEBUG (see <cassert>) is defined when compiling.  
+
+Compilers that are confirmed to build this library without warnings or errors on Ubuntu linux (x64) include clang6, clang10, clang18, gcc7, gcc10, gcc13, and intel compiler 19.  On Windows, Microsoft Visual C++ 2017, 2019, 2022 are all confirmed to build it without warnings or errors.  On MacOS, clang16 and gcc14 are confirmed to build it without warnings or errors.  The library is intended for use on all architectures (e.g. x86/64, ARM, RISC-V), but has so far been tested only with x86, x64 (Windows and Ubuntu), and ARM64 (MacOS).
 
 ## Status
 

benchmark/CMakeLists.txt

@@ -8,7 +8,8 @@ if(TARGET bench_hurchalla_factoring)
     return()
 endif()
 
-cmake_minimum_required(VERSION 3.14)
+# later versions are probably fine, but are untested
+cmake_minimum_required(VERSION 3.14...4.03)
 
 
 #set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/tests)

build_tests.sh

@@ -12,7 +12,7 @@
 # This is a working convenience script for invoking the testing builds and then
 # running the tests.
 # The syntax is
-# ./build_tests [-c<compiler_name>] [-j<num_jobs>] [-r] [-a] [-u] [-t] [-m<Release|Debug|Profile>] [-l<standard_library_name>]
+# ./build_tests [-c<compiler_name>] [-j<num_jobs>] [-r] [-a] [-u] [-m<Release|Debug|Profile>] [-l<standard_library_name>]
 #
 # -c allows you to select the compiler, rather than using the default.
 # -j specifies the number of jobs (typically threads) that you want the compiler
@@ -26,8 +26,6 @@
 # -u specifies that you want to compile the code using all available inline asm
 #    routines, so that the tests will cover all of them (this is not expected to
 #    result in the fastest binaries).
-# -t specifies to compile tests for all Hurchalla libraries, as well as for this
-#    repository.  Without -t, only tests for this repository will be compiled.
 # -m allows you to choose between Release, Debug, and Profile(Release with
 #    debug symbols) build configurations, rather than using the default.
 # -l allows you to choose between either libstdc++ or libc++ when using clang.
@@ -177,12 +175,12 @@ if [ "${BASH_VERSINFO:-0}" -lt 4 ]; then
    exit 1
 fi
 
-while getopts ":m:l:c:j:h-:raut" opt; do
+while getopts ":m:l:c:j:h-:rau" opt; do
   case $opt in
     h)
       ;&
     -)
-      echo "Usage: build_tests [-c<compiler_name>] [-j<num_jobs>] [-r] [-a] [-u] [-t] [-m<Release|Debug|Profile>] [-l<standard_library_name>]" >&2
+      echo "Usage: build_tests [-c<compiler_name>] [-j<num_jobs>] [-r] [-a] [-u] [-m<Release|Debug|Profile>] [-l<standard_library_name>]" >&2
       exit 1
       ;;
     c)
@@ -206,10 +204,6 @@ while getopts ":m:l:c:j:h-:raut" opt; do
     u)
       use_all_inline_asm="-DHURCHALLA_ALLOW_INLINE_ASM_ALL=1"
       ;;
-    t)
-      test_all_hurchalla_libs="-DTEST_HURCHALLA_LIBS=ON"
-      run_all_hurchalla_tests=true
-      ;;
     \?)
       echo "Invalid option: -$OPTARG" >&2
       exit 1
@@ -533,7 +527,6 @@ if [ "${mode,,}" = "release" ]; then
     mkdir -p $build_dir
     cmake -S. -B./$build_dir -DTEST_HURCHALLA_FACTORING=ON \
             -DBENCH_HURCHALLA_FACTORING=ON \
-            $test_all_hurchalla_libs \
             -DCMAKE_BUILD_TYPE=Release \
             -DCMAKE_CXX_FLAGS="$cpp_standard  $cpp_stdlib \
             $use_inline_asm  $use_all_inline_asm \
@@ -548,7 +541,6 @@ elif [ "${mode,,}" = "debug" ]; then
     build_dir=build/debug_$compiler_name$compiler_version
     mkdir -p $build_dir
     cmake -S. -B./$build_dir -DTEST_HURCHALLA_FACTORING=ON \
-            $test_all_hurchalla_libs \
             -DCMAKE_BUILD_TYPE=Debug \
             -DCMAKE_EXE_LINKER_FLAGS="$clang_ubsan_link_flags" \
             -DCMAKE_CXX_FLAGS="$cpp_standard  $cpp_stdlib \
@@ -565,7 +557,6 @@ elif [ "${mode,,}" = "profile" ]; then
     build_dir=build/profile_$compiler_name$compiler_version
     mkdir -p $build_dir
     cmake -S. -B./$build_dir -DTEST_HURCHALLA_FACTORING=ON \
-            $test_all_hurchalla_libs \
             -DCMAKE_BUILD_TYPE=RelWithDebInfo \
             -DCMAKE_EXE_LINKER_FLAGS="-ldl" \
             -DCMAKE_CXX_FLAGS="$cpp_standard  $cpp_stdlib \
@@ -582,21 +573,11 @@ fi
 
 
 # -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON
-# cmake  -S.  -B./build_tmp  -DCMAKE_CXX_FLAGS="-std=c++17"  -DTEST_HURCHALLA_LIBS=ON  -DCMAKE_BUILD_TYPE=Debug  -DCMAKE_CXX_COMPILER=icpc  -DCMAKE_C_COMPILER=icc
+# cmake  -S.  -B./build_tmp  -DCMAKE_CXX_FLAGS="-std=c++17"  -DCMAKE_BUILD_TYPE=Debug  -DCMAKE_CXX_COMPILER=icpc  -DCMAKE_C_COMPILER=icc
 # cmake --build ./build_tmp --config Debug
 
 
 if [ "$run_tests" = true ]; then
-  if [ "$run_all_hurchalla_tests" = true ]; then
-    ./$build_dir/test_ndebug_programming_by_contract --gtest_break_on_failure
-    exit_on_failure
-    ./$build_dir/test_programming_by_contract --gtest_break_on_failure
-    exit_on_failure
-    ./$build_dir/test_hurchalla_util --gtest_break_on_failure
-    exit_on_failure
-    ./$build_dir/test_hurchalla_modular_arithmetic --gtest_break_on_failure
-    exit_on_failure
-  fi
   ./$build_dir/test_hurchalla_factoring --gtest_break_on_failure
   exit_on_failure
 fi

test/CMakeLists.txt

@@ -8,7 +8,8 @@ if(TARGET test_hurchalla_factoring)
     return()
 endif()
 
-cmake_minimum_required(VERSION 3.14)
+# later versions are probably fine, but are untested
+cmake_minimum_required(VERSION 3.14...4.03)
 
 
 include(FetchGoogleTest.cmake)