lib/libm/complex/carg.3

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