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.

msat

The function msat returns the saturated representation of the prime modulus.

Postconditions: twos_complement_eval out1 = m 0 ≤ eval out1 < m

Output Bounds: out1: [[0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff], [0x0 ~> 0xffffffffffffffff]]

p384_64.msat

pub fn msat(out1: *[7]u64) void

File

lib/std/crypto/pcurves/p384/p384_64.zig:3197

Code

pub fn msat(out1: *[7]u64) void {
    @setRuntimeSafety(mode == .debug);

    out1[0] = 0xffffffff;
    out1[1] = 0xffffffff00000000;
    out1[2] = 0xfffffffffffffffe;
    out1[3] = 0xffffffffffffffff;
    out1[4] = 0xffffffffffffffff;
    out1[5] = 0xffffffffffffffff;
    out1[6] = 0x0;
}