man3/cabs.3

   1 '\" t
   2 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-1.0-or-later
   5 .\"
   6 .TH cabs 3 (date) "Linux man-pages (unreleased)"
   7 .SH NAME
   8 cabs, cabsf, cabsl \- absolute value of a complex number
   9 .SH LIBRARY
  10 Math library
  11 .RI ( libm ", " \-lm )
  12 .SH SYNOPSIS
  13 .nf
  14 .B #include <complex.h>
  15 .PP
  16 .BI "double cabs(double complex " z );
  17 .BI "float cabsf(float complex " z );
  18 .BI "long double cabsl(long double complex " z );
  19 .fi
  20 .SH DESCRIPTION
  21 These functions return the absolute value of the complex number
  22 .IR z .
  23 The result is a real number.
  24 .SH ATTRIBUTES
  25 For an explanation of the terms used in this section, see
  26 .BR attributes (7).
  27 .ad l
  28 .nh
  29 .TS
  30 allbox;
  31 lbx lb lb
  32 l l l.
  33 Interface       Attribute       Value
  34 T{
  35 .BR cabs (),
  36 .BR cabsf (),
  37 .BR cabsl ()
  38 T}      Thread safety   MT-Safe
  39 .TE
  40 .hy
  41 .ad
  42 .sp 1
  43 .SH STANDARDS
  44 C11, POSIX.1-2008.
  45 .SH HISTORY
  46 glibc 2.1.
  47 C99, POSIX.1-2001.
  48 .SH NOTES
  49 The function is actually an alias for
  50 .I "hypot(a,\ b)"
  51 (or, equivalently,
  52 .IR "sqrt(a*a\ +\ b*b)" ).
  53 .SH SEE ALSO
  54 .BR abs (3),
  55 .BR cimag (3),
  56 .BR hypot (3),
  57 .BR complex (7)