Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos discovered by codespell #236

Merged
merged 1 commit into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/Doxygen/src/code_size.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code size {#dsppp_code_size}

It was explained in previous sections that types `Vector<T,NB1>` and `Vector<T,NB2>` are considered as different types if `NB1` and `NB2` are differents.
It was explained in previous sections that types `Vector<T,NB1>` and `Vector<T,NB2>` are considered as different types if `NB1` and `NB2` are different.

A template algorithm is like a code generator that will generate different code for different values of the template arguments : the types.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Doxygen/src/history.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Revision History {#rev_hist}

CMSIS-DSP version is offically updated upon releases of the [CMSIS-DSP pack](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/).
CMSIS-DSP version is officially updated upon releases of the [CMSIS-DSP pack](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/).

The table below provides information about the changes delivered with specific versions of CMSIS-DSP.
4 changes: 2 additions & 2 deletions Documentation/Doxygen/src/mainpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The table below explains the content of **ARM::CMSIS-DSP** pack.
Directory | Description
:--------------------------------------|:------------------------------------------------------
📂 ComputeLibrary | Small Neon kernels when building on Cortex-A
📂 Documentation | Folder with this CMSIS-DSP documenation
📂 Documentation | Folder with this CMSIS-DSP documentation
📂 Example | Example projects demonstrating the usage of the library functions
📂 Include | Include files for using and building the lib
📂 PrivateInclude | Private include files for building the lib
Expand Down Expand Up @@ -163,7 +163,7 @@ All algorithms are compared with a double precision reference and the different

As consequence, the small differences that may exists between the different architecture implementations should be too small to have any practical consequences.

Also, when targetting Helium or Neon, some functions have different APIs.
Also, when targeting Helium or Neon, some functions have different APIs.

### Different API for Helium
* Biquad F32 and F16 : A different init function must be used
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Doxygen/src/matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ In addition to the vector operations `+`,`-` and `*`, matrixes are supporting mo
* `dot` for vector / matrix products
* `diagonal` to create a diagonal matrix from a vector.
* `identity` to create an identity matrix
* `tranpose` to create the transposed matrix
* `transpose` to create the transposed matrix
* `outer` for the outer product of two vectors

### dot
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Doxygen/src/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can then operate with this virtual vector:
subD = subD + 2.0f;
```

If you display the vector `d`, you'll see that `2.0f` has been added to all elements starting from the 2rd one.
If you display the vector `d`, you'll see that `2.0f` has been added to all elements starting from the 2nd one.

`VectorView` do not own their memory. It is owned by the original vector.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

CMSIS-DSP Documentation in HTML format is published online at [https://arm-software.github.io/CMSIS-DSP](https://arm-software.github.io/CMSIS-DSP).

The version drop-down menu there allows to switch between the documentation provided with offical releases and the latest draft documentation for the main branch.
The version drop-down menu there allows to switch between the documentation provided with official releases and the latest draft documentation for the main branch.

The documentation source is maintained in `Documentation/Doxygen/` folder as a mixture of markdown and doxygen formats. Component source files, templates and examples may also contribute information that gets integrated into the final documentation.

Expand Down
2 changes: 1 addition & 1 deletion Examples/ARM/arm_bayes_example/arm_bayes_example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_class_marks_example.ini
INCLUDE arm_class_marks_example.ini

*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_class_marks_example.ini
INCLUDE arm_class_marks_example.ini

*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_convolution_example.ini
INCLUDE arm_convolution_example.ini

*/

Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_convolution_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_dotproduct_example.ini
INCLUDE arm_dotproduct_example.ini

*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ float32_t refDotProdOut = 5.9273644806352142;
* Declare Global variables
* ------------------------------------------------------------------- */
float32_t multOutput[MAX_BLOCKSIZE]; /* Intermediate output */
float32_t testOutput; /* Final ouput */
float32_t testOutput; /* Final output */

arm_status status; /* Status of the example */

Expand Down
2 changes: 1 addition & 1 deletion Examples/ARM/arm_fft_bin_example/arm_fft_bin_example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_fft_bin_example.ini
INCLUDE arm_fft_bin_example.ini

*/

Expand Down
2 changes: 1 addition & 1 deletion Examples/ARM/arm_fir_example/arm_fir_example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_fir_lpf_example.ini
INCLUDE arm_fir_lpf_example.ini

*/

Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_fir_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_geq_5band_example.ini
INCLUDE arm_geq_5band_example.ini

*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
* \par
* \image html GEQ_allbandresponse.gif
* \par
* Each 4th order filter has 10 coefficents for a grand total of 950 different filter
* Each 4th order filter has 10 coefficients for a grand total of 950 different filter
* coefficients that must be tabulated. The input and output data is in Q31 format.
* For better noise performance, the two low frequency bands are implemented using the high
* precision 32x64-bit Biquad filters. The remaining 3 high frequency bands use standard
Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_graphic_equalizer_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_linear_interp_example.ini
INCLUDE arm_linear_interp_example.ini

*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@
*
* \par Block Diagram:
* \par
* \image html linearInterpExampleMethod1.gif "Method 1: Sine caluclation using fast math"
* \image html linearInterpExampleMethod1.gif "Method 1: Sine calculation using fast math"
* \par
* \image html linearInterpExampleMethod2.gif "Method 2: Sine caluclation using interpolation function"
* \image html linearInterpExampleMethod2.gif "Method 2: Sine calculation using interpolation function"
*
* \par Variables Description:
* \par
* \li \c testInputSin_f32 points to the input values for sine calculation
* \li \c testRefSinOutput32_f32 points to the reference values caculated from sin() matlab function
* \li \c testRefSinOutput32_f32 points to the reference values calculated from sin() matlab function
* \li \c testOutput points to output buffer calculation from cubic interpolation
* \li \c testLinIntOutput points to output buffer calculation from linear interpolation
* \li \c snr1 Signal to noise ratio for reference and cubic interpolation output
Expand Down Expand Up @@ -136,7 +136,7 @@ float32_t testLinIntOutput[TEST_LENGTH_SAMPLES];
extern const float arm_linear_interep_table[1884];

/* ----------------------------------------------------------------------
* Global Variables for caluclating SNR's for Method1 & Method 2
* Global Variables for calculating SNR's for Method1 & Method 2
* ------------------------------------------------------------------- */
float32_t snr1;
float32_t snr2;
Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_linear_interp_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
2 changes: 1 addition & 1 deletion Examples/ARM/arm_matrix_example/arm_matrix_example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_matrix_example.ini
INCLUDE arm_matrix_example.ini

*/

Expand Down
6 changes: 3 additions & 3 deletions Examples/ARM/arm_matrix_example/arm_matrix_example_f32.c
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
*
* \par Description:
* \par
* Demonstrates the use of Matrix Transpose, Matrix Muliplication, and Matrix Inverse
* Demonstrates the use of Matrix Transpose, Matrix Multiplication, and Matrix Inverse
* functions to apply least squares fitting to input data. Least squares fitting is
* the procedure for finding the best-fitting curve that minimizes the sum of the
* squares of the offsets (least square error) from a given set of data.
Expand Down Expand Up @@ -96,7 +96,7 @@
#define SNR_THRESHOLD 77

/* --------------------------------------------------------------------------------
* Test input data(Cycles) taken from FIR Q15 module for differant cases of blockSize
* Test input data(Cycles) taken from FIR Q15 module for different cases of blockSize
* and tapSize
* --------------------------------------------------------------------------------- */

Expand Down Expand Up @@ -132,7 +132,7 @@ float32_t ATMAI_f32[16];
float32_t X_f32[4];

/* ----------------------------------------------------------------------
* Reference ouput buffer C1, C2, C3 and C4 taken from MATLAB
* Reference output buffer C1, C2, C3 and C4 taken from MATLAB
* ------------------------------------------------------------------- */
const float32_t xRef_f32[4] = {73.0, 8.0, 21.25, 2.875};

Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_matrix_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_signal_converge_example.ini
INCLUDE arm_signal_converge_example.ini

*/

Expand Down
8 changes: 4 additions & 4 deletions Examples/ARM/arm_signal_converge_example/math_helper.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@
#include "math_helper.h"

/**
* @brief Caluclation of SNR
* @brief Calculation of SNR
* @param[in] pRef Pointer to the reference buffer
* @param[in] pTest Pointer to the test buffer
* @param[in] buffSize total number of samples
* @return SNR
* The function Caluclates signal to noise ratio for the reference output
* The function Calculates signal to noise ratio for the reference output
* and test output
*/

Expand Down Expand Up @@ -258,10 +258,10 @@ void arm_provide_guard_bits_q7 (q7_t * input_buf,


/**
* @brief Caluclates number of guard bits
* @brief Calculates number of guard bits
* @param[in] num_adds number of additions
* @return guard bits
* The function Caluclates the number of guard bits
* The function Calculates the number of guard bits
* depending on the numtaps
*/

Expand Down
2 changes: 1 addition & 1 deletion Examples/ARM/arm_sin_cos_example/arm_sin_cos_example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The file can be executed in the following way:
1) manually from uVision command window (in debug mode) using command:
INCLUIDE arm_sin_cos_example.ini
INCLUDE arm_sin_cos_example.ini

*/

Expand Down
Loading
Loading