1.7.2.4 mchp_sqrt_q31()

mchp_status mchp_sqrt_q31 (q31_t in, q31_t * pOut)

Q31 square root function.

Parameters:
in in

input value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF.

out pOut

points to square root of input value.

Returns:
execution status

  • MCHP_MATH_SUCCESS : input value is positive

  • MCHP_MATH_ARGUMENT_ERROR : input value is negative; *pOut is set to 0