Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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 standard library. Public Type Function

Wrapping

Public Type Function
std.Random.lcg.Wrapping
pub fn Wrapping(comptime T: type) type

Linear congruent generator where the modulo is std.math.maxInt(T), wrapping over the integer.

Fields

xi: T
a: T
c: T

Types

Functions

pub fn init(xi: T, a: T, c: T) LcgSelf
pub fn next(lcg: *LcgSelf) T

File

Random/lcg.zig:11
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
pub fn Wrapping(comptime T: type) type {
    return struct {
        xi: T,
        a: T,
        c: T,

        pub fn init(xi: T, a: T, c: T) LcgSelf {
            return .{ .xi = xi, .a = a, .c = c };
        }

        pub fn next(lcg: *LcgSelf) T {
            lcg.xi = (lcg.a *% lcg.xi) +% lcg.c;
            return lcg.xi;
        }

        const LcgSelf = @This();
    };
}