lib/libm/complex/cimag.3

   1 .\" $NetBSD: cimag.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 "CIMAG" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   4 .\" cimag
   5 .SH NAME
   6 cimag, cimagf \- complex imaginary functions
   7 .SH SYNOPSIS
   8 .LP
   9 \fB#include <complex.h>
  10 .br
  11 .sp
  12 double cimag(double complex\fP \fIz\fP\fB);
  13 .br
  14 float cimagf(float complex\fP \fIz\fP\fB);
  15 .br
  16 \fP
  17 .SH DESCRIPTION
  18 .LP
  19 These functions compute the imaginary part of \fIz\fP.
  20 .SH RETURN VALUE
  21 .LP
  22 These functions return the imaginary part value (as a real).
  23 .SH ERRORS
  24 .LP
  25 No errors are defined.
  26 .LP
  27 \fIThe following sections are informative.\fP
  28 .SH EXAMPLES
  29 .LP
  30 None.
  31 .SH APPLICATION USAGE
  32 .LP
  33 For a variable \fIz\fP of complex type:
  34 .sp
  35 .RS
  36 .nf
  37
  38 \fBz == creal(z) + cimag(z)*I
  39 \fP
  40 .fi
  41 .RE
  42 .SH RATIONALE
  43 .LP
  44 None.
  45 .SH FUTURE DIRECTIONS
  46 .LP
  47 None.
  48 .SH SEE ALSO
  49 .LP
  50 \fIcarg\fP(), \fIconj\fP(), \fIcproj\fP(), \fIcreal\fP(), the
  51 Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<complex.h>\fP
  52 .SH COPYRIGHT
  53 Portions of this text are reprinted and reproduced in electronic form
  54 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
  55 -- Portable Operating System Interface (POSIX), The Open Group Base
  56 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
  57 Electrical and Electronics Engineers, Inc and The Open Group. In the
  58 event of any discrepancy between this version and the original IEEE and
  59 The Open Group Standard, the original IEEE and The Open Group Standard
  60 is the referee document. The original Standard can be obtained online at
  61 http://www.opengroup.org/unix/online.html .