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__sin.html | 235 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 docs/DSP/html/group__sin.html (limited to 'docs/DSP/html/group__sin.html') diff --git a/docs/DSP/html/group__sin.html b/docs/DSP/html/group__sin.html new file mode 100644 index 0000000..4406680 --- /dev/null +++ b/docs/DSP/html/group__sin.html @@ -0,0 +1,235 @@ + + + + + +Sine +CMSIS-DSP: Sine + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.5.2 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Sine
Fast Math Functions
+
+
+ + + + + + + + + + + +

+Functions

float32_t arm_sin_f32 (float32_t x)
 Fast approximation to the trigonometric sine function for floating-point data. More...
 
q15_t arm_sin_q15 (q15_t x)
 Fast approximation to the trigonometric sine function for Q15 data. More...
 
q31_t arm_sin_q31 (q31_t x)
 Fast approximation to the trigonometric sine function for Q31 data. More...
 
+

Description

+

Computes the trigonometric sine function using a combination of table lookup and linear interpolation. There are separate functions for Q15, Q31, and floating-point data types. The input to the floating-point version is in radians and in the range [0 2*pi) while the fixed-point Q15 and Q31 have a scaled input with the range [0 +0.9999] mapping to [0 2*pi). The fixed-point range is chosen so that a value of 2*pi wraps around to 0.

+

The implementation is based on table lookup using 256 values together with linear interpolation. The steps used are:

+
    +
  1. Calculation of the nearest integer table index
    2. +
  2. Compute the fractional portion (fract) of the table index.
    3. +
  3. The final result equals (1.0f-fract)*a + fract*b;
    4. +
+

where

+
+   b=Table[index+0];
+   c=Table[index+1];
+

Function Documentation

+ +
+
+ + + + + + + + +
float32_t arm_sin_f32 (float32_t x)
+
+
Parameters
+ + +
[in]xinput value in radians.
+
+
+
Returns
sin(x).
+ +

References FAST_MATH_TABLE_SIZE, and sinTable_f32.

+ +

Referenced by main().

+ +
+
+ +
+
+ + + + + + + + +
q15_t arm_sin_q15 (q15_t x)
+
+
Parameters
+ + +
[in]xScaled input value in radians.
+
+
+
Returns
sin(x).
+

The Q15 input value is in the range [0 +0.9999] and is mapped to a radian value in the range [0 2*pi).

+ +

References FAST_MATH_Q15_SHIFT, and sinTable_q15.

+ +
+
+ +
+
+ + + + + + + + +
q31_t arm_sin_q31 (q31_t x)
+
+
Parameters
+ + +
[in]xScaled input value in radians.
+
+
+
Returns
sin(x).
+

The Q31 input value is in the range [0 +0.9999] and is mapped to a radian value in the range [0 2*pi).

+ +

References FAST_MATH_Q31_SHIFT, and sinTable_q31.

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