fp_def.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef FP_DEF_H
#define FP_DEF_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @defgroup    argus_fp Fixed Point Math
 * @ingroup     argus_util
 *
 * @brief       A basic math library for fixed point number in the Qx.y fomat.
 *
 * @details     This module contains common fixed point type definitions as
 *              well as some basic math algorithms. All types are based on
 *              integer types. The number are defined with the Q number format.
 *
 *               - For a description of the Q number format refer to:
 *                  https://en.wikipedia.org/wiki/Q_(number_format)
 *               - Another resource for fixed point math in C might be found at
 *                  http://www.eetimes.com/author.asp?section_id=36&doc_id=1287491
 *               .
 *
 * @warning     This definitions are not portable and work only with
 *              little-endian systems!
 *
 * @addtogroup  argus_fp
 * @{
 *****************************************************************************/
 
#include <stdint.h>
 
/*******************************************************************************
 *****   Unsigned 8-Bit Values   ***********************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** UQ6.2
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ6.2
 * @details An unsigned fixed point number format based on the 8-bit unsigned
 *          integer type with 6 integer and 2 fractional bits.
 *          - Range: 0 .. 63.75
 *          - Granularity: 0.25
 *****************************************************************************/
typedef uint8_t uq6_2_t;
 
#define UQ6_2_MAX ((uq6_2_t)UINT8_MAX)
 
#define UQ6_2_ONE ((uq6_2_t)(1U<<2U))
 
 
 
/*******************************************************************************
 ***** UQ4.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ4.4
 * @details An unsigned fixed point number format based on the 8-bit unsigned
 *          integer type with 4 integer and 4 fractional bits.
 *          - Range: 0 .. 15.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef uint8_t uq4_4_t;
 
#define UQ4_4_MAX ((uq4_4_t)UINT8_MAX)
 
#define UQ4_4_ONE ((uq4_4_t)(1U<<4U))
 
 
 
/*******************************************************************************
 ***** UQ2.6
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ2.6
 * @details An unsigned fixed point number format based on the 8-bit unsigned
 *          integer type with 2 integer and 6 fractional bits.
 *          - Range: 0 .. 3.984375
 *          - Granularity: 0.015625
 *****************************************************************************/
typedef uint8_t uq2_6_t;
 
#define UQ2_6_MAX ((uq2_6_t)UINT8_MAX)
 
#define UQ2_6_ONE ((uq2_6_t)(1U<<6U))
 
 
 
/*******************************************************************************
 ***** UQ1.7
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ1.7
 * @details An unsigned fixed point number format based on the 8-bit unsigned
 *          integer type with 1 integer and 7 fractional bits.
 *          - Range: 0 .. 1.9921875
 *          - Granularity: 0.0078125
 *****************************************************************************/
typedef uint8_t uq1_7_t;
 
#define UQ1_7_MAX ((uq1_7_t)UINT8_MAX)
 
#define UQ1_7_ONE ((uq1_7_t)(1U<<7U))
 
 
 
/*******************************************************************************
 ***** UQ0.8
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ0.8
 * @details An unsigned fixed point number format based on the 8-bit unsigned
 *          integer type with 1 integer and 7 fractional bits.
 *          - Range: 0 .. 0.99609375
 *          - Granularity: 0.00390625
 *****************************************************************************/
typedef uint8_t uq0_8_t;
 
#define UQ0_8_MAX ((uq0_8_t)UINT8_MAX)
 
 
 
/*******************************************************************************
 *****   Signed 8-Bit Values   *************************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** Q3.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q3.4
 * @details A signed fixed point number format based on the 8-bit signed
 *          integer type with 3 integer and 4 fractional bits.
 *          - Range: -8 ... 7.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef int8_t q3_4_t;
 
#define Q3_4_MIN ((q3_4_t)INT8_MIN)
 
#define Q3_4_MAX ((q3_4_t)INT8_MAX)
 
#define UQ3_4_ONE ((q3_4_t)(1 << 4))
 
 
/*******************************************************************************
 ***** Q1.6
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q1.6
 * @details A signed fixed point number format based on the 8-bit signed
 *          integer type with 1 integer and 6 fractional bits.
 *          - Range: -2 ... 1.984375
 *          - Granularity: 0.015625
 *****************************************************************************/
typedef int8_t q1_6_t;
 
#define Q1_6_MIN ((q1_6_t)INT8_MIN)
 
#define Q1_6_MAX ((q1_6_t)INT8_MAX)
 
#define UQ1_6_ONE ((q1_6_t)(1 << 4))
 
 
/*******************************************************************************
 *****   Unsigned 16-Bit Values   **********************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** UQ12.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ12.4
 * @details An unsigned fixed point number format based on the 16-bit unsigned
 *          integer type with 12 integer and 4 fractional bits.
 *          - Range: 0 ... 4095.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef uint16_t uq12_4_t;
 
#define UQ12_4_MAX ((uq12_4_t)UINT16_MAX)
 
#define UQ12_4_ONE ((uq12_4_t)(1U<<4U))
 
 
 
/*******************************************************************************
 ***** UQ10.6
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ10.6
 * @details An unsigned fixed point number format based on the 16-bit unsigned
 *          integer type with 10 integer and 6 fractional bits.
 *          - Range: 0 ... 1023.984375
 *          - Granularity: 0.015625
 *****************************************************************************/
typedef uint16_t uq10_6_t;
 
#define UQ10_6_MAX ((uq10_6_t)UINT16_MAX)
 
#define UQ10_6_ONE ((uq10_6_t)(1U << 6U))
 
 
 
/*******************************************************************************
 ***** UQ1.15
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ1.15
 * @details An unsigned fixed point number format based on the 16-bit unsigned
 *          integer type with 1 integer and 15 fractional bits.
 *          - Range: 0 .. 1.999969
 *          - Granularity: 0.000031
 *****************************************************************************/
typedef uint16_t uq1_15_t;
 
#define UQ1_15_MAX ((uq1_15_t)UINT16_MAX)
 
#define UQ1_15_ONE ((uq1_15_t)(1U << 15U))
 
 
 
/*******************************************************************************
 ***** UQ0.16
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ0.16
 * @details An unsigned fixed point number format based on the 16-bit unsigned
 *          integer type with 0 integer and 16 fractional bits.
 *          - Range: 0 .. 0.9999847412109375
 *          - Granularity: 1.52587890625e-5
 *****************************************************************************/
typedef uint16_t uq0_16_t;
 
#define UQ0_16_MAX ((uq0_16_t)UINT16_MAX)
 
 
 
/*******************************************************************************
 *****   Signed 16-Bit Values   ************************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** Q11.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q11.4
 * @details A signed fixed point number format based on the 16-bit signed
 *          integer type with 11 integer and 4 fractional bits.
 *          - Range: -2048 ... 2047.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef int16_t q11_4_t;
 
#define Q11_4_MIN ((q11_4_t)INT16_MIN)
 
#define Q11_4_MAX ((q11_4_t)INT16_MAX)
 
#define Q11_4_ONE ((q11_4_t)(1 << 4))
 
 
 
/*******************************************************************************
 ***** Q7.8
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q7.8
 * @details A signed fixed point number format based on the 16-bit signed
 *          integer type with 7 integer and 8 fractional bits.
 *          - Range: -128 .. 127.99609375
 *          - Granularity: 0.00390625
 *****************************************************************************/
typedef int16_t q7_8_t;
 
#define Q7_8_MIN ((q7_8_t)INT16_MIN)
 
#define Q7_8_MAX ((q7_8_t)INT16_MAX)
 
#define Q7_8_ONE ((q7_8_t)(1 << 8))
 
 
 
/*******************************************************************************
 ***** Q3.12
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q3.12
 * @details A signed fixed point number format based on the 16-bit integer
 *          type with 3 integer and 12 fractional bits.
 *          - Range: -8 .. 7.99975586
 *          - Granularity: 0.00024414
 *****************************************************************************/
typedef int16_t q3_12_t;
 
#define Q3_12_MIN ((q3_12_t)INT16_MIN)
 
#define Q3_12_MAX ((q3_12_t)INT16_MAX)
 
#define Q3_12_ONE ((q3_12_t)(1 << 12))
 
 
 
/*******************************************************************************
 ***** Q0.15
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q0.15
 * @details A signed fixed point number format based on the 16-bit integer
 *          type with 0 integer and 15 fractional bits.
 *          - Range: -1 .. 0.999969482
 *          - Granularity: 0.000030518
 *****************************************************************************/
typedef int16_t q0_15_t;
 
#define Q0_15_MIN ((q0_15_t)INT16_MIN)
 
#define Q0_15_MAX ((q0_15_t)INT16_MAX)
 
 
 
/*******************************************************************************
 *****   Unsigned 32-Bit Values   **********************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** UQ28.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ28.4
 * @details An unsigned fixed point number format based on the 32-bit unsigned
 *          integer type with 28 integer and 4 fractional bits.
 *          - Range: 0 ... 268435455.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef uint32_t uq28_4_t;
 
#define UQ28_4_MAX ((uq28_4_t)UINT32_MAX)
 
#define UQ28_4_ONE ((uq28_4_t)(1U<<4U))
 
 
 
/*******************************************************************************
 ***** UQ16.16
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ16.16
 * @details An unsigned fixed point number format based on the 32-bit unsigned
 *          integer type with 16 integer and 16 fractional bits.
 *          - Range: 0 ... 65535.999984741
 *          - Granularity: 0.000015259
 *****************************************************************************/
typedef uint32_t uq16_16_t;
 
#define UQ16_16_MAX ((uq16_16_t)UINT32_MAX)
 
#define UQ16_16_ONE ((uq16_16_t)(1U << 16U))
 
#define UQ16_16_E (0x2B7E1U)
 
 
 
/*******************************************************************************
 ***** UQ10.22
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Unsigned fixed point number: UQ10.22
 * @details An unsigned fixed point number format based on the 32-bit unsigned
 *          integer type with 10 integer and 22 fractional bits.
 *          - Range: 0 ... 1023.99999976158
 *          - Granularity: 2.38418579101562E-07
 *****************************************************************************/
typedef uint32_t uq10_22_t;
 
#define UQ10_22_MAX ((uq10_22_t)UINT32_MAX)
 
#define UQ10_22_ONE ((uq10_22_t)(1U << 22U))
 
 
 
/*******************************************************************************
 *****   Signed 32-Bit Values   ************************************************
 ******************************************************************************/
 
/*******************************************************************************
 ***** Q27.4
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q27.4
 * @details A signed fixed point number format based on the 32-bit signed
 *          integer type with 27 integer and 4 fractional bits.
 *          - Range: -134217728 ... 134217727.9375
 *          - Granularity: 0.0625
 *****************************************************************************/
typedef int32_t q27_4_t;
 
#define Q27_4_MIN ((q27_4_t)INT32_MIN)
 
#define Q27_4_MAX ((q27_4_t)INT32_MAX)
 
#define UQ27_4_ONE ((q27_4_t)(1 << 4))
 
 
 
/*******************************************************************************
 ***** Q16.15
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q16.15
 * @details A signed fixed point number format based on the 32-bit integer
 *          type with 16 integer and 15 fractional bits.
 *          - Range: -65536 .. 65536.999969482
 *          - Granularity: 0.000030518
 *****************************************************************************/
typedef int32_t q16_15_t;
 
#define Q16_15_MIN ((q16_15_t)INT32_MIN)
 
#define Q16_15_MAX ((q16_15_t)INT32_MAX)
 
 
 
/*******************************************************************************
 ***** Q15.16
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q15.16
 * @details A signed fixed point number format based on the 32-bit integer
 *          type with 15 integer and 16 fractional bits.
 *          - Range: -32768 .. 32767.99998
 *          - Granularity: 1.52588E-05
 *****************************************************************************/
typedef int32_t q15_16_t;
 
#define Q15_16_MIN ((q15_16_t)INT32_MIN)
 
#define Q15_16_MAX ((q15_16_t)INT32_MAX)
 
#define Q15_16_ONE ((q15_16_t)(1 << 16))
 
 
 
/*******************************************************************************
 ***** Q9.22
 ******************************************************************************/
/*!***************************************************************************
 * @brief   Signed fixed point number: Q9.22
 * @details A signed fixed point number format based on the 32-bit integer
 *          type with 9 integer and 22 fractional bits.
 *          - Range: -512 ... 511.9999998
 *          - Granularity: 2.38418579101562E-07
 *****************************************************************************/
typedef int32_t q9_22_t;
 
#define Q9_22_MIN ((q9_22_t)INT32_MIN)
 
#define Q9_22_MAX ((q9_22_t)INT32_MAX)
 
#define Q9_22_ONE ((q9_22_t)(1 << 22))
 
 
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* FP_DEF_H */