]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/cabs.3
membarrier.2: Remove redundant mention of return value of MEMBARRIER_CMD_SHARED
[thirdparty/man-pages.git] / man3 / cabs.3
CommitLineData
fea681da 1.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
2297bf0e 2.\"
38f20bb9 3.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
fea681da 4.\" Distributed under GPL
38f20bb9 5.\" %%%LICENSE_END
fea681da 6.\"
c73595c2 7.TH CABS 3 2015-04-19 "" "Linux Programmer's Manual"
fea681da 8.SH NAME
c13182ef 9cabs, cabsf, cabsl \- absolute value of a complex number
fea681da
MK
10.SH SYNOPSIS
11.B #include <complex.h>
12.sp
13.BI "double cabs(double complex " z );
d39541ec 14.br
fea681da 15.BI "float cabsf(float complex " z );
d39541ec 16.br
fea681da
MK
17.BI "long double cabsl(long double complex " z );
18.sp
20c58d70 19Link with \fI\-lm\fP.
fea681da 20.SH DESCRIPTION
5600f73a 21These functions return the absolute value of the complex number
daac0b39 22.IR z .
ca7b3c18 23The result is a real number.
f0d7ce1d
MK
24.SH VERSIONS
25These functions first appeared in glibc in version 2.1.
1c4f38c6
MS
26.SH ATTRIBUTES
27For an explanation of the terms used in this section, see
28.BR attributes (7).
29.TS
30allbox;
31lbw24 lb lb
32l l l.
33Interface Attribute Value
34T{
35.BR cabs (),
36.BR cabsf (),
37.BR cabsl ()
38T} Thread safety MT-Safe
39.TE
47297adb 40.SH CONFORMING TO
9a74e018 41C99, POSIX.1-2001, POSIX.1-2008.
2b2581ee 42.SH NOTES
daac0b39
MK
43The function is actually an alias for
44.I "hypot(a,\ b)"
45(or, equivalently,
46.IR "sqrt(a*a\ +\ b*b)" ).
47297adb 47.SH SEE ALSO
fea681da
MK
48.BR abs (3),
49.BR cimag (3),
50.BR hypot (3),
a8bda636 51.BR complex (7)