Skip to content

Commit 8bb43ba

Browse files
committed
update the description of testing
1 parent f15d42d commit 8bb43ba

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

doc/specs/stdlib_hash_procedures.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1624,7 +1624,7 @@ various hash functions. The other is a comparison of the outputs of
16241624
the Fortran hash functions, with the outputs of the C and C++ hash
16251625
procedures that are the inspiration for the Fortran hash functions.
16261626

1627-
In the `src/test/hash_functions` subdirectory, the Fortran Standard
1627+
In the `src/test/hash_functions_perf` subdirectory, the Fortran Standard
16281628
Library provides two performance test codes for
16291629
the hash functions of `stdlib_hash_32bit` and
16301630
`stdlib_hash_64bit`, `test_32_bit_hash_performance` and
@@ -1729,20 +1729,16 @@ severely impact the performance of `nmhash32`, `nmhash32x`,
17291729
`water_hash`, `pengy_hash`, and `spooky_hash` relative to
17301730
`fnv_1_hash` and `fnv_1a_hash`.
17311731

1732-
In the `src/test/hash_functions/validation` subdirectory, the Fortran
1733-
Standard Library implements three executables to test the validity of
1734-
the Fortran codes against the original C and C++ codes. The three
1735-
executables must be compiled manually using the makefile
1736-
`Makefile.validation`, and the compiler suite used must be
1737-
GCC's. The first executable, `generate_key_array` is
1738-
based on Fortran code, and generates a random sequence of 2048
1739-
integers of kind `INT8`, and stores that sequence in the binary file
1740-
`key_array.bin`. The second executable, `generate_hash_arrays`, reads
1741-
the values in `key_array.bin`, and, for each complicated hash
1742-
procedure generates a corresponding binary file containing 2049 hash
1743-
values generated from the values in `key_array.bin`. The third
1744-
executable, `hash_validity_test`, reads the binary files and for each
1745-
complicated hash procedure compares the contents of the binary file
1732+
In the `src/test/hash_functions` subdirectory, the Fortran
1733+
Standard Library contains codes to test the validity of
1734+
the Fortran codes against the original C and C++ codes. It consists of one
1735+
executable `test_hash_functions` that
1736+
1) generates a random sequence of 2048
1737+
integers of kind `int8`, and stores that sequence in the binary file
1738+
`key_array.bin`;
1739+
2) reads the values in `key_array.bin`, and, for each complicated C/C++-coded
1740+
hash procedure, generates a corresponding binary file containing 2049 hash
1741+
values generated from the values in `key_array.bin`., and
1742+
3) reads the binary files, and, for each complicated C/C++-coded hash procedure, compares the contents of the binary file
17461743
with the results of calculating hash values using the corresponding
1747-
Fortran hash procedure on the same keys. These executables must be run
1748-
manually in the same order.
1744+
Fortran hash procedure on the same keys.

src/tests/hash_functions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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:
1+
The hash_functions directory contains code to validate the Fortran hash functions against the original C/C++ codes. It consists of one executable `test_hash_functions` that:
22

33
* creates a file containing 2048 random 8 bit integers using the subroutine
44
`generate_key_array`.

0 commit comments

Comments
 (0)