Skip to content

Commit 1778a7a

Browse files
committed
Documentation tweaks.
1 parent c00b325 commit 1778a7a

File tree

5 files changed

+12
-1
lines changed

5 files changed

+12
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ SHELL = /bin/sh
88
libname = foxutils
99
dlibnamev0 = lib$(libname).so
1010
dlibnamev1 = $(dlibnamev0).1
11-
dlibnamev3 = $(dlibnamev1).0.0dev
11+
dlibnamev3 = $(dlibnamev1).0.0
1212
slibname = lib$(libname).a
1313
pubincname = foxutils
1414

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@
77
- Dynamic array (FoxArray).
88
- Open hash table (FoxMap).
99
- **Non**-cryptographic hashing functions.
10+
- **Non**-cryptographic pseudo-random number generators and utilities.
1011
- Both static and dynamic versions of library.
1112

13+
## Limitations
14+
15+
- Requires support for [Statement Expressions](https://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html).
16+
1217
## Build + Installation
1318

1419
### Standard (Library + Headers)

include/foxutils/splitmix64.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
*
99
* @brief SplitMix64 pseudo-random number generator.
1010
*
11+
* @warning This generator is NOT suitable for cryptographic use.
12+
*
1113
* This generator was designed by Sebastiano Vigna. See
1214
* http://prng.di.unimi.it/ for details.
1315
*/

include/foxutils/xorshift64.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
*
99
* @brief Xorshift64 pseudo-random number generator.
1010
*
11+
* @warning This generator is NOT suitable for cryptographic use.
12+
*
1113
* This generator was designed by George Marsaglia with parameters recommended
1214
* by Sebastiano Vigna. See http://vigna.di.unimi.it/ftp/papers/xorshift.pdf
1315
* for details.

include/foxutils/xoshiro256ss.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
*
99
* @brief Xoshiro256** pseudo-random number generator.
1010
*
11+
* @warning This generator is NOT suitable for cryptographic use.
12+
*
1113
* This generator was designed by David Blackman and Sebastiano Vigna. See
1214
* http://prng.di.unimi.it/ for details.
1315
*/

0 commit comments

Comments
 (0)