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.

__cmptf2

"These functions calculate a <=> b. That is, if a is less than b, they return -1; if a is greater than b, they return 1; and if a and b are equal they return 0. If either argument is NaN they return 1..."

Note that this matches the definition of __letf2, __eqtf2, __netf2, __cmptf2, and __lttf2.

cmptf2.__cmptf2

fn __cmptf2(a: f128, b: f128) callconv(.c) i32

File

lib/compiler_rt/cmptf2.zig:43

Code

fn __cmptf2(a: f128, b: f128) callconv(.c) i32 {
    return @backingInt(comparef.cmpf2(f128, comparef.LE, a, b));
}