rex/librng
1
0
Fork 0
mirror of https://github.com/xTrayambak/librng synced 2026-01-14 13:21:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
40 commits 1 branch 1 tag 304 KiB
Find a file
Exact
xTrayambak 69638caddf (bump) bump version to 0.1.3
2024-03-11 12:32:33 +05:30
.github/workflows (add) add github workflow CI 2024-03-06 12:17:29 +05:30
examples (add) add PCG algorithm 2024-03-11 12:29:21 +05:30
src (add) add interface for PCG 2024-03-11 12:29:58 +05:30
tests (fix) rename tests to suites wherever appropriate 2024-03-11 12:31:20 +05:30
librng.nimble (bump) bump version to 0.1.3 2024-03-11 12:32:33 +05:30
README.md (add) add PCG algorithm 2024-03-11 12:29:21 +05:30

README.md

librng -- RNG for dummies in Nim

librng is a 100% native Nim pseudo-random-number-generation library, supporting multiple algorithms.
It has no dependencies other than the Nim standard library (granted, you don't count nph as a code formatter)
You can either individually import an algorithm from the librng/algorithms subdirectory, or you can simply import librng and use the RNG helper.
librng supports the C, C++, JS and NimScript* backends.

RNG Algorithms supported

Algorithm Status
Xoroshiro128 Yes
LCG Yes
Splitmix64 Yes
Mersenne Twister Yes
Marsaglia 69069 Yes
Lehmer64 Yes
Xoroshiro128** Yes
Xoroshiro128++ Yes
PCG Yes
ChaCha20 No

Installation

You can install librng straight from Nimble.

$ nimble install librng

Examples

All examples are in examples/. They should give you an idea of how to use the library.

Contributing

Make sure to write unit tests if you're adding a new algorithm. This allows us to integrate it easily into the GitHub Actions tests. Please run the nimble format task to run nph before submitting your contributions. Thanks :)