lib/libm/complex/creal.3

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