Code Monkey home page Code Monkey logo

ranoise's Introduction

Random access noise algorithms & test programs

This repository contains a copy of my PRNG algorithms, some others for comparison, and related things. It includes test programs, to generate streams of pseudo-random int data sent to stdout (for use with statistical tests, e.g. dieharder or TestU01_stdin), and other code of my own. Note that most testing is for sequential use of a PRNG, while the whole point of my own PRNGs is to also allow random access (similar to integer-to-integer hashing) with the simplest code that does the job well enough. Other PRNGs are usually better for sequential purposes.

The basic idea of the "ranoise" functions is to use a simple counter as the state for random number generation. Position can be changed with various positive or negative frequencies, and "jumps" in the stream of noise are trivial. Chaotic waveshaping replaces the current input number with the pseudo-random number it indexes. A sawtooth-ish signal is transformed into white noise. Given their simplicity, these functions can be a good alternative to storing and using arrays of white noise. But other alternatives exist for this as well.

For each "ranoise" function, a function named with a _next-suffix is also provided; it instead behaves like a normal sequential access PRNG function for getting a next value, updating a passed state on each call. The state should be initialized before the first call to some value (any seed value is fine, including 0).

See the article "Random access noise: Avalanche effect through chaotic waveshaping" for more on the development of all this. Currently, programs for the following versions are included:

  • ranoise32 -- Minimal lower-quality version (compares well to 32-bit LCGs)
  • ranfast32 -- Faster alternative medium-quality version
  • ranoise32_old -- Older lower-quality version
  • ranoise32a -- Higher-quality version (compares well to SplitMix32)
  • ranoise32b -- Slightly different version, does better in PractRand testing

There's also a header file for the stuff they and other variations on the same theme have in common, muvaror32.h.

The C code files in this repository are licensed under the public domain-equivalent 0BSD license, meaning they can be copied from without an attribution requirement (though credit is nice). The same applies to the code in this README.

The bare functions

While arguably uglier than using the macros or inline functions for bitrotation, etc., here's everything-in-one-go versions of the function definitions.

My ranoise functions

There's one practical issue with using the functions named ranoise32-something, they are not that fast compared to other functions. The SplitMix32 functions are faster on my x86-64 system (that varying bitrotation is slow!). For weaker randomness, ranfast32 is however slightly faster than the SplitMix32s.

For audio, there's no audible improvement to the more elaborate versions (e.g. adding xor-and-rightshift steps to improve avalanching and quality of lower bits), assuming the higher bits define most of the amplitude of the signal listened to in the usual way. The same may be true for graphics and what's visible. However, those looking to extract two rather than one samples from each output value (splitting each 32-bit sample into two 16-bit samples) need one of the higher-quality options (those comparable to SplitMix32).

ranoise32

Stripped-down version of ranoise32a, containing only the most important part of the algorithm -- with a view to using a varying bitrotation.

Tested with an increasing counter as the argument, it fails some TestU01 SmallCrush tests and as such is comparable to both 32-bit LCGs and xorshift32. The failures are more like those of LCGs, but fewer; this is also the case in both PractRand (1 MB stage failures, still) and dieharder testing.

int32_t ranoise32(uint32_t x) {
        x *= 2654435769UL;
        x = (x | 1) * ((x >> (x >> 27)) | (x << (32-(x >> 27))));
        return x;
}

It's possible to add a bitrotation offset so as to produce one of 31 alternative outputs (easiest to do using the MUVAROR32 macro used in the C file, by changing the last argument from 0 to another number).

ranfast32

Another way to strip down ranoise32a is to remove the bitrotation and just multiply. This passes TestU01 SmallCrush, and indeed I originally used this weakened form of the function while testing for the best bitshift constants to use (because arriving at failed statistical tests then took far less time).

Later, disappointed by the poor speed of ranoise32 on x86 compared to SplitMix32, I decided to revisit this as a faster option. In other statistical tests, it's worse than SplitMix32, but better than 32-bit LCGs, xorshift32, and the lower-quality ranoise32 functions. In PractRand testing, it fails at 16 MB.

int32_t ranfast32(uint32_t x) {
        x *= 2654435769UL;
        x ^= x >> 14;
        x = (x | 1) * x;
        x ^= x >> 13;
        return x;
}

This is the ranoise-related function most likely to be useful for signal processing purposes, in situations where how it sounds or looks matters far more than statistical properties. The higher output bits are the best.

ranoise32_old

This is an earlier version with some quirks and flaws, worth keeping for the distinctive smoothness of the output. It works well as long as changes to x between calls are small or have lower bits set.

Tested with an increasing counter as the argument, it fails 3 of TestU01's medium-sized Crush tests. In PractRand testing, like other low-quality PRNGs (32-bit LCGs, xorshift32, etc.), it fails at a 1 MB size, though only once.

int32_t ranoise32_old(uint32_t x) {
        x *= 2654435769UL;
        x *= (x >> (x + 14)) | (x << (32-(x + 14)));
        x ^= (x >> 7) ^ (x >> 16);
        return x;
}

If the last line before the return is removed, the result is a function with failure patterns in dieharder testing which are very similar to those of a 32-bit LCG. (With that last step included, dieharder testing however passes.)

ranoise32a

This is a reworked version which does very well in TestU01 testing for a PRNG with only 32 bits of state. (Many PRNGs with 64-bits or more of state can do better.) Tested with an increasing counter as the argument, it passes TestU01's medium-sized Crush tests, but still fails 5 BigCrush tests (mainly 4 "Gap" tests); though in -r mode, there's 3 Crush failures and 7 BigCrush failures. In PractRand, there's a failed test during the 2 GB stage, one round above how well SplitMix32 does.

int32_t ranoise32a(uint32_t x) {
        x *= 2654435769UL;
        x ^= x >> 14;
        x = (x | 1) * ((x >> (x >> 27)) | (x << (32-(x >> 27))));
        x ^= x >> 13;
        return x;
}

(An alternative choice of bitshift lengths, 15 and 14 instead of 14 and 13, improves PractRand's evaluation a little, failures appearing at 4 GB instead when testing with various starting values, but it also worsens TestU01 test failures a little: one normal Crush failure, 10 -r BigCrush failures.)

ranoise32b

Re-adding a bitrotation offset number can significantly improve how well it does in PractRand, without significantly worsening the TestU01 scores, at least when a good choice of number is made (16 seems optimal here). With various starting values, the below version has a few failings during PractRand's 16 GB stage. Meanwhile, BigCrush failures have gone up to 7 (6 in -r), Crush failures to 1 (2 in -r).

int32_t ranoise32b(uint32_t x) {
        uint32_t r;
        x *= 2654435769UL;
        x ^= x >> 14;
        r = (x >> 27) + 16;
        x = (x | 1) * ((x >> r) | (x << (32-r)));
        x ^= x >> 13;
        return x;
}

Other interesting functions

Here's some other PRNGs that could very easily be used in place of ranoise32 functions. This also includes ease of random access use, or of changing a function for such.

SplitMix32 variations

Variations of SplitMix32 are intuitively part of the main competition, given that SplitMix64 is a good PRNG which passes BigCrush. The 32-bit version of SplitMix does poorer in testing with both TestU01 (failing some Crush and more BigCrush tests) and PractRand, however. Higher-quality variations of ranoise32 do better in statistical testing.

SplitMix32 is quite fast, of the ranoise-related functions only ranfast32 beats it in performance testing on x86-64.

splitmix32a

A seemingly popular variation of SplitMix32 changes the first bitshift length from 16 to 15. It is included under the name splitmix32a in this repository, and fares slightly better than plain splitmix32 in Crush and BigCrush tests (5 or 4 failures in Crush, 9 in BigCrush). In PractRand, this variation fails during the 1 GB stage, whereas plain splitmix32 fails in the preceding 512 MB round.

uint32_t splitmix32a_next(uint32_t *pos) {
        uint32_t x = *pos += 2654435769UL;
        x ^= x >> 15;
        x *= 0x85ebca6b;
        x ^= x >> 13;
        x *= 0xc2b2ae35;
        x ^= x >> 16;
        return x;
}

splitmix32b

I also decided to include a splitmix32b, which fully replaces the 32-bit MurmurHash3 fmix function with another integer-to-integer hash function of the same form, the best currently found and provided by Christopher Wellons's 'hash-prospector' project. This was a little tricky and fiddly to get working well, because some failures at all test levels in TestU01 testing came and went haphazardly with variations. How well variations of this kind of function work in testing as PRNGs seems more complicated than how strictly good they are as hash functions. The best result may also depend on finding a suitable increment constant peculiar to the function tested; the usual quick pick of the constant based on the golden ratio doesn't work well in SmallCrush testing for this function. On the whole, the below version is roughly as good as splitmix32a in both TestU01 and PractRand testing.

uint32_t splitmix32b_next(uint32_t *pos) {
        uint32_t x = *pos += 2452817881UL;
        x ^= x >> 15;
        x *= 0xd168aaad;
        x ^= x >> 15;
        x *= 0xaf723597;
        x ^= x >> 15;
        return x;
}

Mulberry32

Mulberry32 is another PRNG with results comparable to SplitMix32, and included as mulberry32. In testing with TestU01 and PractRand it does roughly as well as splitmix32a above. (It does a little better in PractRand, but still has a failure during the 1 GB stage, and somewhat worse in TestU01, with 23 normal BigCrush failures and 16 in -r mode.)

uint32_t mulberry32_next(uint32_t *pos) {
        uint32_t z = *pos += 0x6D2B79F5UL;
        z = (z ^ (z >> 15)) * (z | 1UL);
        z ^= z + (z ^ (z >> 7)) * (z | 61UL);
        return z ^ (z >> 14);
}

Running statistical tests

If you install dieharder, then you can run a program named after a function from this repository through it as follows:

make && ./ranoise32 | dieharder -a -g 200

There is also a utility called TestU01_stdin (my 2022 version with added options for bitreversal and verbosity) which, if built and installed after TestU01 is, allows similar testing with TestU01 (-s for SmallCrush, -c for Crush, -b for BigCrush, -l for LinearComp):

make && ./ranoise32 | TestU01_stdin -s

Or to write everything from a verbose TestU01 run (more than just the summary at the end), plus a final count of 32-bit samples generated, to a file:

make && ./ranoise32 | TestU01_stdin -sv 3>&1 2>&3 | tee file.txt

For PractRand's RNG_test utility (which is far more critical than dieharder and way faster than TestU01 is beyond SmallCrush):

make && ./ranoise32 | RNG_test stdin32 -tlmin 1MB

Current results

Outputs for various tests with the unmodified current programs in this repository can be found under results/. PractRand (practrand-*) is good for quick comparisons. Full TestU01 results (smallcrush-*, crush-*, bigcrush-*) are rather verbose, but the short summary can be found at the end of each file. For a more detailed look at what goes wrong in lower-quality PRNGs, it can be interesting to look at dieharder results (dieharder-*).

The files for TestU01 tests named *-rev.txt use the -r option for TestU01_stdin to reverse the order of bits within each 32-bit word. When this results in more failures, it may point towards randomness in the lowest bits being of worse quality than that in higher bits. (TestU01 is less sensitive to flaws in the lowest bits.) However, when testing some PRNGs the number of BigCrush failures for both normal and -r testing varies haphazardly (and often in opposite directions), with small variations to the PRNG, so that looking at both results and considering the average may be more sensible.

ranoise's People

Contributors

joelkp avatar

Watchers

 avatar

ranoise's Issues

splitmix32a info

Hello,

I'm possibly the one responsible for splitmix32a, or at least a lot of people seem to be using it from my post over at https://stackoverflow.com/a/52056161/815680.

I can't seem to find any source that I might've referenced prior to Aug 2018. There still might've been some unknown source that convinced me it was better than the supposed 'original', but can't remember anything for sure. I never tested it though, so I'm surprised that it's somehow better.

I actually had a slightly different version at first, before I quickly edited it the current constants.

uint32_t splitmix32(void) {
    uint32_t z = state += 0x3504f333;
    z ^= z >> 15; // 16 for murmur3
    z *= 0x85ebca6b;
    z ^= z >> 13;
    z *= 0xc2b2ae3d; // 0xc2b2ae35 for murmur3
    return z ^= z >> 16;
}

For some reason in this first version I used one constant from xxHash. No clue why. Of course the original is just a modified fmix fn from MurmurHash3.

I also chose an increment value related to Weyl sequences likely originating from here: http://marc-b-reynolds.github.io/math/2016/03/29/weyl_hash.html

I found a similar function that uses both of xxHash's constants in a similar function, also sharing that 0x3504f333 increment: https://www.thefiletree.com/espadrine/%E2%9A%92/random/weyl.html?app=html. Though this appears to be dated to 2020.

Feel free to close this issue, just sharing some info.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.