ieee754.h

Go to the documentation of this file.

/*  WFIO - the Wheefun IO Library
    Copyright (C) 2018  Phillip Kilgore

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even t implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
    
    Additionally, you should have recieved a copy of the GNU Classpath 
    exception, which amends the license to generally permit linking against
    the software provided herein.
*/

#ifndef WFIO_IEEE754_H
#define WFIO_IEEE754_H

#include <wfio/type.h>
#include <wfio/byteswap.h>
#include <wfcnfo/float.h>

#ifdef WFIO_DOXYGEN

#define WFIO_IEEE754_NATIVE_B16

#define WFIO_IEEE754_NATIVE_B32

#define WFIO_IEEE754_NATIVE_B64
/* Use WFCNFO to determine native support */
#else
    
#ifdef WFCNFO_IEEE754_NATIVE_B16
#define WFIO_IEEE754_NATIVE_B16
#endif

#ifdef WFCNFO_IEEE754_NATIVE_B32
#define WFIO_IEEE754_NATIVE_B32
#endif

#ifdef WFCNFO_IEEE754_NATIVE_B64
#define WFIO_IEEE754_NATIVE_B64
#endif

#ifdef WFCNFO_FLT_IS_IEEE754
#define WFIO_FLT_IS_IEEE754
#endif
#endif

#if defined(WFIO_IEEE754_NATIVE_B32) && defined(WFIO_IEEE754_NATIVE_B64)

#define WFIO_IEEE754_NATIVE
#endif



#ifdef WFIO_DOXYGEN
#undef WFIO_IEEE754_NATIVE_B16
#undef WFIO_IEEE754_NATIVE_B32
#undef WFIO_IEEE754_NATIVE_B64
#undef WFIO_IEEE754_NATIVE
#else
#define WFIO_MAYBE_INLINE WFIO_DLL
#endif

WFIO_C_BEGIN

typedef union wfio_ieee754_b16_t {
    struct {
        wfio_uint16_t significand:10;
        wfio_uint16_t exponent:5;
        wfio_uint16_t sign:1;
    } bits;
    wfio_sint16_t si;
    
    wfio_uint16_t ui;
    
    #ifdef WFIO_IEEE754_NATIVE_B16
    wfio_flt16_t host_;
    #endif
} wfio_ieee754_b16_t;

typedef union wfio_ieee754_b32_t {
    struct {
        wfio_uint32_t significand:23;
        wfio_uint32_t exponent:8;
        wfio_uint32_t sign:1;
    } bits;
    
    wfio_sint32_t si;
    
    wfio_uint32_t ui;
    
    #ifdef WFIO_IEEE754_NATIVE_B32

    wfio_flt32_t host_;
    #endif
} wfio_ieee754_b32_t;

typedef union wfio_ieee754_b64_t {
    struct {
        wfio_uint64_t significand:52;
        wfio_uint64_t exponent:11;
        wfio_uint64_t sign:1;
    } bits;
    
    wfio_sint64_t si;
    
    wfio_uint64_t ui;
    
    #ifdef WFIO_IEEE754_NATIVE_B64
    wfio_flt64_t host_;
    #endif
} wfio_ieee754_b64_t;

WFIO_C_END

/* Determine how to do transformations in situ */
#ifdef WFIO_FLT_IS_IEEE754
#if WFIO_ENDIAN_HOST_REPORTED==WFIO_ENDIAN_FLT_REPORTED
#define WFIO_IEEE754_SET_(R, X, N) (R).host_ = X
#define WFIO_IEEE754_GET_(X, N) (X).host_

#elif (WFIO_ENDIAN_IS_BIG_ENDIAN | WFIO_ENDIAN_HOST_IS_LIL) == 3
#define WFIO_IEEE754_SET_(R, X, N) (R).si = wfio_swapSI##N((\
    (wfio_ieee754_b##N##_t*) &X)->si) 
#define WFIO_IEEE754_GET_(X, N) wfio_swapSI32((X).si) 
#else
#include <wfio/endian.h>    

#define WFIO_IEEE754_SET_(R, X, N) (R).si = wfio_toHostEndianSI##N((\
    (wfio_ieee754_b##N##_t*) &X)->si, WFIO_ENDIAN_FLT) 
#define WFIO_IEEE754_GET_(X, N) ((X).si = wfio_fromHostEndianSI##N((X).si,\
    WFIO_ENDIAN_FLT), (X).host_)
#endif
#endif

#define WFIO_IEEE754_B32_MIN (wfio_ieee854_b32_t) 0x1

#define WFIO_IEEE754_B32_MAX (wfio_ieee754_b32_t) 0x7EFFFFFF

#define WFIO_IEEE754_B32_INF (wfio_ieee754_b32_t) 0x7F000000

#define WFIO_IEEE754_B32_ENAN (wfio_ieee754_b32_t) 0x7FFFFFFF

WFIO_C_BEGIN

enum {
    WFIO_IEEE754_B32_ENAN_RAW = 0x7FFFFFFF,
    WFIO_IEEE754_B64_ENAN_RAW = 0x7FFFFFFFFFFFFFFF,
};

/* Conversion functions */
#ifdef WFIO_IEEE754_NATIVE_B32
WFIO_ALWAYS_INLINE wfio_ieee754_b32_t wfio_ieee754_toB32(
    wfio_flt32_t host, int* error) {
    register wfio_ieee754_b32_t ret;
    WFIO_IEEE754_SET_(ret, host, 32);
    return ret;
}

WFIO_ALWAYS_INLINE wfio_flt32_t wfio_ieee754_fromB32(
    wfio_ieee754_b32_t ieee, int* error) {
    return WFIO_IEEE754_GET_(ieee, 32);
}
#else

WFIO_MAYBE_INLINE wfio_ieee754_b32_t wfio_ieee754_toB32(wfio_flt32_t host,
    int* error);

WFIO_MAYBE_INLINE wfio_flt32_t wfio_ieee754_fromB32(
    wfio_ieee754_b32_t ieee, int* error);
#endif

WFIO_DLL size_t wfio_ieee754_toB32V2(const wfio_flt32_t* src,
    wfio_ieee754_b32_t* dest, size_t len, int* error);


WFIO_DLL size_t wfio_ieee754_fromB32V2(const wfio_ieee754_b32_t* src,
    wfio_flt32_t* dest, size_t len, int* error);

/* Literal formation */
 
#ifdef WFIO_IEEE754_NATIVE_B64
WFIO_ALWAYS_INLINE wfio_ieee754_b64_t wfio_ieee754_toB64(
    wfio_flt64_t host, int* error) {
    register wfio_ieee754_b64_t ret;
    WFIO_IEEE754_SET_(ret, host, 64);
    return ret;
}

WFIO_ALWAYS_INLINE wfio_flt64_t wfio_ieee754_fromB64(
    wfio_ieee754_b64_t ieee, int* error) {
    return WFIO_IEEE754_GET_(ieee, 64);
}
#else

WFIO_DLL wfio_ieee754_b64_t wfio_ieee754_toB64(wfio_flt64_t host, 
    int* error);

WFIO_MAYBE_INLINE wfio_flt64_t wfio_ieee754_fromB64(wfio_ieee754_b64_t ieee,
    int* error);
#endif


WFIO_DLL size_t wfio_ieee754_toB64V2(const wfio_flt64_t* src,
    wfio_ieee754_b64_t* dest, size_t len, int* error);


WFIO_DLL size_t wfio_ieee754_fromB64V2(const wfio_ieee754_b64_t* src,
    wfio_flt64_t* dest, size_t len, int* error);

#ifdef WFIO_MAYBE_INLINE
#undef WFIO_MAYBE_INLINE
#endif

#ifdef WFIO_FLT_SET_
#undef WFIO_FLT_SET_
#undef WFIO_FLT_GET_
#endif

WFIO_C_END

#endif