stdlib_hash_64bit

Author: jvdp1

src/stdlib_hash_64bit.fypp

@@ -208,7 +208,7 @@ interface
         module subroutine new_spooky_hash_seed( seed )
 !! Version: experimental
 !!
-!! Random SEED generator for
+!! Random seed generator for SPOOKY_HASH
             integer(int64), intent(inout) :: seed(2)
         end subroutine new_spooky_hash_seed
 
@@ -243,7 +243,7 @@ interface
         module subroutine new_pengy_hash_seed( seed )
 !! Version: experimental
 !!
-!! Random SEED generator for MIR_HASH_STRICT
+!! Random seed generator for MIR_HASH_STRICT
             integer(int32), intent(inout) :: seed
         end subroutine new_pengy_hash_seed
 
@@ -254,8 +254,8 @@ contains
     elemental function fibonacci_hash( key, nbits ) result( sample )
 !! Version: experimental
 !!
-!! Maps the 64 bit integer KEY to an unsigned integer value with only NBITS
-!! bits where NBITS is less than 64
+!! Maps the 64 bit integer `key` to an unsigned integer value with only `nbits`
+!! bits where `nbits` is less than 64
 !! ([Specification](../page/specs/stdlib_hash_procedures.html#fibonacci_hash-maps-an-integer-to-a-smaller-number-of-bits_1))
 
         integer(int64), intent(in) :: key
@@ -269,8 +269,8 @@ contains
     elemental function universal_mult_hash( key, seed, nbits ) result( sample )
 !! Version: experimental
 !!
-!! Uses the "random" odd 64 bit integer SEED to map the 64 bit integer KEY to
-!! an unsigned integer value with only NBITS bits where NBITS is less than 64.
+!! Uses the "random" odd 64 bit integer `seed` to map the 64 bit integer `key` to
+!! an unsigned integer value with only `nbits` bits where `nbits` is less than 64.
 !! ([Specification](../page/specs/stdlib_hash_procedures.html#universal_mult_hash-maps-an-integer-to-a-smaller-number-of-bits_1))
 
         integer(int64), intent(in) :: key
@@ -285,7 +285,7 @@ contains
     subroutine odd_random_integer( harvest )
 !! Version: experimental
 !!
-!! Returns a 64 bit pseudo random integer, HARVEST, distributed uniformly over
+!! Returns a 64 bit pseudo random integer, `harvest`, distributed uniformly over
 !! the odd integers of the 64 bit kind.
 !! ([Specification](../page/specs/stdlib_hash_procedures.html#odd_random_integer-returns-odd-integer))
 
@@ -303,7 +303,7 @@ contains
     subroutine random_integer( harvest )
 !! Version: experimental
 !!
-!! Returns a 64 bit pseudo random integer, HARVEST, distributed uniformly over
+!! Returns a 64 bit pseudo random integer, `harvest`, distributed uniformly over
 !! the values of the 64 bit kind.
         integer(int64), intent(out) :: harvest
         real(dp) :: sample(2)