man-pages/man3/cabs.3

37 lines
833 B
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\" Distributed under GPL
.\"
.TH CABS 3 2008-08-11 "" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
cabs, cabsf, cabsl \- absolute value of a complex number
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.B #include <complex.h>
.sp
.BI "double cabs(double complex " z );
.br
2004-11-03 13:51:07 +00:00
.BI "float cabsf(float complex " z );
.br
2004-11-03 13:51:07 +00:00
.BI "long double cabsl(long double complex " z );
.sp
2007-07-21 05:25:03 +00:00
Link with \fI\-lm\fP.
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
The
.BR cabs ()
2007-12-24 11:27:43 +00:00
function returns the absolute value of the complex number
.IR z .
The result is a real number.
.SH VERSIONS
These functions first appeared in glibc in version 2.1.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
C99.
.SH NOTES
2007-12-24 11:27:43 +00:00
The function is actually an alias for
.I "hypot(a,\ b)"
(or, equivalently,
.IR "sqrt(a*a\ +\ b*b)" ).
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR abs (3),
.BR cimag (3),
.BR hypot (3),
2006-04-21 01:24:06 +00:00
.BR complex (7)