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.

isAlignedLog2

Returns true if addr is aligned to 2^log2_alignment. More efficient than isAligned when alignment is known to be a power of 2. log2_alignment must be < @bitSizeOf(usize).

mem.isAlignedLog2

pub fn isAlignedLog2(addr: usize, log2_alignment: u8) bool

File

lib/std/mem.zig:4923

Code

pub fn isAlignedLog2(addr: usize, log2_alignment: u8) bool {
    return @ctz(addr) >= log2_alignment;
}