Merge pull request #6 from jvdp1/myhash2

Proposition: changes to hash function tests

Author: wclodius2

.github/workflows/CI.yml

@@ -31,6 +31,8 @@ jobs:
             build: make
     env:
       FC: gfortran-${{ matrix.gcc_v }}
+      CC: gcc-${{ matrix.gcc_v }}
+      CXX: g++-${{ matrix.gcc_v }}
       GCC_V: ${{ matrix.gcc_v }}
       BUILD_DIR: ${{ matrix.build == 'cmake' && 'build' || '.' }}
 
@@ -50,17 +52,18 @@ jobs:
     - name: Install fypp
       run: pip install --upgrade fypp
 
-    - name: Install GFortran Linux
+    - name: Install GCC compilers Linux
       if: contains( matrix.os, 'ubuntu')
       run: |
         sudo add-apt-repository ppa:ubuntu-toolchain-r/test
         sudo apt-get update
-        sudo apt-get install -y gcc-${GCC_V} gfortran-${GCC_V}
+        sudo apt-get install -y gcc-${GCC_V} g++-${GCC_V} gfortran-${GCC_V}
         sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_V} 100 \
         --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${GCC_V} \
+        --slave /usr/bin/g++ g++ /usr/bin/g++-${GCC_V} \
         --slave /usr/bin/gcov gcov /usr/bin/gcov-${GCC_V}
 
-    - name: Install GFortran macOS
+    - name: Install GCC compilers macOS
       if: contains( matrix.os, 'macos')
       run: |
           brew install gcc@${GCC_V} || brew upgrade gcc@${GCC_V} || true
@@ -107,12 +110,16 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         fc: [ifort]
+        cc: [icc]
+        cxx: [icpc]
     env:
       MACOS_HPCKIT_URL: >-
         https://registrationcenter-download.intel.com/akdlm/irc_nas/17398/m_HPCKit_p_2021.1.0.2681_offline.dmg
       MACOS_FORTRAN_COMPONENTS: >-
         intel.oneapi.mac.ifort-compiler
       FC: ${{ matrix.fc }}
+      CC: ${{ matrix.cc }}
+      CXX: ${{ matrix.cxx }}
 
     steps:
     - name: Checkout code
@@ -154,6 +161,7 @@ jobs:
       if: contains(matrix.os, 'ubuntu')
       run: |
         sudo apt-get install intel-oneapi-compiler-fortran
+        sudo apt-get install intel-oneapi-compiler-dpcpp-cpp-and-cpp-classic
 
     - name: Install Intel oneAPI compiler (OSX)
       if: contains(matrix.os, 'macos') && steps.cache-install.outputs.cache-hit != 'true'

CMakeLists.txt

@@ -42,11 +42,11 @@ if(CMAKE_Fortran_COMPILER_ID STREQUAL GNU)
   add_compile_options(-std=f2018)
 elseif(CMAKE_Fortran_COMPILER_ID MATCHES "^Intel")
   if(WIN32)
-    add_compile_options(/warn:declarations,general,usage,interfaces,unused)
-    add_compile_options(/stand:f18)
+    add_compile_options("$<$<COMPILE_LANGUAGE:Fortran>:/warn:declarations,general,usage,interfaces,unused>")
+    add_compile_options("$<$<COMPILE_LANGUAGE:Fortran>:/stand:f18>")
   else()
-    add_compile_options(-warn declarations,general,usage,interfaces,unused)
-    add_compile_options(-stand f18)
+    add_compile_options("$<$<COMPILE_LANGUAGE:Fortran>:-warn declarations,general,usage,interfaces,unused>")
+    add_compile_options("$<$<COMPILE_LANGUAGE:Fortran>:-stand f18>")
   endif()
 endif()
 

ci/fpm-deployment.sh

@@ -29,6 +29,7 @@ include=(
 prune=(
   "$destdir/test/test_always_fail.f90"
   "$destdir/test/test_always_skip.f90"
+  "$destdir/test/test_hash_functions.f90"
   "$destdir/src/common.f90"
   "$destdir/src/f18estop.f90"
 )

src/stdlib_32_bit_nmhashes.fypp

@@ -62,8 +62,6 @@ submodule(stdlib_32_bit_hash_codes) stdlib_32_bit_nmhashes
     integer(int32), parameter :: nmh_m2_v(0:31) = nmh_m2
     integer(int32), parameter :: nmh_m3_v(0:31) = nmh_m3
 
-    integer(int16), parameter :: nmh_m3_16(2) = transfer( nmh_m3, 0_int16, 2 )
-
     logical, parameter :: nmh_short32_without_seed2=.false.
     logical, parameter :: nmh_short32_with_seed2=.true.
 
@@ -126,24 +124,20 @@ contains
         integer(int32), parameter :: m3 = int(z'E9139917', int32)
 
         integer(int16) :: vx16(2)
-        integer(int16), parameter :: &
-            m116(2) = transfer( m1, 0_int16, 2 ), &
-            m216(2) = transfer( m2, 0_int16, 2 ), &
-            m316(2) = transfer( m3, 0_int16, 2 )
 
         vx32 = x
         vx32 = ieor( vx32, ieor( ishft( vx32, -12 ), ishft( vx32, -6 ) ) )
         vx16 = transfer( vx32, 0_int16, 2 )
-        vx16 = vx16 * m116
+        vx16 = vx16 * transfer( m1, 0_int16, 2 )
         vx32 = transfer( vx16, 0_int32 )
         vx32 = ieor( vx32, ieor( ishft( vx32, 11 ), ishft( vx32, -19 ) ) )
         vx16 = transfer( vx32, 0_int16, 2 )
-        vx16 = vx16 * m216
+        vx16 = vx16 * transfer( m2, 0_int16, 2 )
         vx32 = transfer( vx16, 0_int32 )
         vx32 = ieor( vx32, seed )
         vx32 = ieor( vx32, ieor( ishft( vx32, -15 ), ishft( vx32, -9 ) ) )
         vx16 = transfer( vx32, 0_int16, 2 )
-        vx16 = vx16 * m316
+        vx16 = vx16 * transfer( m3, 0_int16, 2 )
         vx32 = transfer( vx16, 0_int32 )
         vx32 = ieor( vx32, ieor( ishft(vx32, 16), ishft(vx32, -11) ) )
 
@@ -157,15 +151,23 @@ contains
 
         integer(int32) :: xu32(0:3), yu32(0:3)
         integer(int16) :: xu16(0:1)
-        integer(int16), parameter :: &
-            nmh_m1_16(0:1) = transfer( nmh_m1, 0_int16, 2 ),  &
-            nmh_m2_16(0:1) = transfer( nmh_m2, 0_int16, 2 ),  &
-            nmh_m3_16(0:1) = transfer( nmh_m3, 0_int16, 2 )
+!       Due to an issue with Intel OneAPI ifort 2021 (see  
+!       https://community.intel.com/t5/Intel-Fortran-Compiler/Intrinsic-transfer-with-a-provided-size-un-expected-behavior/m-p/1343313#M158733
+!       ), it is not possible to define the following variables as a parameter.
+!        integer(int16), parameter :: &
+!            nmh_m1_16(0:1) = transfer( nmh_m1, 0_int16, 2 ),  &
+!            nmh_m2_16(0:1) = transfer( nmh_m2, 0_int16, 2 ),  &
+!            nmh_m3_16(0:1) = transfer( nmh_m3, 0_int16, 2 )
+        integer(int16) :: nmh_m1_16(0:1), nmh_m2_16(0:1), nmh_m3_16(0:1)
         integer(int32) :: s1
         integer(int64) :: length
         integer(int32) :: length32(0:1)
         integer(int64) :: i, j, r
 
+        nmh_m1_16(0:1) = transfer( nmh_m1, 0_int16, 2 )
+        nmh_m2_16(0:1) = transfer( nmh_m2, 0_int16, 2 )
+        nmh_m3_16(0:1) = transfer( nmh_m3, 0_int16, 2 )
+
         ! base mixer: [f0d9649b  5 -13 29a7935d -9 11 55d35831 -20 -10 ] =
         ! 0.93495901789135362
 
@@ -382,10 +384,17 @@ contains
         integer(int16) :: u16(0:1)
         integer(int32), parameter:: m1 = int(z'CCE5196D', int32)
         integer(int32), parameter:: m2 = int(z'464BE229', int32)
-        integer(int16), parameter:: m1_16(0:1) = transfer(m1, 0_int16, 2)
-        integer(int16), parameter:: m2_16(0:1) = transfer(m2, 0_int16, 2)
+!       Due to an issue with Intel OneAPI ifort 2021 (see  
+!       https://community.intel.com/t5/Intel-Fortran-Compiler/Intrinsic-transfer-with-a-provided-size-un-expected-behavior/m-p/1343313#M158733
+!       ), it is not possible to define the following variables as a parameter.
+        !integer(int16), parameter:: m1_16(0:1) = transfer(m1, 0_int16, 2)
+        !integer(int16), parameter:: m2_16(0:1) = transfer(m2, 0_int16, 2)
+        integer(int16) :: m1_16(0:1), m2_16(0:1)
         ! [-21 -8 cce5196d 12 -7 464be229 -21 -8] = 3.2267098842182733
 
+        m1_16(0:1) = transfer(m1, 0_int16, 2)
+        m2_16(0:1) = transfer(m2, 0_int16, 2)
+
         u32 = x
         u32 = ieor( u32, ieor( ishft( u32, -8 ), ishft( u32, -21 ) ) )
         u16 = transfer( u32, 0_int16, 2 )

src/tests/CMakeLists.txt

@@ -18,6 +18,7 @@ list(
 add_subdirectory(ascii)
 add_subdirectory(bitsets)
 add_subdirectory(hash_functions)
+add_subdirectory(hash_functions_perf)
 add_subdirectory(io)
 add_subdirectory(linalg)
 add_subdirectory(logger)

src/tests/Makefile.manual

@@ -14,6 +14,7 @@ testdrive.F90:
 all test clean::
 	$(MAKE) -f Makefile.manual --directory=ascii $@
 	$(MAKE) -f Makefile.manual --directory=bitsets $@
+	$(MAKE) -f Makefile.manual --directory=hash_functions_perf $@
 	$(MAKE) -f Makefile.manual --directory=hash_functions $@
 	$(MAKE) -f Makefile.manual --directory=io $@
 	$(MAKE) -f Makefile.manual --directory=logger $@

src/tests/hash_functions/CMakeLists.txt

@@ -1,2 +1,25 @@
-ADDTEST(32_bit_hash_performance)
-ADDTEST(64_bit_hash_performance)
+#ADDTEST(hash_functions)
+
+set(SRC
+nmhash_scalar.c
+pengyhash.c
+SpookyV2.cpp
+SpookyV2Test.cpp
+waterhash.c
+generate_hash_arrays.cpp
+)
+
+enable_language(CXX)
+enable_language(C)
+
+add_library(libc_hash ${SRC})
+
+set(CMAKE_FORTRAN_LINK_EXECUTABLE "<CMAKE_Fortran_COMPILER>  <CMAKE_Fortran_LINK_FLAGS> <LINK_FLAGS> <FLAGS> <OBJECTS>  -o <TARGET> <LINK_LIBRARIES>")
+
+add_executable(test_hash_functions test_hash_functions.f90)
+target_link_libraries(test_hash_functions "${PROJECT_NAME}" "test-drive::test-drive" "libc_hash")
+add_test(NAME hash_functions
+             COMMAND $<TARGET_FILE:test_hash_functions> ${CMAKE_CURRENT_BINARY_DIR}
+             WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
+set_target_properties(test_hash_functions PROPERTIES LINKER_LANGUAGE FORTRAN)

src/tests/hash_functions/Makefile.manual

@@ -1,3 +1,47 @@
-PROGS_SRC = test_64_bit_hash_performance.f90 test_32_bit_hash_performance.f90
+CC ?= gcc
+CXX ?= g++
+
+CPPFLAGS += -I. -I../.. -I..
+LDFLAGS += -L../.. -L.. -lstdlib-testing -lstdlib
+
+PROGS =  test_hash_functions
+TESTPROGS = $(PROGS:=TEST)
+
+all: $(PROGS)
+
+test: $(TESTPROGS)
+
+$(TESTPROGS):
+	./$(@:TEST=)
+
+test_hash_functions: test_hash_functions.f90 generate_hash_arrays.o libc_hash.a
+	$(FC) $(FFLAGS) $(CPPFLAGS) -L. -o $@ $^ $(LDFLAGS) -lc_hash -lstdc++
+
+generate_hash_arrays.o: generate_hash_arrays.cpp libc_hash.a
+	$(CXX) $(CXXFLAGS) -c generate_hash_arrays.cpp -o generate_hash_arrays.o
+
+libc_hash.a: SpookyV2.o SpookyV2Test.o pengyhash.o nmhash_scalar.o waterhash.o
+	ar rcs libc_hash.a SpookyV2.o SpookyV2Test.o pengyhash.o \
+               nmhash_scalar.o waterhash.o
+
+pengyhash.o: pengyhash.c pengyhash.h
+	$(CC) $(CFLAGS) $(CPPFLAGS) -c pengyhash.c -o pengyhash.o
+
+waterhash.o: waterhash.c waterhash.h
+	$(CC) $(CFLAGS) $(CPPFLAGS) -c waterhash.c -o waterhash.o
+
+SpookyV2.o: SpookyV2.cpp SpookyV2.h
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c SpookyV2.cpp -o SpookyV2.o
+
+SpookyV2Test.o: SpookyV2Test.cpp SpookyV2.h
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c SpookyV2Test.cpp -o SpookyV2Test.o
+
+nmhash_scalar.o: nmhash_scalar.c nmhash_scalar.h
+	$(CC) $(CFLAGS) $(CPPFLAGS) -c nmhash_scalar.c -o nmhash_scalar.o
+
+clean:
+	rm nmhash_scalar.o SpookyV2Test.o SpookyV2.o waterhash.o pengyhash.o \
+           libc_hash.a generate_hash_arrays.o $(PROGS) *.*mod\
+	   *.bin
+
 
-include ../Makefile.manual.test.mk

src/tests/hash_functions/README.md

@@ -0,0 +1,8 @@
+The validation directory contains code to validate the Fortran hash functions against the original C/C++ codes. It consists of one executable `test_hash_functions` that:
+
+* creates a file containing 2048 random 8 bit integers using the subroutine
+  `generate_key_array`.
+
+* reads the file generated by the subroutine `generate_key_array` and uses its contents to generate 2049 hashes for each C/C++ hash algorithm and outputs files containing the hashes.
+
+* reads the file generated by the subroutine `generate_key_array` and uses its contents to generate 2049 hashes for each Fortran hash algorithm and compares the result with the corresponding outputs of C/C++ hash algorithms.