diff options
author | murray <murray@FreeBSD.org> | 2011-02-20 05:29:00 +0000 |
---|---|---|
committer | murray <murray@FreeBSD.org> | 2011-02-20 05:29:00 +0000 |
commit | 13343e496db627156bf26e73ed6147099d6a48c1 (patch) | |
tree | bcad078e51d717318a0d3f210f1e7a1628445bfa /lib/msun | |
parent | d2d0dfcef9790d58420cd354fbdd3055738d8797 (diff) | |
download | FreeBSD-src-13343e496db627156bf26e73ed6147099d6a48c1.zip FreeBSD-src-13343e496db627156bf26e73ed6147099d6a48c1.tar.gz |
Add complex(3) manual page documenting our partial support for C99
complex arithmetic in libm.
Reviewed by: David Schultz <das@FreeBSD.org>
MFC after: 2 weeks
Diffstat (limited to 'lib/msun')
-rw-r--r-- | lib/msun/Makefile | 3 | ||||
-rw-r--r-- | lib/msun/man/complex.3 | 128 |
2 files changed, 130 insertions, 1 deletions
diff --git a/lib/msun/Makefile b/lib/msun/Makefile index 0048e25..7950961 100644 --- a/lib/msun/Makefile +++ b/lib/msun/Makefile @@ -131,7 +131,8 @@ MAN= acos.3 acosh.3 asin.3 asinh.3 atan.3 atan2.3 atanh.3 ceil.3 \ fma.3 fmax.3 fmod.3 hypot.3 ieee.3 ieee_test.3 ilogb.3 j0.3 \ lgamma.3 log.3 lrint.3 lround.3 math.3 nan.3 \ nextafter.3 remainder.3 rint.3 \ - round.3 scalbn.3 signbit.3 sin.3 sinh.3 sqrt.3 tan.3 tanh.3 trunc.3 + round.3 scalbn.3 signbit.3 sin.3 sinh.3 sqrt.3 tan.3 tanh.3 trunc.3 \ + complex.3 MLINKS+=acos.3 acosf.3 acos.3 acosl.3 MLINKS+=acosh.3 acoshf.3 diff --git a/lib/msun/man/complex.3 b/lib/msun/man/complex.3 new file mode 100644 index 0000000..79ba5bc --- /dev/null +++ b/lib/msun/man/complex.3 @@ -0,0 +1,128 @@ +.\" Copyright (c) 2011 Murray Stokely <murray@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd February 19, 2011 +.Dt COMPLEX 3 +.Os +.Sh NAME +.Nm complex +.Nd "complex arithmetic" +.Sh LIBRARY +.Lb libm +.Sh SYNOPSIS +.In complex.h +.Sh DESCRIPTION +These functions support complex arithmetic in the C math library. +.Sh "LIST OF FUNCTIONS" +Each of the following +.Vt "double complex" +functions has a +.Vt "float complex" +counterpart with an +.Ql f +appended to the name and a +.Vt "long double complex" +counterpart with an +.Ql l +appended. +As an example, the +.Vt "float complex" +and +.Vt "long double complex" +counterparts of +.Ft double +.Fn cabs "double complex z" +are +.Ft float +.Fn cabsf "float complex z" +and +.Ft "long double" +.Fn cabsl "long double complex z" , +respectively. +.de Cl +.Bl -column "csqrt" "complex absolute value (i.e. norm, modulus, magnitude)" +.Em "Name Description" +.. +.\" Section 7.3.5 - 7.3.7 of ISO C99 standard unimplemented, see BUGS +.\" Section 7.3.8 of ISO C99 standard +.Ss Absolute-value Functions +.Cl +cabs complex absolute value (i.e. norm, modulus, magnitude) +csqrt complex square root +.El +.\" Section 7.3.9 of ISO C99 standard +.Ss Manipulation Functions +.Cl +carg compute the argument (i.e. phase angle) +cimag compute the imaginary part +conj compute the complex conjugate +cproj compute projection onto Riemann sphere +creal compute the real part +.El +.Sh SEE ALSO +.Xr math 3 , +.Xr fenv 3 , +.Xr ieee 3 , +.Xr tgmath 3 +.Rs +.%T "ISO/IEC 9899:TC3" +.%U http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf +.Re +.Sh STANDARDS +The +.In complex.h +functions described here conform to +.St -isoC-99 . +.Sh BUGS +The trigonmetric functions +.Fn cacos , +.Fn casin , +.Fn catan , +.Fn ccos , +.Fn csin , +and +.Fn ctan +are not implemented. +.Pp +The hyperbolic functions +.Fn cacosh , +.Fn casinh , +.Fn catanh , +.Fn ccosh , +.Fn csinh , +and +.Fn ctanh +are not implemented. +.Pp +The exponential and logarithmic functions +.Fn cexp , +and +.Fn clog +are not implemented. +.Pp +The power functions +.Fn cpow +are not implemented. |