lib/libm/complex/cproj.3

   1 .\" $NetBSD: cproj.3,v 1.3 2011/11/29 13:17:04 drochner Exp $
   2 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   3 .TH "CPROJ" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   4 .\" cproj
   5 .SH NAME
   6 cproj, cprojf, cprojl \- complex projection functions
   7 .SH SYNOPSIS
   8 .LP
   9 \fB#include <complex.h>
  10 .br
  11 .sp
  12 double cproj(double complex\fP \fIz\fP\fB);
  13 .br
  14 float cprojf(float complex\fP \fIz\fP\fB);
  15 .br
  16 long double cprojl(long double complex\fP \fIz\fP\fB);
  17 .br
  18 \fP
  19 .SH DESCRIPTION
  20 .LP
  21 These functions compute a projection of \fIz\fP onto the Riemann sphere:
  22 \fIz\fP projects to \fIz\fP , except that all complex infinities (even those
  23 with one infinite part and one NaN part) project to positive infinity on the
  24 real axis. If \fIz\fP has an infinite part, then cproj(z) shall be equivalent to:
  25 INFINITY + I * copysign(0.0, cimag(z))
  26 .SH RETURN VALUE
  27 .LP
  28 These functions return the value of the projection onto the Riemann sphere.
  29 .SH ERRORS
  30 .LP
  31 No errors are defined.
  32 .LP
  33 \fIThe following sections are informative.\fP
  34 .SH EXAMPLES
  35 .LP
  36 None.
  37 .SH APPLICATION USAGE
  38 .LP
  39 None.
  40 .SH RATIONALE
  41 .LP
  42 None.
  43 .SH FUTURE DIRECTIONS
  44 .LP
  45 None.
  46 .SH SEE ALSO
  47 .LP
  48 \fIcarg\fP(), \fIcimag\fP(), \fIconj\fP(), \fIcreal\fP() the
  49 Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<complex.h>\fP
  50 .SH COPYRIGHT
  51 Portions of this text are reprinted and reproduced in electronic form
  52 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
  53 -- Portable Operating System Interface (POSIX), The Open Group Base
  54 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
  55 Electrical and Electronics Engineers, Inc and The Open Group. In the
  56 event of any discrepancy between this version and the original IEEE and
  57 The Open Group Standard, the original IEEE and The Open Group Standard
  58 is the referee document. The original Standard can be obtained online at
  59 http://www.opengroup.org/unix/online.html .