original/man3/cabs.3

   1 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Distributed under GPL
   5 .\" %%%LICENSE_END
   6 .\"
   7 .TH CABS 3 2008-08-11 "" "Linux Programmer's Manual"
   8 .SH NAME
   9 cabs, cabsf, cabsl \- absolute value of a complex number
  10 .SH SYNOPSIS
  11 .B #include <complex.h>
  12 .sp
  13 .BI "double cabs(double complex " z );
  14 .br
  15 .BI "float cabsf(float complex " z );
  16 .br
  17 .BI "long double cabsl(long double complex " z );
  18 .sp
  19 Link with \fI\-lm\fP.
  20 .SH DESCRIPTION
  21 The
  22 .BR cabs ()
  23 function returns the absolute value of the complex number
  24 .IR z .
  25 The result is a real number.
  26 .SH VERSIONS
  27 These functions first appeared in glibc in version 2.1.
  28 .SH CONFORMING TO
  29 C99.
  30 .SH NOTES
  31 The function is actually an alias for
  32 .I "hypot(a,\ b)"
  33 (or, equivalently,
  34 .IR "sqrt(a*a\ +\ b*b)" ).
  35 .SH SEE ALSO
  36 .BR abs (3),
  37 .BR cimag (3),
  38 .BR hypot (3),
  39 .BR complex (7)
  40 .SH COLOPHON
  41 This page is part of release 3.65 of the Linux
  42 .I man-pages
  43 project.
  44 A description of the project,
  45 and information about reporting bugs,
  46 can be found at
  47 \%http://www.kernel.org/doc/man\-pages/.