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 standard library.
std › math › complex › acosh Public Namespace acosh Doc Source Public Namespace Namespaces Types Functions pub fn acosh (z : anytype ) Complex (@TypeOf (z .re , z .im )) Returns the hyperbolic arc-cosine of z.
File math/complex/acosh.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26 const std = @import ("../../std.zig " );
const testing = std .testing ;
const math = std .math ;
const cmath = math .complex ;
const Complex = cmath .Complex ;
/// Returns the hyperbolic arc-cosine of z.
pub fn acosh (z : anytype ) Complex (@TypeOf (z .re , z .im )) {
const T = @TypeOf (z .re , z .im );
const q = cmath .acos (z );
return if (math .signbit (z .im ))
Complex (T ).init (q .im , -q .re )
else
Complex (T ).init (-q .im , q .re );
}
test acosh {
const epsilon = math .floatEps (f32 );
const a = Complex (f32 ).init (5 , 3 );
const c = acosh (a );
try testing .expectApproxEqAbs (2.4529128 , c .re , epsilon );
try testing .expectApproxEqAbs (0.5469737 , c .im , epsilon );
}