-
Notifications
You must be signed in to change notification settings - Fork 373
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(examples): Add a useful set of high quality pseudo-random number generators #2868
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2868 +/- ##
==========================================
- Coverage 63.32% 63.30% -0.02%
==========================================
Files 548 548
Lines 78511 78504 -7
==========================================
- Hits 49715 49695 -20
- Misses 25443 25454 +11
- Partials 3353 3355 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
7f3cc3f
to
4510d34
Compare
I ported a number of my pseudo-random number generator implementations from Ruby to Gno, building them be compatible with the standard Rand() implementation, so that any of these can be used as a drop-in replacement for the default PCG algorithm. All of these are faster than PCG, while still having competitive-to-superior statistical properties and predictability resistance. Further, the ISAAC family of generators are cryptographically secure, and when properly seeded, still have no known practical attack vectors.
Hey @wyhaines, can you update the PR branch with the master branch? 🙏 |
Revise all of the output to use ufmt.
Tidy gno.mods; add a Sprintf %f test.
…intf float formats a bit more to be closer to Go's support.
f56bcea
to
0fff418
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of comments. I'm not particularly familiar with the algorithms involved here; I don't have the patience to check these against their source implementations and verify the claims there, so I kind of skimmed through the code without much of a critical eye on it.
I have two notes:
- First, maybe @n2p5 can take a look - this looks like the kind of thing up his sleeve.
- Second, maybe we can put this in a
p/wyhaines
namespace rather than ap/demo/math/rand
namespace. I don't know what we want to do with p/demo long-term (keep it? move a lot of it top/nt
? ...), but for now I still consider it as a "semi-official" space, so I'd prefer your own namespace as a place where to have code that is not vetted by the core team ahead of time.
// prng = isaac.New() // pass 0 to 256 uint32 seeds; if fewer than 256 are provided, the rest | ||
// // will be generated using the xorshiftr128plus PRNG. | ||
// | ||
// Or use it as a drop-in replacement for the default PRNT in Rand: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// Or use it as a drop-in replacement for the default PRNT in Rand: | |
// Or use it as a drop-in replacement for the default PRNG in Rand: |
// unbiased, and unpredictable number generation. It can not be distinguished from real random | ||
// data, and in three decades of scrutiny, no practical attacks have been found. | ||
// | ||
// The default random number algorithm in gno was ported from Go's v2 rand implementatoon, which |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// The default random number algorithm in gno was ported from Go's v2 rand implementatoon, which | |
// The default random number algorithm in gno was ported from Go's v2 rand implementation, which |
I ported a number of my pseudo-random number generator implementations from Ruby to gno while traveling to the retreat last weekend as an exercise in expanding my comfort level with gno code, and expanding my understanding of some of the code internals, while contributing code that others may find interesting or useful.
I added two xorshift generators, xorshift64* and xorshiftr128+. These are both many times faster than the PCG generator that is the gno default, and produce high quality randomness with great statistical qualities. In addition to these, I added both the 32-bit ISAAC implementation (with an added function to return 64 bit values), and the 64-bit ISAAC implementation. ISAAC is a stellar pseudo-random number generator. Both implementations are significantly faster than PCG (though not near so fast as the xorshift algorithms), while producing extremely high quality, cryptographically secure randomness that can not be differentiated from real randomness.
All of these were built to be compatible with the standard Rand() implementation. This means that any of these can be used as a drop-in replacement for the default PCG algorithm:
All of these leverage the
gno.land/p/demo/entropy
package to assist with seeding if no seed is provided. In the case of the ISAAC algorithms, they require 256 uint values for their seed, so they leverage a combination ofentropy
andxorshiftr128+
to generate any missing numbers in the provided seed.I also added a function to entropy to return uint64, to facilitate using it for seeding.
I added tests to entropy, and wrote tests for the other generators, as well.
There are a few other things that ended up in this PR. In order to make some fact based assertions about the performance of these generators, I included some code that can be ran via
gno run -expr
. i.e.gno run -expr 'averageISAAC()' isaac.gno
that can be used to get some benchmarks and some very simple self-statistical-analysis on the results, and when I did so, I discovered that the currentufmt.Sprintf
implementation didn't support any of the float output flags.I added float support to it's capabilities, which, in turn, required adding
FormatFloat
to thestrconv.gno/strconv.go
implementation in the standard library. I added a test to cover this.I also noticed that there is a test in
tm2/pkg/p2p
that is failing on both master and my branch. Specifically, there is a call tosw.Logger.Error()
that passes a message and an error, but not"err"
before the error. Adding that seemed to clear up the build failure. This, specifically, is line 222 ofswitch.go
.Currently there is one failing test, which is the code coverage check on tm2, because it is non-obvious to me how to setup a test to properly exercise that one changed line.
Contributors' checklist...
BREAKING CHANGE: xxx
message was included in the description