lib/libm/complex/carg.3

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