From 96d6da4e252b06dcfdc041e7df23e86161c33007 Mon Sep 17 00:00:00 2001 From: rihab kouki Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- docs/DSP/html/group__SQRT.html | 171 ++++++++++++++++++++++++++++++++--------- 1 file changed, 133 insertions(+), 38 deletions(-) (limited to 'docs/DSP/html/group__SQRT.html') diff --git a/docs/DSP/html/group__SQRT.html b/docs/DSP/html/group__SQRT.html index 3b9b605..fb4f8f3 100644 --- a/docs/DSP/html/group__SQRT.html +++ b/docs/DSP/html/group__SQRT.html @@ -32,7 +32,7 @@ Logo

CMSIS-DSP - Version 1.5.2 + Version 1.7.0

CMSIS DSP Software Library

@@ -116,16 +116,22 @@ $(document).ready(function(){initNavTree('group__SQRT.html','');}); - - - + + + + + + + + + +

Functions
CMSIS_INLINE __STATIC_INLINE -arm_status	arm_sqrt_f32 (float32_t in, float32_t *pOut)
	Floating-point square root function. More...

__STATIC_FORCEINLINE 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...

void	arm_vsqrt_f32 (float32_t pIn, float32_t pOut, uint16_t len)
	Vector Floating-point square root function. More...

void	arm_vsqrt_q31 (q31_t pIn, q31_t pOut, uint16_t len)

void	arm_vsqrt_q15 (q15_t pIn, q15_t pOut, uint16_t len)

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:

@@ -136,12 +142,12 @@ Functions x0 = in/2 [initial guess] x1 = 1/2 * ( x0 + in / x0) [each iteration]

Function Documentation

- +

- + @@ -161,16 +167,16 @@ Functions

Parameters

CMSIS_INLINE __STATIC_INLINE arm_status arm_sqrt_f32 __STATIC_FORCEINLINE arm_status arm_sqrt_f32 ( float32_t in,

- - + +

[in]	in	input value.
[out]	pOut	square root of input value.
[in]	in	input value
[out]	pOut	square 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().

Returns

execution status

ARM_MATH_SUCCESS : input value is positive
ARM_MATH_ARGUMENT_ERROR : input value is negative; *pOut is set to 0

@@ -199,24 +205,16 @@ Functions

Parameters

- - + +

[in]	in	input value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF.
[out]	pOut	square root of input value.
[in]	in	input value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF
[out]	pOut	points to square 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]	in	input value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF.
[out]	*pOut	square 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().

Returns

execution status

ARM_MATH_SUCCESS : input value is positive
ARM_MATH_ARGUMENT_ERROR : input value is negative; *pOut is set to 0

@@ -245,24 +243,121 @@ Functions

Parameters

- - + +

[in]	in	input value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF.
[out]	pOut	square root of input value.
[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: 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.

Returns

execution status

ARM_MATH_SUCCESS : input value is positive
ARM_MATH_ARGUMENT_ERROR : input value is negative; *pOut is set to 0

+ +

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + +

void arm_vsqrt_f32	(	float32_t *	pIn,
		float32_t *	pOut,
		uint16_t	len
	)

Parameters

- - + + +

[in]	in	input value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF.
[out]	*pOut	square root of input value.
[in]	pIn	input vector.
[out]	pOut	vector of square roots of input elements.
[in]	len	length of input vector.

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.

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.

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +

void arm_vsqrt_q15	(	q15_t *	pIn,
		q15_t *	pOut,
		uint16_t	len
	)

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

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +

void arm_vsqrt_q31	(	q31_t *	pIn,
		q31_t *	pOut,
		uint16_t	len
	)

@@ -271,7 +366,7 @@ Functions