NetBSD/lib/libm/complex/carg.3

57 lines
1.6 KiB
Groff
Raw Normal View History

.\" $NetBSD: carg.3,v 1.1 2008/02/20 09:55:38 drochner Exp $
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
.TH "CARG" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" carg
.SH NAME
carg, cargf \- complex argument functions
.SH SYNOPSIS
.LP
\fB#include <complex.h>
.br
.sp
double carg(double complex\fP \fIz\fP\fB);
.br
float cargf(float complex\fP \fIz\fP\fB);
.br
\fP
.SH DESCRIPTION
.LP
These functions compute the argument (also called phase angle)
of \fIz\fP, with a branch cut along the negative real
axis.
.SH RETURN VALUE
.LP
These functions return the value of the argument in the interval
[-pi,\ +pi].
.SH ERRORS
.LP
No errors are defined.
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIcimag\fP(), \fIconj\fP(), \fIcproj\fP(), the
Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<complex.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .