freebsd-dev/lib/msun/man/complex.3
Steve Kargl 046e2d5db1 Implementations of cexpl()
The change implements cexpl() for both ld80 and ld128 architectures.
Testing was done on x86_64 and aarch64 systems.

Along the way sincos[fl]() use an optimization that reduces the argument
to being done one rather than twice.  This optimization actually pointed
to a bug in the ld128 version of sincosl(), which is now fixed.  In
addition, the minmax polynomial coefficients for sincosl() have been
updated.

A concise log of the file-by-file changes follows.

* include/complex.h:
  . Add a prototype for cexpl().

* lib/msun/Makefile:
  . Add s_cexpl.c to the build.
  . Setup a link for cexpl.3 to cexp.3.

* lib/msun/Symbol.map:
  . Expose cexpl symbol in libm shared library.

* lib/msun/ld128/s_cexpl.c:
  * Implementation of cexpl() for 128-bit long double architectures.
    Tested on an aarch64 system.

* lib/msun/ld80/s_cexpl.c:
  * Implementation of cexpl() for Intel 80-bit long double.

* lib/msun/man/cexp.3:
  . Document cexpl().

* lib/msun/man/complex.3:
  . Add a BUGS section about cpow[fl].

* lib/msun/src/s_cexp.c:
  . Include float.h for weak references on 53-bit long double targets.
  . Use sincos() to reduce argument reduction cost.

* lib/msun/src/s_cexpf.c:
  . Use sincosf() to reduce argument reduction cost.

* lib/msun/src/k_sincosl.h:
  . Catch up with the new minmax polynomial coefficients for the kernel for
    the 128-bit cosl() implementation.
  . BUG FIX: *cs was used where *sn should have been.  This means that sinl()
    was no computed correctly when iy != 0.

* lib/msun/src/s_cosl.c:
  . Include fpmath.h to get access to IEEEl2bits.
  . Replace M_PI_4 with pio4,  a 64-bit or 113-bit approximation for pi / 4.

PR:	216862
MFC after:	1 week
2021-11-05 13:51:42 +02:00

130 lines
3.4 KiB
Groff

.\" 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 November 3, 2021
.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
.Ss Exponential Function
.Cl
cexp exponential base e
.El
.Ss Natural logarithm Function
.Cl
clog natural logarithm
.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
.\" Section 7.3.5-6 of ISO C99 standard
.Ss Trigonometric and Hyperbolic Functions
.Cl
cacos arc cosine
cacosh arc hyperbolic cosine
casin arc sine
casinh arc hyperbolic sine
catan arc tangent
catanh arc hyperbolic tangent
ccos cosine
ccosh hyperbolic cosine
cpow power function
csin sine
csinh hyperbolic sine
ctan tangent
ctanh hyperbolic tangent
.El
.Sh SEE ALSO
.Xr fenv 3 ,
.Xr ieee 3 ,
.Xr math 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 power functions,
.Fn cpowf, cpow ,
and
.Fn cpowl ,
are implemented, but the code was neither reviewed nor tested.