in CMakeLists.txt fetch the util lib using the up to date git tag, improve the readme.md, and add a missing programming by contract macro

Author: hurchalla

README.md

@@ -77,4 +77,4 @@ If you prefer not to use the high level interface of MontgomeryForm, and instead
 
 ## Performance Notes
 
-If you're interested in experimenting, predefining certain macros when compiling might improve performance - see [macros_for_performance.md](macros_for_performance.md).
+If you're interested in experimenting, defining certain macros when compiling might improve performance - see [macros_for_performance.md](macros_for_performance.md).

build_tests.sh

@@ -568,6 +568,7 @@ elif [ "${mode,,}" = "debug" ]; then
             -DCMAKE_BUILD_TYPE=Debug \
             -DCMAKE_EXE_LINKER_FLAGS="$clang_ubsan_link_flags" \
             -DCMAKE_CXX_FLAGS="-DHURCHALLA_CLOCKWORK_ENABLE_ASSERTS=1 \
+            -DHURCHALLA_UTIL_CHECK_API_PRECONDITIONS=1 \
             $cpp_standard  $cpp_stdlib \
             $clang_ubsan  $gcc_ubsan  \
             $test_avoid_cselect  $test_heavyweight \

macros_for_performance.md

@@ -1,10 +1,10 @@
 
-Optional macros to predefine to tune performance
-------------------------------------------------
-There are a number of macros you can optionally predefine to tune the
+Optional macros you can define to tune performance
+--------------------------------------------------
+There are a number of macros you can optionally define when you compile, to tune the
 performance on your system for the modular arithmetic functions.  It is
 generally recommended not to do so, but in some cases you may find it useful.
-You would predefine one or more of these macros when compiling *your* sources,
+You would define one or more of these macros when compiling *your* sources,
 given that Clockwork is a header-only library.
 
 For example, if you are compiling using clang or gcc from the command line, you would
@@ -15,17 +15,17 @@ to your CMakeLists.txt, similarly to the following:
 target_compile_definitions(<your_target_name>  PRIVATE  HURCHALLA_ALLOW_INLINE_ASM_ALL) 
 \
 \
-HURCHALLA_TARGET_ISA_HAS_NO_DIVIDE - predefine this macro if your target system's
+HURCHALLA_TARGET_ISA_HAS_NO_DIVIDE - define this macro if your target system's
 instruction set does not include division.  Although it is unusual, some
-microcontrollers do not have division, and predefining this macro might improve
+microcontrollers do not have division, and defining this macro might improve
 performance in such a case.
 
-HURCHALLA_AVOID_CSELECT - you may wish to predefine this macro if your target
+HURCHALLA_AVOID_CSELECT - you may wish to define this macro if your target
 system's instruction set does not include conditional move or conditional
 select.  It may improve performance in such a case.  This macro is normally
-already predefined for RISC-V.
+already defined for RISC-V.
 
-HURCHALLA_ALLOW_INLINE_ASM_ALL - predefining this macro will enable all
+HURCHALLA_ALLOW_INLINE_ASM_ALL - defining this macro will enable all
 available inline asm functions.  Although this is the easiest macro to use, you
 can more selectively enable inline asm for particular functions, using macros
 listed below.  In some cases HURCHALLA_ALLOW_INLINE_ASM_ALL may improve

modular_arithmetic/CMakeLists.txt

@@ -75,7 +75,7 @@ include(FetchContent)
 FetchContent_Declare(
     hurchalla_util
     GIT_REPOSITORY https://github.com/hurchalla/util.git
-    GIT_TAG        9163344ee69f21a21cb8928dd30fc2ff15e94f0c
+    GIT_TAG        0e5a34dbd1d7b364f54934f8245214386673c509
 )
 FetchContent_MakeAvailable(hurchalla_util)
 

modular_arithmetic/include/hurchalla/modular_arithmetic/detail/clockwork_programming_by_contract.h

@@ -176,6 +176,7 @@
 
 #else
 
+#  define HPBC_CLOCKWORK_CONSTEXPR_ASSERT(...) HPBC_CLOCKWORK_DO_NOTHING(__VA_ARGS__)
 #  define HPBC_CLOCKWORK_CONSTEXPR_PRECONDITION(...) HPBC_CLOCKWORK_DO_NOTHING(__VA_ARGS__)
 #  define HPBC_CLOCKWORK_CONSTEXPR_POSTCONDITION(...) HPBC_CLOCKWORK_DO_NOTHING(__VA_ARGS__)
 #  define HPBC_CLOCKWORK_CONSTEXPR_INVARIANT(...) HPBC_CLOCKWORK_DO_NOTHING(__VA_ARGS__)

montgomery_arithmetic/CMakeLists.txt

@@ -78,7 +78,7 @@ include(FetchContent)
 FetchContent_Declare(
     hurchalla_util
     GIT_REPOSITORY https://github.com/hurchalla/util.git
-    GIT_TAG        9163344ee69f21a21cb8928dd30fc2ff15e94f0c
+    GIT_TAG        0e5a34dbd1d7b364f54934f8245214386673c509
 )
 FetchContent_MakeAvailable(hurchalla_util)