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.

tanh

Returns the hyperbolic tangent of x.

Special Cases:

tanh(+-0) = +-0
tanh(+-inf) = +-1
tanh(nan) = nan

tanh.tanh

pub fn tanh(x: anytype) @TypeOf(x)

File

lib/std/math/tanh.zig:20

Code

pub fn tanh(x: anytype) @TypeOf(x) {
    const T = @TypeOf(x);
    return switch (T) {
        f32 => tanh32(x),
        f64 => tanh64(x),
        else => @compileError("tanh not implemented for " ++ @typeName(T)),
    };
}