math_helpers.h File Reference

#include <math.h>
#include <float.h>
#include <stdint.h>
#include <apitest.h>

Include dependency graph for math_helpers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_TESTENTRY_DBL
struct	_TESTENTRY_FLT
struct	_TESTENTRY_DBL_INT
struct	_TESTENTRY_FLT_INT
struct	_PRECISE_VALUE
struct	_TESTENTRY_DBL_APPROX

Macros
#define	_USE_MATH_DEFINES
#define	__ATTRIBUTE_SSE2__
#define	ok_eq_dbl_exact_(file, line, func, ullx, z, ullexp)
#define	ok_eq_dbl_exact(func, ullx, z, ullexp)   ok_eq_dbl_exact_(__FILE__, __LINE__, func, ullx, z, ullexp)
#define	ok_eq_flt_exact_(file, line, func, ux, z, uexp)
#define	ok_eq_flt_exact(func, ux, z, uexp)   ok_eq_flt_exact_(__FILE__, __LINE__, func, ux, z, uexp)

Typedefs
typedef struct _TESTENTRY_DBL	TESTENTRY_DBL
typedef struct _TESTENTRY_FLT	TESTENTRY_FLT
typedef struct _TESTENTRY_DBL_INT	TESTENTRY_DBL_INT
typedef struct _TESTENTRY_FLT_INT	TESTENTRY_FLT_INT
typedef struct _PRECISE_VALUE	PRECISE_VALUE
typedef struct _TESTENTRY_DBL_APPROX	TESTENTRY_DBL_APPROX

Functions
static __inline double	u64_to_dbl (UINT64 x)
static __inline UINT64	dbl_to_u64 (double x)
static __inline float	u32_to_flt (UINT32 x)
static __inline UINT32	flt_to_u32 (float x)
static int64_t	double_to_int64_lex (double d)
static int	float_to_int_lex (float f)
static __inline int64_t	ulp_error_dbl (double expected, double result)
static __inline int	ulp_error_flt (float expected, float result)
static __inline int64_t	ulp_error_precise (PRECISE_VALUE *expected, double result)

Macro Definition Documentation

__ATTRIBUTE_SSE2__

#define __ATTRIBUTE_SSE2__

Definition at line 19 of file math_helpers.h.

_USE_MATH_DEFINES

#define _USE_MATH_DEFINES

Definition at line 10 of file math_helpers.h.

ok_eq_dbl_exact

#define ok_eq_dbl_exact	(		func,
			ullx,
			z,
			ullexp
	)		ok_eq_dbl_exact_(__FILE__, __LINE__, func, ullx, z, ullexp)

Definition at line 184 of file math_helpers.h.

ok_eq_dbl_exact_

#define ok_eq_dbl_exact_	(		file,
			line,
			func,
			ullx,
			z,
			ullexp
	)

Value:

    { \
        double x = u64_to_dbl(ullx); \
        unsigned long long ullz = dbl_to_u64(z); \
        double exp = u64_to_dbl(ullexp); \
        ok_(file, line)(ullz == ullexp, "Wrong value for '%s(%f)' [0x%016I64x], expected: %f [0x%016I64x], got: %f [0x%016I64x]\n", \
           func, x, ullx, exp, ullexp, z, ullz); \
    }

Definition at line 176 of file math_helpers.h.

ok_eq_flt_exact

#define ok_eq_flt_exact	(		func,
			ux,
			z,
			uexp
	)		ok_eq_flt_exact_(__FILE__, __LINE__, func, ux, z, uexp)

Definition at line 194 of file math_helpers.h.

ok_eq_flt_exact_

#define ok_eq_flt_exact_	(		file,
			line,
			func,
			ux,
			z,
			uexp
	)

Value:

    { \
        float x = u32_to_flt(ux); \
        unsigned int uz = flt_to_u32(z); \
        float exp = u32_to_flt(uexp); \
        ok_(file, line)(uz == uexp, "Wrong value for '%s(%f)' [0x%08x], expected: %f [0x%08x], got: %f [0x%08x]\n", \
           func, x, (unsigned)ux, exp, (unsigned)uexp, z, (unsigned)uz); \
    }

Definition at line 186 of file math_helpers.h.

Typedef Documentation

PRECISE_VALUE

typedef struct _PRECISE_VALUE PRECISE_VALUE

TESTENTRY_DBL

typedef struct _TESTENTRY_DBL TESTENTRY_DBL

TESTENTRY_DBL_APPROX

typedef struct _TESTENTRY_DBL_APPROX TESTENTRY_DBL_APPROX

TESTENTRY_DBL_INT

typedef struct _TESTENTRY_DBL_INT TESTENTRY_DBL_INT

TESTENTRY_FLT

typedef struct _TESTENTRY_FLT TESTENTRY_FLT

TESTENTRY_FLT_INT

typedef struct _TESTENTRY_FLT_INT TESTENTRY_FLT_INT

Function Documentation

dbl_to_u64()

static __inline UINT64 dbl_to_u64 ( double  x )

static

Definition at line 33 of file math_helpers.h.

{
    return *(UINT64*)(&x);
}

double_to_int64_lex()

static int64_t double_to_int64_lex ( double  d )

inlinestatic

Definition at line 92 of file math_helpers.h.

{
    union {
        double d;
        int64_t i;
    } u;
    u.d = d;
    // For negative numbers, flip the ordering.
    if (u.i < 0)
        u.i = 0x8000000000000000LL - u.i;
    return u.i;
}

Referenced by ulp_error_dbl().

float_to_int_lex()

static int float_to_int_lex ( float  f )

inlinestatic

Definition at line 106 of file math_helpers.h.

{
    union {
        float f;
        int i;
    } u;
    u.f = f;
    // For negative numbers, flip the ordering.
    if (u.i < 0)
        u.i = 0x80000000 - u.i;
    return u.i;
}

Referenced by ulp_error_flt().

flt_to_u32()

static __inline UINT32 flt_to_u32 ( float  x )

static

Definition at line 49 of file math_helpers.h.

{
    return *(UINT32*)(&x);
}

u32_to_flt()

static __inline float u32_to_flt ( UINT32  x )

static

Definition at line 41 of file math_helpers.h.

{
    return *(float*)(&x);
}

Referenced by Test__finitef(), Test__isnanf(), Test_ceilf(), Test_fabsf(), Test_floorf(), and Test_roundf().

u64_to_dbl()

static __inline double u64_to_dbl ( UINT64  x )

static

Definition at line 25 of file math_helpers.h.

{
    return *(double*)(&x);
}

Referenced by Test__finite(), Test__isnan(), Test_acos_exact(), Test_acosf_exact(), Test_asin_exact(), Test_asinf_exact(), Test_atan_exact(), Test_atanf_exact(), Test_ceil(), Test_cos_exact(), Test_cosf_exact(), Test_exp_exact(), Test_expf_exact(), Test_fabs(), Test_floor(), Test_log10_exact(), Test_log10f_exact(), Test_log_exact(), Test_logf_exact(), Test_round(), Test_sin_exact(), Test_sinf_exact(), Test_sqrt_exact(), Test_sqrtf_exact(), Test_tan_exact(), and Test_tanf_exact().

ulp_error_dbl()

static __inline int64_t ulp_error_dbl ( double  expected, double  result  )

static

Definition at line 122 of file math_helpers.h.

{
    // Exact equality: error is 0 ULPs.
    if (expected == result)
        return 0;
 
    // If either value is not a number, return a sentinel.
    if (_isnan(expected) || _isnan(result))
        return INT64_MAX;
 
    int64_t i_expected = double_to_int64_lex(expected);
    int64_t i_result   = double_to_int64_lex(result);
 
    return i_result - i_expected;
}

Referenced by ulp_error_precise().

ulp_error_flt()

static __inline int ulp_error_flt ( float  expected, float  result  )

static

Definition at line 138 of file math_helpers.h.

{
    // Exact equality: error is 0 ULPs.
    if (expected == result)
        return 0;
 
    // If either value is not a number, return a sentinel.
    if (_isnan(expected) || _isnan(result))
        return INT_MAX;
 
    int i_expected = float_to_int_lex(expected);
    int i_result   = float_to_int_lex(result);
 
    return i_result - i_expected;
}

Referenced by Test_acosf_approx(), Test_asinf_approx(), Test_atanf_approx(), Test_cosf_approx(), Test_expf_approx(), Test_log10f_approx(), Test_logf_approx(), Test_sinf_approx(), Test_sqrtf_approx(), and Test_tanf_approx().

ulp_error_precise()

static __inline int64_t ulp_error_precise ( PRECISE_VALUE *  expected, double  result  )

static

Definition at line 154 of file math_helpers.h.

{
    // Calculate error to expected rouned value as ULP
    int64_t error = ulp_error_dbl(expected->rounded, result);
    if ((error == INT64_MAX) || (error == 0))
        return error;
 
    // Check if the error has the same sign as the delta
    if ((expected->delta >= 0.0) == (error >= 0))
    {
        // We have an error in the same direction as the delta.
        // This means the error is correct as it is.
        return error;
    }
    else
    {
        // We have an error in the opposite direction of the delta.
        // This means the actual error is larger than the calculated error.
        return (error < 0) ? error - 1 : error + 1;
    }
}

Referenced by Test_acos_approx(), Test_asin_approx(), Test_atan_approx(), Test_cos_approx(), Test_exp_approx(), Test_log10_approx(), Test_log_approx(), Test_sin_approx(), Test_sqrt_approx(), and Test_tan_approx().