double.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_DOUBLE_H
#define _PICO_DOUBLE_H

 
#include "pico.h"
 
// PICO_CONFIG: PICO_DOUBLE_IN_RAM, Force placement of SDK provided double-precision floating point code into RAM, type=bool, default=0, group=pico_double
#ifndef PICO_DOUBLE_IN_RAM
#define PICO_DOUBLE_IN_RAM 0
#endif
 
#if !(LIB_PICO_DOUBLE_COMPILER || defined(__riscv)) || PICO_DOCS
// private define to simplify this header only - it is undefined at the end
#define __PICO_DOUBLE_ARM_OPTIMIZED 1
#endif

 
// we always define these for C code, but they are inline
// funcs except for __PICO_DOUBLE_ARM_OPTIMIZED so wouldn't
// be callable for assembly
#if __PICO_DOUBLE_ARM_OPTIMIZED || !defined(__ASSEMBLER__)
#define PICO_DOUBLE_HAS_INT32_TO_DOUBLE_CONVERSIONS 1
#define PICO_DOUBLE_HAS_INT64_TO_DOUBLE_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_INT32_Z_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_INT64_Z_CONVERSIONS 1
#endif
 
#if __PICO_DOUBLE_ARM_OPTIMIZED
#define PICO_DOUBLE_HAS_FIX32_TO_DOUBLE_CONVERSIONS 1
#define PICO_DOUBLE_HAS_FIX64_TO_DOUBLE_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_FIX32_Z_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_FIX64_Z_CONVERSIONS 1

#define PICO_DOUBLE_HAS_DOUBLE_TO_INT32_M_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_INT64_M_CONVERSIONS 1

#define PICO_DOUBLE_HAS_DOUBLE_TO_FIX32_M_CONVERSIONS 1
#define PICO_DOUBLE_HAS_DOUBLE_TO_FIX64_M_CONVERSIONS 1
#endif
 
#if (PICO_RP2350 && LIB_PICO_DOUBLE_PICO_DCP) || PICO_DOCS
#define PICO_DOUBLE_HAS_DDIV_FAST 1
#define PICO_DOUBLE_HAS_SQRT_FAST 1
#define PICO_DOUBLE_HAS_FMA_FAST 1
#endif
 
#if __PICO_DOUBLE_ARM_OPTIMIZED || __builtin_powi || PICO_DOCS
#define PICO_DOUBLE_HAS_POWINT 1
#endif
 
#ifndef __ASSEMBLER__
#include <math.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#if PICO_DOUBLE_HAS_INT32_TO_DOUBLE_CONVERSIONS
#if !__PICO_DOUBLE_ARM_OPTIMIZED
    // for non Arm-optimized we may as well provide the function and let the compiler handle it
    static inline double int2double(int32_t i) { return (double)i; }
    static inline double uint2double(uint32_t u) { return (double)u; }
#else
    double int2double(int32_t i);
    double uint2double(uint32_t u);
#endif
#endif
 
#if PICO_DOUBLE_HAS_INT64_TO_DOUBLE_CONVERSIONS
#if !__PICO_DOUBLE_ARM_OPTIMIZED
    // for non Arm-optimized we may as well provide the function and let the compiler handle it
    static inline double int642double(int64_t i) { return (double)i; }
    static inline double uint642double(uint64_t u) { return (double)u; }
#else
    double int642double(int64_t i);
    double uint642double(uint64_t u);
#endif
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_INT32_Z_CONVERSIONS
#if !__PICO_DOUBLE_ARM_OPTIMIZED
    // for non Arm-optimized we may as well provide the function and let the compiler handle it
    static inline int32_t double2int_z(double d) { return (int32_t)d; }
    static inline uint32_t double2uint_z(double d) { return (uint32_t)d; }
#else
    int32_t double2int_z(double d);
    uint32_t double2uint_z(double d);
#endif
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_INT64_Z_CONVERSIONS
#if !__PICO_DOUBLE_ARM_OPTIMIZED
    // for non Arm-optimized we may as well provide the function and let the compiler handle it
    static inline int64_t double2int64_z(double d) { return (int64_t)d; }
    static inline uint64_t double2uint64_z(double d) { return (uint64_t)d; }
#else
    int64_t double2int64_z(double d);
    uint64_t double2uint64_z(double d);
#endif
#endif
 
#if PICO_DOUBLE_HAS_FIX32_TO_DOUBLE_CONVERSIONS
double fix2double(int32_t m, int e);
double ufix2double(uint32_t m, int e);
#endif
 
#if PICO_DOUBLE_HAS_FIX64_TO_DOUBLE_CONVERSIONS
double fix642double(int64_t m, int e);
double ufix642double(uint64_t m, int e);
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_FIX32_Z_CONVERSIONS
int32_t double2fix_z(double d, int e);
uint32_t double2ufix_z(double d, int e);
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_FIX64_Z_CONVERSIONS
int64_t double2fix64_z(double d, int e);
uint64_t double2ufix64_z(double d, int e);
#endif
 
// These methods round towards -Infinity - which IS NOT the C way for negative numbers;
// as such the naming is not ideal, however is kept for backwards compatibility
#if PICO_DOUBLE_HAS_DOUBLE_TO_INT32_M_CONVERSIONS
int32_t double2int(double d);
uint32_t double2uint(double d);
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_INT64_M_CONVERSIONS
int64_t double2int64(double d);
uint64_t double2uint64(double d);
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_FIX32_M_CONVERSIONS
int32_t double2fix(double d, int e);
uint32_t double2ufix(double d, int e);
#endif
 
#if PICO_DOUBLE_HAS_DOUBLE_TO_FIX64_M_CONVERSIONS
int64_t double2fix64(double d, int e);
uint64_t double2ufix64(double d, int e);
#endif
 
    // exp10 doesn't always appear in math.h but is present on all our platforms even for LIB_PICO_DOUBLE_COMPILER
    // so we declare it here always

    double exp10(double x);
 
    // sincos doesn't always appear in math.h but is present on all our platforms even for LIB_PICO_DOUBLE_COMPILER
    // so we declare it here always
#if __PICO_DOUBLE_ARM_OPTIMIZED && PICO_C_COMPILER_IS_CLANG
    // clang unhelpfully splits sincos into explict calls to sin & cos
    extern void WRAPPER_FUNC(sincos)(double x, double *sinx, double *cosx);
    #define sincos(x, sinx, cosx) WRAPPER_FUNC(sincos)(x, sinx, cosx)
#else
    void sincos(double x, double *sinx, double *cosx);
#endif
 
#if PICO_DOUBLE_HAS_POWINT
#if !__PICO_DOUBLE_ARM_OPTIMIZED && __has_builtin(__builtin_powi)
    static __force_inline double powint(double d, int32_t p) {
        return __builtin_powi(d, p);
    }
#else
    double powint(double x, int32_t y);
#endif
#endif
 
#if PICO_DOUBLE_HAS_DDIV_FAST
double ddiv_fast(double n, double d);
#endif
 
#if PICO_DOUBLE_HAS_SQRT_FAST
double sqrt_fast(double d);
#endif
 
#if PICO_DOUBLE_HAS_FMA_FAST
double fma_fast(double x, double y, double z);
double mla(double x, double y, double z); // another name for fma_fast
#endif
 
#undef __PICO_DOUBLE_ARM_OPTIMIZED
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif