openlibm_complex.h

Go to the documentation of this file.

/*  $OpenBSD: complex.h,v 1.5 2014/03/16 18:38:30 guenther Exp $    */
/*
 * Copyright (c) 2008 Martynas Venckus <martynas@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifdef OPENLIBM_USE_HOST_COMPLEX_H
#include <complex.h>
#else /* !OPENLIBM_USE_HOST_COMPLEX_H */
 
#ifndef OPENLIBM_COMPLEX_H
#define OPENLIBM_COMPLEX_H
 
#define complex _Complex
 
#define _Complex_I 1.0fi
#define I _Complex_I
 
/*
 * Macros that can be used to construct complex values.
 *
 * The C99 standard intends x+I*y to be used for this, but x+I*y is
 * currently unusable in general since gcc introduces many overflow,
 * underflow, sign and efficiency bugs by rewriting I*y as
 * (0.0+I)*(y+0.0*I) and laboriously computing the full complex product.
 * In particular, I*Inf is corrupted to NaN+I*Inf, and I*-0 is corrupted
 * to -0.0+I*0.0.
 *
 * In C11, a CMPLX(x,y) macro was added to circumvent this limitation,
 * and gcc 4.7 added a __builtin_complex feature to simplify implementation
 * of CMPLX in libc, so we can take advantage of these features if they
 * are available. Clang simply allows complex values to be constructed
 * using a compound literal.
 *
 * If __builtin_complex is not available, resort to using inline
 * functions instead. These can unfortunately not be used to construct
 * compile-time constants.
 *
 * C99 specifies that complex numbers have the same representation as
 * an array of two elements, where the first element is the real part
 * and the second element is the imaginary part.
 */
 
#ifdef __clang__
#  define CMPLXF(x, y) ((float complex){x, y})
#  define CMPLX(x, y) ((double complex){x, y})
#  define CMPLXL(x, y) ((long double complex){x, y})
#elif (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)) && !defined(__INTEL_COMPILER)
#  define CMPLXF(x,y) __builtin_complex ((float) (x), (float) (y))
#  define CMPLX(x,y) __builtin_complex ((double) (x), (double) (y))
#  define CMPLXL(x,y) __builtin_complex ((long double) (x), (long double) (y))
#elif defined(_MSC_BUILD)
 //-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 //
 // Types
 //
 //-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
#ifndef _C_COMPLEX_T
#define _C_COMPLEX_T
typedef struct _C_double_complex {
    double _Val[2];
} _C_double_complex;
 
typedef struct _C_float_complex {
    float _Val[2];
} _C_float_complex;
 
typedef struct _C_ldouble_complex {
    long double _Val[2];
} _C_ldouble_complex;
#endif
 
typedef _C_double_complex  _Dcomplex;
typedef _C_float_complex   _Fcomplex;
typedef _C_ldouble_complex _Lcomplex;
 
static inline _Fcomplex
CMPLXF(float x, float y) {
    union {
        float a[2];
        _Fcomplex f;
    } z;
    z.a[0] = x;
    z.a[1] = y;
 
    return (z.f);
}
 
static inline _Dcomplex
CMPLX(double x, double y) {
    union {
        double a[2];
        _Dcomplex f;
    } z;
    z.a[0] = x;
    z.a[1] = y;
 
    return (z.f);
}
 
static inline _Lcomplex
CMPLXL(long double x, long double y) {
    union {
        long double a[2];
        _Lcomplex f;
    } z;
    z.a[0] = x;
    z.a[1] = y;
 
    return (z.f);
}
#else
static inline float complex CMPLXF(float x, float y)
{
    union {
        float a[2];
        float complex f;
    } z = {{ x, y }};
 
    return (z.f);
}
 
static inline double complex
CMPLX(double x, double y)
{
    union {
        double a[2];
        double complex f;
    } z = {{ x, y }};
 
    return (z.f);
}
 
static inline long double complex
CMPLXL(long double x, long double y)
{
    union {
        long double a[2];
        long double complex f;
    } z = {{ x, y }};
 
    return (z.f);
}
#endif
 
#if !defined(_MSC_BUILD)
/*
 * Double versions of C99 functions
 */
double complex cacos(double complex);
double complex casin(double complex);
double complex catan(double complex);
double complex ccos(double complex);
double complex csin(double complex);
double complex ctan(double complex);
double complex cacosh(double complex);
double complex casinh(double complex);
double complex catanh(double complex);
double complex ccosh(double complex);
double complex csinh(double complex);
double complex ctanh(double complex);
double complex cexp(double complex);
double complex clog(double complex);
double cabs(double complex);
double complex cpow(double complex, double complex);
double complex csqrt(double complex);
double carg(double complex);
double cimag(double complex);
double complex conj(double complex);
double complex cproj(double complex);
double creal(double complex);
 
/*
 * Float versions of C99 functions
 */
float complex cacosf(float complex);
float complex casinf(float complex);
float complex catanf(float complex);
float complex ccosf(float complex);
float complex csinf(float complex);
float complex ctanf(float complex);
float complex cacoshf(float complex);
float complex casinhf(float complex);
float complex catanhf(float complex);
float complex ccoshf(float complex);
float complex csinhf(float complex);
float complex ctanhf(float complex);
float complex cexpf(float complex);
float complex clogf(float complex);
float cabsf(float complex);
float complex cpowf(float complex, float complex);
float complex csqrtf(float complex);
float cargf(float complex);
float cimagf(float complex);
float complex conjf(float complex);
float complex cprojf(float complex);
float crealf(float complex);
 
/*
 * Long double versions of C99 functions
 */
long double complex cacosl(long double complex);
long double complex casinl(long double complex);
long double complex catanl(long double complex);
long double complex ccosl(long double complex);
long double complex csinl(long double complex);
long double complex ctanl(long double complex);
long double complex cacoshl(long double complex);
long double complex casinhl(long double complex);
long double complex catanhl(long double complex);
long double complex ccoshl(long double complex);
long double complex csinhl(long double complex);
long double complex ctanhl(long double complex);
long double complex cexpl(long double complex);
long double complex clogl(long double complex);
long double cabsl(long double complex);
long double complex cpowl(long double complex,
    long double complex);
long double complex csqrtl(long double complex);
long double cargl(long double complex);
long double cimagl(long double complex);
long double complex conjl(long double complex);
long double complex cprojl(long double complex);
long double creall(long double complex);
#else
/*
* Double versions of C99 functions
*/
_Dcomplex cacos(_Dcomplex);
_Dcomplex casin(_Dcomplex);
_Dcomplex catan(_Dcomplex);
_Dcomplex ccos(_Dcomplex);
_Dcomplex csin(_Dcomplex);
_Dcomplex ctan(_Dcomplex);
_Dcomplex cacosh(_Dcomplex);
_Dcomplex casinh(_Dcomplex);
_Dcomplex catanh(_Dcomplex);
_Dcomplex ccosh(_Dcomplex);
_Dcomplex csinh(_Dcomplex);
_Dcomplex ctanh(_Dcomplex);
_Dcomplex cexp(_Dcomplex);
_Dcomplex clog(_Dcomplex);
double cabs(_Dcomplex);
_Dcomplex cpow(_Dcomplex, _Dcomplex);
_Dcomplex csqrt(_Dcomplex);
double carg(_Dcomplex);
double cimag(_Dcomplex);
_Dcomplex conj(_Dcomplex);
_Dcomplex cproj(_Dcomplex);
double creal(_Dcomplex);
 
/*
* Float versions of C99 functions
*/
_Fcomplex cacosf(_Fcomplex);
_Fcomplex casinf(_Fcomplex);
_Fcomplex catanf(_Fcomplex);
_Fcomplex ccosf(_Fcomplex);
_Fcomplex csinf(_Fcomplex);
_Fcomplex ctanf(_Fcomplex);
_Fcomplex cacoshf(_Fcomplex);
_Fcomplex casinhf(_Fcomplex);
_Fcomplex catanhf(_Fcomplex);
_Fcomplex ccoshf(_Fcomplex);
_Fcomplex csinhf(_Fcomplex);
_Fcomplex ctanhf(_Fcomplex);
_Fcomplex cexpf(_Fcomplex);
_Fcomplex clogf(_Fcomplex);
float cabsf(_Fcomplex);
_Fcomplex cpowf(_Fcomplex, _Fcomplex);
_Fcomplex csqrtf(_Fcomplex);
float cargf(_Fcomplex);
float cimagf(_Fcomplex);
_Fcomplex conjf(_Fcomplex);
_Fcomplex cprojf(_Fcomplex);
float crealf(_Fcomplex);
 
/*
* Long double versions of C99 functions
*/
_Lcomplex cacosl(_Lcomplex);
_Lcomplex casinl(_Lcomplex);
_Lcomplex catanl(_Lcomplex);
_Lcomplex ccosl(_Lcomplex);
_Lcomplex csinl(_Lcomplex);
_Lcomplex ctanl(_Lcomplex);
_Lcomplex cacoshl(_Lcomplex);
_Lcomplex casinhl(_Lcomplex);
_Lcomplex catanhl(_Lcomplex);
_Lcomplex ccoshl(_Lcomplex);
_Lcomplex csinhl(_Lcomplex);
_Lcomplex ctanhl(_Lcomplex);
_Lcomplex cexpl(_Lcomplex);
_Lcomplex clogl(_Lcomplex);
long double cabsl(_Lcomplex);
_Lcomplex cpowl(_Lcomplex,
                          _Lcomplex);
_Lcomplex csqrtl(_Lcomplex);
long double cargl(_Lcomplex);
long double cimagl(_Lcomplex);
_Lcomplex conjl(_Lcomplex);
_Lcomplex cprojl(_Lcomplex);
long double creall(_Lcomplex);
#endif /* !_MSC_BUILD */
 
#endif /* !OPENLIBM_COMPLEX_H */
 
#endif /* OPENLIBM_USE_HOST_COMPLEX_H */