lib/libm/complex/cabs.3

   1 .\" $NetBSD$
   2 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   3 .TH "CABS" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   4 .\" cabs
   5 .SH NAME
   6 cabs, cabsf \- return a complex absolute value
   7 .SH SYNOPSIS
   8 .LP
   9 \fB#include <complex.h>
  10 .br
  11 .sp
  12 double cabs(double complex\fP \fIz\fP\fB);
  13 .br
  14 float cabsf(float complex\fP \fIz\fP\fB);
  15 .br
  16 \fP
  17 .SH DESCRIPTION
  18 .LP
  19 These functions compute the complex absolute value (also called
  20 norm, modulus, or magnitude) of \fIz\fP.
  21 .SH RETURN VALUE
  22 .LP
  23 These functions return the complex absolute value.
  24 .SH ERRORS
  25 .LP
  26 No errors are defined.
  27 .LP
  28 \fIThe following sections are informative.\fP
  29 .SH EXAMPLES
  30 .LP
  31 None.
  32 .SH APPLICATION USAGE
  33 .LP
  34 None.
  35 .SH RATIONALE
  36 .LP
  37 None.
  38 .SH FUTURE DIRECTIONS
  39 .LP
  40 None.
  41 .SH SEE ALSO
  42 .LP
  43 The Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<complex.h>\fP
  44 .SH COPYRIGHT
  45 Portions of this text are reprinted and reproduced in electronic form
  46 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
  47 -- Portable Operating System Interface (POSIX), The Open Group Base
  48 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
  49 Electrical and Electronics Engineers, Inc and The Open Group. In the
  50 event of any discrepancy between this version and the original IEEE and
  51 The Open Group Standard, the original IEEE and The Open Group Standard
  52 is the referee document. The original Standard can be obtained online at
  53 http://www.opengroup.org/unix/online.html .