lib/msun/man/complex.3

   1 .\" Copyright (c) 2011 Murray Stokely <murray@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 7, 2011
  28 .Dt COMPLEX 3
  29 .Os
  30 .Sh NAME
  31 .Nm complex
  32 .Nd "complex arithmetic"
  33 .Sh LIBRARY
  34 .Lb libm
  35 .Sh SYNOPSIS
  36 .In complex.h
  37 .Sh DESCRIPTION
  38 These functions support complex arithmetic in the C math library.
  39 .Sh "LIST OF FUNCTIONS"
  40 Each of the following
  41 .Vt "double complex"
  42 functions has a
  43 .Vt "float complex"
  44 counterpart with an
  45 .Ql f
  46 appended to the name and a
  47 .Vt "long double complex"
  48 counterpart with an
  49 .Ql l
  50 appended.
  51 As an example, the
  52 .Vt "float complex"
  53 and
  54 .Vt "long double complex"
  55 counterparts of
  56 .Ft double
  57 .Fn cabs "double complex z"
  58 are
  59 .Ft float
  60 .Fn cabsf "float complex z"
  61 and
  62 .Ft "long double"
  63 .Fn cabsl "long double complex z" ,
  64 respectively.
  65 .de Cl
  66 .Bl -column "csqrt" "complex absolute value (i.e. norm, modulus, magnitude)"
  67 .Em "Name       Description"
  68 ..
  69 .\" Section 7.3.5 - 7.3.7 of ISO C99 standard unimplemented, see BUGS
  70 .\" Section 7.3.8 of ISO C99 standard
  71 .Ss Absolute-value Functions
  72 .Cl
  73 cabs    complex absolute value (i.e. norm, modulus, magnitude)
  74 csqrt   complex square root
  75 .El
  76 .Ss Exponential Function
  77 .Cl
  78 cexp    exponential base e
  79 .El
  80 .\" Section 7.3.9 of ISO C99 standard
  81 .Ss Manipulation Functions
  82 .Cl
  83 carg    compute the argument (i.e. phase angle)
  84 cimag   compute the imaginary part
  85 conj    compute the complex conjugate
  86 cproj   compute projection onto Riemann sphere
  87 creal   compute the real part
  88 .El
  89 .Sh SEE ALSO
  90 .Xr math 3 ,
  91 .Xr fenv 3 ,
  92 .Xr ieee 3 ,
  93 .Xr tgmath 3
  94 .Rs
  95 .%T "ISO/IEC 9899:TC3"
  96 .%U http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf
  97 .Re
  98 .Sh STANDARDS
  99 The
 100 .In complex.h
 101 functions described here conform to
 102 .St -isoC-99 .
 103 .Sh BUGS
 104 The inverse trigonometric and hyperbolic functions
 105 .Fn cacos ,
 106 .Fn cacosh ,
 107 .Fn casin ,
 108 .Fn casinh ,
 109 .Fn catan ,
 110 .Fn catanh ,
 111 .Fn ccos ,
 112 .Fn ccosh ,
 113 .Fn csin ,
 114 .Fn csinh ,
 115 .Fn ctan ,
 116 and
 117 .Fn ctanh
 118 are not implemented.
 119 .Pp
 120 The logarithmic functions
 121 .Fn clog
 122 are not implemented.
 123 .Pp
 124 The power functions
 125 .Fn cpow
 126 are not implemented.