original/man3/cabs.3

   1 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   2 .\" Distributed under GPL
   3 .\"
   4 .TH CABS 3 2008-08-11 "" "Linux Programmer's Manual"
   5 .SH NAME
   6 cabs, cabsf, cabsl \- absolute value of a complex number
   7 .SH SYNOPSIS
   8 .B #include <complex.h>
   9 .sp
  10 .BI "double cabs(double complex " z );
  11 .br
  12 .BI "float cabsf(float complex " z );
  13 .br
  14 .BI "long double cabsl(long double complex " z );
  15 .sp
  16 Link with \fI\-lm\fP.
  17 .SH DESCRIPTION
  18 The
  19 .BR cabs ()
  20 function returns the absolute value of the complex number
  21 .IR z .
  22 The result is a real number.
  23 .SH VERSIONS
  24 These functions first appeared in glibc in version 2.1.
  25 .SH "CONFORMING TO"
  26 C99.
  27 .SH NOTES
  28 The function is actually an alias for
  29 .I "hypot(a,\ b)"
  30 (or, equivalently,
  31 .IR "sqrt(a*a\ +\ b*b)" ).
  32 .SH "SEE ALSO"
  33 .BR abs (3),
  34 .BR cimag (3),
  35 .BR hypot (3),
  36 .BR complex (7)