%% options copyright owner = Dirk Krause copyright year = 2016-xxxx SPDX-License-Identifier: BSD-3-Clause %% header /** @file dk4fpe.h Floating point exceptions. Note: When using functions from this module you should use the compiler pragma to grant access to the floating point environment. This disables optimization of floating point operations. The availability and the exact form of the pragma depends on your compiler. * pragma STDC FENV_ACCESS ON SUN workshop compiler. Probably other Unix/Linux compilers. * pragma fenv_access (on) Visual Studio on Windows. In version 4.13.1 and above the pragma is no longer included in this header file as you probably want to apply it to some code sections of a file only. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #if DK4_HAVE_MATH_H #ifndef MATH_H_INCLUDED #if DK4_ON_WINDOWS #ifndef _USE_MATH_DEFINES #define _USE_MATH_DEFINES 1 #endif #endif #include #define MATH_H_INCLUDED 1 #endif #endif #if DK4_HAVE_FLOAT_H #ifndef FLOAT_H_INCLUDED #include #define FLOAT_H_INCLUDED 1 #endif #endif #if DK4_HAVE_FENV_H #ifndef FENV_H_INCLUDED #include #define FENV_H_INCLUDED 1 #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #if _WIN32 && defined(_MSC_VER) /** Floating point exception set. */ typedef unsigned int dk4_fpe_t; #else /** Floating point exception set. */ typedef int dk4_fpe_t; #endif #ifdef __cplusplus extern "C" { #endif /** Check floating point exception set for errors occured. @param fpe Floating point exception set. @param erp Error report, may be NULL. @return 1 if error exceptions are set, 0 if there is no error condition. Error codes: * DK4_E_MATH_INVALID
if an invalid operation was performed, * DK4_E_MATH_DIVZERO
if a division by zero (or small denominator) occured, * DK4_E_MATH_OVERFLOW
if a range overflow occured (result too large), * DK4_E_MATH_UNDERFLOW
if a range underflow occured (result too small). */ int dk4fpe_check_error(dk4_fpe_t fpe, dk4_er_t *erp); /** Clear floating point exceptions. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: * DK4_E_NOT_SUPPORTED
if no functions for floating point exceptions are available, * DK4_E_SYSTEM
if the feclearexcept() function indicated an error. */ int dk4fpe_clear(dk4_er_t *erp); /** Obtain floating point exceptions. @param dptr Address of destination variable to store result. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: * DK4_E_INVALID_ARGUMENTS
if dptr is NULL, * DK4_E_NOT_SUPPORTED
if no functions for floating point exceptions are available. */ int dk4fpe_get(dk4_fpe_t *dptr, dk4_er_t *erp); /** Obtain and clear floating point exceptions. @param dptr Address of destination variable to store result. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: * DK4_E_INVALID_ARGUMENTS
if dptr is NULL, * DK4_E_NOT_SUPPORTED
if no functions for floating point exceptions are available, * DK4_E_SYSTEM
if the feclearexcept() function indicated an error. */ int dk4fpe_get_clear(dk4_fpe_t *dptr, dk4_er_t *erp); #ifdef __cplusplus } #endif %% module #include "dk4conf.h" #if DK4_HAVE_ASSERT_H #ifndef ASSERT_H_INCLUDED #include #define ASSERT_H_INCLUDED 1 #endif #endif #include "dk4fpe.h" #if _WIN32 && defined(_MSC_VER) /** Exception set for errors. */ static const unsigned int dk4fpe_errors = _SW_ZERODIVIDE | _SW_INVALID | _SW_OVERFLOW | _SW_UNDERFLOW; #else /** Exception set for errors. */ static const int dk4fpe_errors = FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW | FE_UNDERFLOW; #endif int dk4fpe_check_error(dk4_fpe_t fpe, dk4_er_t *erp) { int back = 0; if ((dk4_fpe_t)0 != (dk4fpe_errors & fpe)) { back = 1; #if _WIN32 && defined(_MSC_VER) if ((dk4_fpe_t)0 != (_SW_INVALID & fpe)) #else if ((dk4_fpe_t)0 != (FE_INVALID & fpe)) #endif { dk4error_set_simple_error_code(erp, DK4_E_MATH_INVALID); } else { #if _WIN32 && defined(_MSC_VER) if ((dk4_fpe_t)0 != (_SW_ZERODIVIDE & fpe)) #else if ((dk4_fpe_t)0 != (FE_DIVBYZERO & fpe)) #endif { dk4error_set_simple_error_code(erp, DK4_E_MATH_DIVZERO); } else { #if _WIN32 && defined(_MSC_VER) if ((dk4_fpe_t)0 != (_SW_OVERFLOW & fpe)) #else if ((dk4_fpe_t)0 != (FE_OVERFLOW & fpe)) #endif { dk4error_set_simple_error_code(erp, DK4_E_MATH_OVERFLOW); } else { #if _WIN32 && defined(_MSC_VER) if ((dk4_fpe_t)0 != (_SW_UNDERFLOW & fpe)) #else if ((dk4_fpe_t)0 != (FE_UNDERFLOW & fpe)) #endif { dk4error_set_simple_error_code(erp, DK4_E_MATH_UNDERFLOW); } } } } } return back; } int dk4fpe_clear(dk4_er_t *erp) { #if _WIN32 && defined(_MSC_VER) _clearfp(); return 1; #else #if DK4_HAVE_FETESTEXCEPT int back = 0; if (0 == feclearexcept(FE_ALL_EXCEPT)) { back = 1; } else { dk4error_set_simple_error_code(erp, DK4_E_SYSTEM); } return back; #else dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED); return 0; #endif #endif } int dk4fpe_get(dk4_fpe_t *dptr, dk4_er_t *erp) { int back = 0; #if DK4_USE_ASSERT assert(NULL != dptr); #endif if (NULL != dptr) { #if _WIN32 && defined(_MSC_VER) *dptr = (dk4_fpe_t)_statusfp(); back = 1; #else #if DK4_HAVE_FETESTEXCEPT *dptr = (dk4_fpe_t)fetestexcept(FE_ALL_EXCEPT); back = 1; #else dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED); #endif #endif } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4fpe_get_clear(dk4_fpe_t *dptr, dk4_er_t *erp) { int back = 0; #if DK4_USE_ASSERT assert(NULL != dptr); #endif if (NULL != dptr) { #if _WIN32 && defined(_MSC_VER) *dptr = _clearfp(); back = 1; #else #if DK4_HAVE_FETESTEXCEPT *dptr = (dk4_fpe_t)fetestexcept(FE_ALL_EXCEPT); if (0 == feclearexcept(FE_ALL_EXCEPT)) { back = 1; } else { dk4error_set_simple_error_code(erp, DK4_E_SYSTEM); } #else dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED); #endif #endif } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; }