Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Library Configuration

## Configuration Options

group config_options

  Defines

  XMATH_BFP_DEBUG_CHECK_LENGTHS

    Indicates whether the BFP functions should check vector lengths for errors.

    Iff true, BFP functions will check (`assert()`) to ensure that each BFP vector argument does not violate any length constraints. Most often this simply ensures that, where BFP functions take multiple vectors as parameters, each of the vectors has the same length.

    Defaults to false (`0`).

  XMATH_BFP_SQRT_DEPTH_S16

    The number of most significant bits which are computed by bfp_s16_sqrt().

    The function bfp_sqrt_s16() computes results one bit at a time, starting with bit 14 (the second-to-most significant bit). Because this is a relatively expensive operation, it may be desirable to trade off precision of results for a speed-up.

    The time cost of bfp_sqrt_s16() is approximately linear with respect to the depth.

    Defaults to `VECT_SQRT_S16_MAX_DEPTH` (15)

    See also

    bfp_s16_sqrt

  XMATH_BFP_SQRT_DEPTH_S32

    The number of most significant bits which are computed by bfp_s32_sqrt().

    The function bfp_sqrt_s32() computes results one bit at a time, starting with bit 30 (the second-to-most significant bit). Because this is a relatively expensive operation, it may be desirable to trade off precision of results for a speed-up.

    The time cost of bfp_sqrt_s32() is approximately linear with respect to the depth.

    Defaults to `VECT_SQRT_S32_MAX_DEPTH` (31)

    See also

    bfp_s32_sqrt

  XMATH_MALLOC

    Function used to dynamically allocate memory.

    This function is used to dynamically allocate memory. Defaults to `malloc`. Must have same signature as `malloc()`

    See also

    XMATH_FREE

  XMATH_FREE

    Function use to free dynamically allocated memory.

    This function is used to deallocate dynamically allocated memory. Defaults to `free`. Must have same signature as `free()`

    See also

    XMATH_MALLOC