From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- docs/DSP/html/group__SQRT.html | 283 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 283 insertions(+) create mode 100644 docs/DSP/html/group__SQRT.html (limited to 'docs/DSP/html/group__SQRT.html') diff --git a/docs/DSP/html/group__SQRT.html b/docs/DSP/html/group__SQRT.html new file mode 100644 index 0000000..3b9b605 --- /dev/null +++ b/docs/DSP/html/group__SQRT.html @@ -0,0 +1,283 @@ + + + + + +Square Root +CMSIS-DSP: Square Root + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.5.2 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Square Root
Fast Math Functions
+
+
+ + + + + + + + + + + +

+Functions

CMSIS_INLINE __STATIC_INLINE
+arm_status 		arm_sqrt_f32 (float32_t in, float32_t *pOut)
 Floating-point square root function. More...
 
arm_status arm_sqrt_q31 (q31_t in, q31_t *pOut)
 Q31 square root function. More...
 
arm_status arm_sqrt_q15 (q15_t in, q15_t *pOut)
 Q15 square root function. More...
 
+

Description

+

Computes the square root of a number. There are separate functions for Q15, Q31, and floating-point data types. The square root function is computed using the Newton-Raphson algorithm. This is an iterative algorithm of the form:

+
+     x1 = x0 - f(x0)/f'(x0)
+

where x1 is the current estimate, x0 is the previous estimate, and f'(x0) is the derivative of f() evaluated at x0. For the square root function, the algorithm reduces to:

+
+    x0 = in/2                         [initial guess]
+    x1 = 1/2 * ( x0 + in / x0)        [each iteration]
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
CMSIS_INLINE __STATIC_INLINE arm_status arm_sqrt_f32 (float32_t in,
float32_t * pOut 
)
+
+
Parameters
+ + + +
[in]ininput value.
[out]pOutsquare root of input value.
+
+
+
Returns
The function returns ARM_MATH_SUCCESS if input value is positive value or ARM_MATH_ARGUMENT_ERROR if in is negative value and returns zero output for negative values.
+ +

References ARM_MATH_ARGUMENT_ERROR, and ARM_MATH_SUCCESS.

+ +

Referenced by arm_cmplx_mag_f32(), arm_rms_f32(), and arm_std_f32().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
arm_status arm_sqrt_q15 (q15_t in,
q15_t * pOut 
)
+
+
Parameters
+ + + +
[in]ininput value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF.
[out]pOutsquare root of input value.
+
+
+
Returns
The function returns ARM_MATH_SUCCESS if input value is positive value or ARM_MATH_ARGUMENT_ERROR if in is negative value and returns zero output for negative values.
+
Parameters
+ + + +
[in]ininput value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF.
[out]*pOutsquare root of input value.
+
+
+
Returns
The function returns ARM_MATH_SUCCESS if the input value is positive and ARM_MATH_ARGUMENT_ERROR if the input is negative. For negative inputs, the function returns *pOut = 0.
+ +

References ARM_MATH_ARGUMENT_ERROR, and ARM_MATH_SUCCESS.

+ +

Referenced by arm_cmplx_mag_q15(), arm_rms_q15(), and arm_std_q15().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
arm_status arm_sqrt_q31 (q31_t in,
q31_t * pOut 
)
+
+
Parameters
+ + + +
[in]ininput value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF.
[out]pOutsquare root of input value.
+
+
+
Returns
The function returns ARM_MATH_SUCCESS if input value is positive value or ARM_MATH_ARGUMENT_ERROR if in is negative value and returns zero output for negative values.
+
Parameters
+ + + +
[in]ininput value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF.
[out]*pOutsquare root of input value.
+
+
+
Returns
The function returns ARM_MATH_SUCCESS if the input value is positive and ARM_MATH_ARGUMENT_ERROR if the input is negative. For negative inputs, the function returns *pOut = 0.
+ +

References ARM_MATH_ARGUMENT_ERROR, and ARM_MATH_SUCCESS.

+ +

Referenced by arm_cmplx_mag_q31(), arm_rms_q31(), and arm_std_q31().

+ +
+
+
+
+ + + + -- cgit