Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

SplitMix64.zig

Generator to extend 64-bit seed values into longer sequences.

The number of cycles is thus limited to 64-bits regardless of the engine, but this is still plenty for practical purposes.

File

lib/std/Random/SplitMix64.zig

Code

//! Generator to extend 64-bit seed values into longer sequences.
//!
//! The number of cycles is thus limited to 64-bits regardless of the engine, but this
//! is still plenty for practical purposes.

const SplitMix64 = @This();

s: u64,

pub fn init(seed: u64) SplitMix64 {
    return SplitMix64{ .s = seed };
}

pub fn next(self: *SplitMix64) u64 {
    self.s +%= 0x9e3779b97f4a7c15;

    var z = self.s;
    z = (z ^ (z >> 30)) *% 0xbf58476d1ce4e5b9;
    z = (z ^ (z >> 27)) *% 0x94d049bb133111eb;
    return z ^ (z >> 31);
}