Update main documentation

3 years ago · 937c5bec53
parent 2cb9375350
commit 937c5bec53
4 changed files with 41 additions and 40 deletions
--- a/main/footer.js
+++ b/main/footer.js
@ -1,7 +1,7 @@
 function writeHeader() {
-    document.write('Version 1.14.5-dev5');
+    document.write('Version 1.14.5-dev6');
 };

 function writeFooter()  {
-    document.write('Generated on Wed Mar 15 2023 11:37:46 for CMSIS-DSP 1.14.5-dev5+ga5048f6. Copyright &copy; 2022-2023 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Mar 15 2023 12:02:28 for CMSIS-DSP 1.14.5-dev6+ge13bd5a. Copyright &copy; 2022-2023 Arm Limited (or its affiliates). All rights reserved.');
 };
--- a/main/group__MatrixMult.html
+++ b/main/group__MatrixMult.html
@ -518,7 +518,8 @@ This function is a faster implementation of arm_mat_mult_q31 for MVE but it is r
 </ul>
 </dd></dl>
 <dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 64-bit accumulator. The inputs to the multiplications are in 1.15 format and multiplications yield a 2.30 result. The 2.30 intermediate results are accumulated in a 64-bit accumulator in 34.30 format. This approach provides 33 guard bits and there is no risk of overflow. The 34.30 result is then truncated to 34.15 format by discarding the low 15 bits and then saturated to 1.15 format. </dd></dl>
-<dl class="section user"><dt></dt><dd>Refer to <a class="el" href="group__MatrixMult.html#ga08f37d93a5bfef0c5000dc5e0a411f93">arm_mat_mult_fast_q15()</a> for a faster but less precise version of this function. </dd></dl>
+<dl class="section user"><dt></dt><dd>Refer to <a class="el" href="group__MatrixMult.html#ga08f37d93a5bfef0c5000dc5e0a411f93">arm_mat_mult_fast_q15()</a> for a faster but less precise version of this function.</dd></dl>
+<dl class="section user"><dt>pState</dt><dd>pState will contain the transpose of pSrcB </dd></dl>

 </div>
 </div>
--- a/main/group__RealFFT.html
+++ b/main/group__RealFFT.html
@ -795,46 +795,46 @@ Real Inverse Fast Fourier Transform</div></div>
 <tr class="markdownTableHead">
 <th class="markdownTableHeadRight">RFFT Size   </th><th class="markdownTableHeadRight">Input Format   </th><th class="markdownTableHeadRight">Output Format   </th><th class="markdownTableHeadRight">Number of bits to upscale    </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">5.11   </td><td class="markdownTableBodyRight">5    </td></tr>
+<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">6.10   </td><td class="markdownTableBodyRight">5    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">6.10   </td><td class="markdownTableBodyRight">6    </td></tr>
+<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">7.9   </td><td class="markdownTableBodyRight">6    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">7.9   </td><td class="markdownTableBodyRight">7    </td></tr>
+<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">8.8   </td><td class="markdownTableBodyRight">7    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">8.8   </td><td class="markdownTableBodyRight">8    </td></tr>
+<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">9.7   </td><td class="markdownTableBodyRight">8    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">9.7   </td><td class="markdownTableBodyRight">9    </td></tr>
+<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">10.6   </td><td class="markdownTableBodyRight">9    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">10.6   </td><td class="markdownTableBodyRight">10    </td></tr>
+<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">11.5   </td><td class="markdownTableBodyRight">10    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">11.5   </td><td class="markdownTableBodyRight">11    </td></tr>
+<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">12.4   </td><td class="markdownTableBodyRight">11    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">12.4   </td><td class="markdownTableBodyRight">12    </td></tr>
+<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">13.3   </td><td class="markdownTableBodyRight">12    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">13.3   </td><td class="markdownTableBodyRight">13   </td></tr>
+<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">14.2   </td><td class="markdownTableBodyRight">13   </td></tr>
 </table>
 <dl class="section user"><dt>Input and Output formats for RIFFT Q15</dt><dd></dd></dl>
 <table class="markdownTable">
 <tr class="markdownTableHead">
 <th class="markdownTableHeadRight">RIFFT Size   </th><th class="markdownTableHeadRight">Input Format   </th><th class="markdownTableHeadRight">Output Format   </th><th class="markdownTableHeadRight">Number of bits to upscale    </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">5.11   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">6.10   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">6.10   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">7.9   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">7.9   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">8.8   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">8.8   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">9.7   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">9.7   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">10.6   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">10.6   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">11.5   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">11.5   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">12.4   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">12.4   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">13.3   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">13.3   </td><td class="markdownTableBodyRight">0   </td></tr>
+<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.15   </td><td class="markdownTableBodyRight">14.2   </td><td class="markdownTableBodyRight">0   </td></tr>
 </table>
 <dl class="section user"><dt></dt><dd>If the input buffer is of length N (fftLenReal), the output buffer must have length 2N since it is containing the conjugate part (except for MVE version where N+2 is enough). The input buffer is modified by this function. </dd></dl>
 <dl class="section user"><dt></dt><dd>For the RIFFT, the source buffer must have length N+2 since the Nyquist frequency value is needed but conjugate part is ignored. It is not using the packing trick of the float version. </dd></dl>
@ -887,46 +887,46 @@ Real Inverse Fast Fourier Transform</div></div>
 <tr class="markdownTableHead">
 <th class="markdownTableHeadRight">RFFT Size   </th><th class="markdownTableHeadRight">Input Format   </th><th class="markdownTableHeadRight">Output Format   </th><th class="markdownTableHeadRight">Number of bits to upscale    </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">5.27   </td><td class="markdownTableBodyRight">5    </td></tr>
+<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">6.26   </td><td class="markdownTableBodyRight">5    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">6.26   </td><td class="markdownTableBodyRight">6    </td></tr>
+<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">7.25   </td><td class="markdownTableBodyRight">6    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">7.25   </td><td class="markdownTableBodyRight">7    </td></tr>
+<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">8.24   </td><td class="markdownTableBodyRight">7    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">8.24   </td><td class="markdownTableBodyRight">8    </td></tr>
+<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">9.23   </td><td class="markdownTableBodyRight">8    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">9.23   </td><td class="markdownTableBodyRight">9    </td></tr>
+<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">10.22   </td><td class="markdownTableBodyRight">9    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">10.22   </td><td class="markdownTableBodyRight">10    </td></tr>
+<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">11.21   </td><td class="markdownTableBodyRight">10    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">11.21   </td><td class="markdownTableBodyRight">11    </td></tr>
+<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">12.20   </td><td class="markdownTableBodyRight">11    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">12.20   </td><td class="markdownTableBodyRight">12    </td></tr>
+<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">13.19   </td><td class="markdownTableBodyRight">12    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">13.19   </td><td class="markdownTableBodyRight">13   </td></tr>
+<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">14.18   </td><td class="markdownTableBodyRight">13   </td></tr>
 </table>
 <dl class="section user"><dt>Input and Output formats for RIFFT Q31</dt><dd></dd></dl>
 <table class="markdownTable">
 <tr class="markdownTableHead">
 <th class="markdownTableHeadRight">RIFFT Size   </th><th class="markdownTableHeadRight">Input Format   </th><th class="markdownTableHeadRight">Output Format   </th><th class="markdownTableHeadRight">Number of bits to upscale    </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">5.27   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">32   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">6.26   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">6.26   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">64   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">7.25   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">7.25   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">128   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">8.24   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">8.24   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">256   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">9.23   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">9.23   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">512   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">10.22   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">10.22   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">1024   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">11.21   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">11.21   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">2048   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">12.20   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">12.20   </td><td class="markdownTableBodyRight">0    </td></tr>
+<td class="markdownTableBodyRight">4096   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">13.19   </td><td class="markdownTableBodyRight">0    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">13.19   </td><td class="markdownTableBodyRight">0   </td></tr>
+<td class="markdownTableBodyRight">8192   </td><td class="markdownTableBodyRight">1.31   </td><td class="markdownTableBodyRight">14.18   </td><td class="markdownTableBodyRight">0   </td></tr>
 </table>
 <dl class="section user"><dt></dt><dd>If the input buffer is of length N (fftLenReal), the output buffer must have length 2N since it is containing the conjugate part (except for MVE version where N+2 is enough). The input buffer is modified by this function. </dd></dl>
 <dl class="section user"><dt></dt><dd>For the RIFFT, the source buffer must have length N+2 since the Nyquist frequency value is needed but conjugate part is ignored. It is not using the packing trick of the float version. </dd></dl>
--- a/version.js
+++ b/version.js
@ -1,6 +1,6 @@
 //--- list of versions ---
 const versions = {
-    "main": "1.14.5-dev5",
+    "main": "1.14.5-dev6",
    "latest": "1.14.4",
    "v1.14.3": "1.14.3",
    "v1.14.2": "1.14.2",