Update documentation for branch main

ARM-software · Dec 9, 2024 · f919bbc · f919bbc
1 parent 6a6c461
commit f919bbc
Show file tree

Hide file tree

Showing 106 changed files with 4,143 additions and 6,106 deletions.
diff --git a/main/DCT4.gif b/main/DCT4.gif
diff --git a/main/annotated.html b/main/annotated.html
diff --git a/main/annotated_dup.js b/main/annotated_dup.js
diff --git a/main/arm_convolution_example_f32_8c-example.html b/main/arm_convolution_example_f32_8c-example.html
@@ -263,7 +263,7 @@
 <div class="line"> </div>
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;                           <span class="comment">/* Status of the example */</span></div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;                           <span class="comment">/* Status of the example */</span></div>
 <div class="line">  <a id="_a0" name="_a0"></a><a class="code hl_struct" href="structarm__cfft__radix4__instance__f32.html" title="Instance structure for the floating-point CFFT/CIFFT function.">arm_cfft_radix4_instance_f32</a> cfft_instance;  <span class="comment">/* CFFT Structure instance */</span></div>
 <div class="line"> </div>
 <div class="line"><span class="preprocessor">#if defined(SEMIHOSTING)</span></div>

diff --git a/main/arm_dotproduct_example_f32_8c-example.html b/main/arm_dotproduct_example_f32_8c-example.html
@@ -233,7 +233,7 @@
 <div class="line"><a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> multOutput[MAX_BLOCKSIZE];  <span class="comment">/* Intermediate output */</span></div>
 <div class="line"><a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> testOutput;  <span class="comment">/* Final ouput */</span></div>
 <div class="line"> </div>
-<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;   <span class="comment">/* Status of the example */</span></div>
+<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;   <span class="comment">/* Status of the example */</span></div>
 <div class="line"> </div>
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>

diff --git a/main/arm_fft_bin_example_f32_8c-example.html b/main/arm_fft_bin_example_f32_8c-example.html
@@ -205,7 +205,7 @@
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>
 <div class="line"> </div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> maxValue;</div>
 <div class="line"> </div>
 <div class="line">  status = <a id="a1" name="a1"></a><a class="code hl_enumvalue" href="group__genericTypes.html#gga5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>;</div>

diff --git a/main/arm_fir_example_f32_8c-example.html b/main/arm_fir_example_f32_8c-example.html
@@ -267,7 +267,7 @@
 <div class="line">{</div>
 <div class="line">  uint32_t i;</div>
 <div class="line">  <a id="_a0" name="_a0"></a><a class="code hl_struct" href="structarm__fir__instance__f32.html" title="Instance structure for the floating-point FIR filter.">arm_fir_instance_f32</a> S;</div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a>  *inputF32, *outputF32;</div>
 <div class="line"> </div>
 <div class="line">  <span class="comment">/* Initialize input and output buffer pointers */</span></div>

diff --git a/main/arm_linear_interp_example_f32_8c-example.html b/main/arm_linear_interp_example_f32_8c-example.html
@@ -239,7 +239,7 @@
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>
 <div class="line">  uint32_t i;</div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line"> </div>
 <div class="line">  <a id="_a0" name="_a0"></a><a class="code hl_struct" href="structarm__linear__interp__instance__f32.html" title="Instance structure for the floating-point Linear Interpolate function.">arm_linear_interp_instance_f32</a> S = {1884, -3.141592653589793238, XSPACING, (<span class="keywordtype">float</span>*)&amp;arm_linear_interep_table[0]};</div>
 <div class="line"> </div>

diff --git a/main/arm_matrix_example_f32_8c-example.html b/main/arm_matrix_example_f32_8c-example.html
@@ -240,7 +240,7 @@
 <div class="line">  <a class="code hl_struct" href="structarm__matrix__instance__f32.html" title="Instance structure for the floating-point matrix structure.">arm_matrix_instance_f32</a> X;      <span class="comment">/* Matrix X(Unknown Matrix) instance */</span></div>
 <div class="line"> </div>
 <div class="line">  uint32_t srcRows, srcColumns;  <span class="comment">/* Temporary variables */</span></div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line"> </div>
 <div class="line">  <span class="comment">/* Initialise A Matrix Instance with numRows, numCols and data array(A_f32) */</span></div>
 <div class="line">  srcRows = 4;</div>

diff --git a/main/arm_signal_converge_example_f32_8c-example.html b/main/arm_signal_converge_example_f32_8c-example.html
@@ -217,13 +217,13 @@
 <div class="line"><span class="comment">* Function Declarations for Signal Convergence Example</span></div>
 <div class="line"><span class="comment">* ------------------------------------------------------------------- */</span></div>
 <div class="line"> </div>
-<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> test_signal_converge_example( <span class="keywordtype">void</span> );</div>
+<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> test_signal_converge_example( <span class="keywordtype">void</span> );</div>
 <div class="line"> </div>
 <div class="line"> </div>
 <div class="line"><span class="comment">/* ----------------------------------------------------------------------</span></div>
 <div class="line"><span class="comment">* Internal functions</span></div>
 <div class="line"><span class="comment">* ------------------------------------------------------------------- */</span></div>
-<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> test_signal_converge(<a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a>* err_signal,</div>
+<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> test_signal_converge(<a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a>* err_signal,</div>
 <div class="line">                        uint32_t blockSize);</div>
 <div class="line"> </div>
 <div class="line"><span class="keywordtype">void</span> getinput(<a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a>* input,</div>
@@ -254,7 +254,7 @@
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>
 <div class="line">  uint32_t i;</div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line">  uint32_t index;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> minValue;</div>
 <div class="line"> </div>

diff --git a/main/arm_sin_cos_example_f32_8c-example.html b/main/arm_sin_cos_example_f32_8c-example.html
@@ -216,7 +216,7 @@
 <div class="line"><span class="comment">* Max magnitude FFT Bin test</span></div>
 <div class="line"><span class="comment">* ------------------------------------------------------------------- */</span></div>
 <div class="line"> </div>
-<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line"><a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line"> </div>
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>

diff --git a/main/arm_variance_example_f32_8c-example.html b/main/arm_variance_example_f32_8c-example.html
@@ -222,7 +222,7 @@
 <div class="line"> </div>
 <div class="line">int32_t main(<span class="keywordtype">void</span>)</div>
 <div class="line">{</div>
-<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> status;</div>
+<div class="line">  <a class="code hl_enumeration" href="group__genericTypes.html#ga5e459c6409dfcd2927bb8a57491d7cf6" title="vector types">arm_status</a> status;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> mean, oneByBlockSize;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> variance;</div>
 <div class="line">  <a class="code hl_typedef" href="group__genericTypes.html#ga4611b605e45ab401f02cab15c5e38715" title="32-bit floating-point type definition.">float32_t</a> diff;</div>