Update documentation for branch main

ARM-software · Feb 6, 2025 · 26371a6 · 26371a6
1 parent 89bcf9d
commit 26371a6
Show file tree

Hide file tree

Showing 16 changed files with 928 additions and 870 deletions.
diff --git a/main/footer.js b/main/footer.js
@@ -1,7 +1,7 @@
 function writeHeader() {
-    document.write('Version 1.16.3-dev22');
+    document.write('Version 1.16.3-dev23');
 };
 
 function writeFooter()  {
-    document.write('Generated on Tue Feb  4 2025 09:51:17 for CMSIS-DSP 1.16.3-dev22+g9d1e74d. Copyright &copy; 2025 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Thu Feb  6 2025 06:28:03 for CMSIS-DSP 1.16.3-dev23+gbe484cd. Copyright &copy; 2025 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/group__MatrixInit.html b/main/group__MatrixInit.html
@@ -151,6 +151,9 @@
 <tr class="memitem:ga48a5e5d37e1f062cc57fcfaf683343cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixInit.html#ga48a5e5d37e1f062cc57fcfaf683343cc">arm_mat_init_q31</a> (<a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *S, uint16_t nRows, uint16_t nColumns, <a class="el" href="group__genericTypes.html#gadc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pData)</td></tr>
 <tr class="memdesc:ga48a5e5d37e1f062cc57fcfaf683343cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q31 matrix initialization.  <br /></td></tr>
 <tr class="separator:ga48a5e5d37e1f062cc57fcfaf683343cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaf6dce8741cd4f169f9447747ada587fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixInit.html#gaf6dce8741cd4f169f9447747ada587fe">arm_mat_init_q7</a> (<a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> *S, uint16_t nRows, uint16_t nColumns, <a class="el" href="group__genericTypes.html#gae541b6f232c305361e9b416fc9eed263">q7_t</a> *pData)</td></tr>
+<tr class="memdesc:gaf6dce8741cd4f169f9447747ada587fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 matrix initialization.  <br /></td></tr>
+<tr class="separator:gaf6dce8741cd4f169f9447747ada587fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 <p>Initializes the underlying matrix data structure. The functions set the <code>numRows</code>, <code>numCols</code>, and <code>pData</code> fields of the matrix data structure. </p>
@@ -408,6 +411,57 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga48a5e5d37e1f062cc57fcfa
   </dd>
 </dl>
 
+</div>
+</div>
+<a id="gaf6dce8741cd4f169f9447747ada587fe" name="gaf6dce8741cd4f169f9447747ada587fe"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaf6dce8741cd4f169f9447747ada587fe">&#9670;&#160;</a></span>arm_mat_init_q7()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void arm_mat_init_q7 </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structarm__matrix__instance__q7.html">arm_matrix_instance_q7</a> *&#160;</td>
+          <td class="paramname"><em>S</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint16_t&#160;</td>
+          <td class="paramname"><em>nRows</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint16_t&#160;</td>
+          <td class="paramname"><em>nColumns</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="group__genericTypes.html#gae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
+          <td class="paramname"><em>pData</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Q7 matrix initialization. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the floating-point matrix structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">nRows</td><td>number of rows in the matrix </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">nColumns</td><td>number of columns in the matrix </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pData</td><td>points to the matrix data array </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 </div><!-- contents -->

diff --git a/main/group__MatrixInit.js b/main/group__MatrixInit.js
@@ -4,5 +4,6 @@ var group__MatrixInit =
     [ "arm_mat_init_f32", "group__MatrixInit.html#ga11e3dc41592a6401c13182fef9416a27", null ],
     [ "arm_mat_init_f64", "group__MatrixInit.html#gab82440b44092f3cbd2ed4bcdb26ce105", null ],
     [ "arm_mat_init_q15", "group__MatrixInit.html#ga31a7c2b991803d49719393eb2d53dc26", null ],
-    [ "arm_mat_init_q31", "group__MatrixInit.html#ga48a5e5d37e1f062cc57fcfaf683343cc", null ]
+    [ "arm_mat_init_q31", "group__MatrixInit.html#ga48a5e5d37e1f062cc57fcfaf683343cc", null ],
+    [ "arm_mat_init_q7", "group__MatrixInit.html#gaf6dce8741cd4f169f9447747ada587fe", null ]
 ];
diff --git a/main/navtreedata.js b/main/navtreedata.js
@@ -44,11 +44,11 @@ var NAVTREEINDEX =
 "group__FUSION.html#ga5e94654d3f1f670867fb8957577396dc",
 "group__LD.html",
 "group__Matrix.html#abb20cdd597b9ff4a34cb9a01eb740cf7",
-"group__RMS.html#ga20586bc59cabbfc38a935c2448833dd2",
-"group__WindowBLACKMAN__HARRIS__92DB.html#gad84667126d863984ac30d7068e6f9ab5",
-"index.html#autotoc_md3",
-"structarm__fir__interpolate__instance__q31.html#a8f92bb07e0812f94679438cdf412b26a",
-"structarm__svm__polynomial__instance__f16.html#a2d1be16c16d99cbba003a47ee2a3234f"
+"group__RMS.html",
+"group__WindowBLACKMAN__HARRIS__92DB.html#ga11d4e3b5fba216d819757fcae14f7372",
+"index.html#autotoc_md2",
+"structarm__fir__interpolate__instance__q31.html#a80e7fdf4747dbda8eadb2663fb4be317",
+"structarm__svm__polynomial__instance__f16.html#a1abe530f26ba6a68edea942ebd904a0a"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronisation';

diff --git a/main/navtreeindex1.js b/main/navtreeindex1.js
@@ -227,27 +227,27 @@ var NAVTREEINDEX1 =
 "group__FIXED.html#ga0385cca6ea4f1a0443b4918d234f99fb":[4,18,4,123],
 "group__FIXED.html#ga0aa752f033eb2a4ec72d4ede35e25ff0":[4,18,4,133],
 "group__FIXED.html#ga0ce5940174a9394578b544a6e30d53c4":[4,18,4,25],
-"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,127],
-"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,124],
 "group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,131],
-"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,125],
-"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,126],
 "group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,130],
 "group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,129],
 "group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,128],
+"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,127],
+"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,126],
+"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,125],
+"group__FIXED.html#ga1142c76e6c46bb81c810ac62725f15a8":[4,18,4,124],
 "group__FIXED.html#ga1347d2c68f4090b8bc3b2e4757a106a2":[4,18,4,132],
 "group__FIXED.html#ga149f07ea91b6d0eee7b3bae6c7d80d99":[4,18,4,204],
+"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,212],
 "group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,211],
+"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,210],
+"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,209],
 "group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,205],
+"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,208],
 "group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,206],
 "group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,207],
-"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,210],
-"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,212],
-"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,208],
-"group__FIXED.html#ga1584849f3f51a524e17a48d8c0c4be0f":[4,18,4,209],
 "group__FIXED.html#ga17b0ea005c375bc6596ed466b2dd2e29":[4,18,4,200],
 "group__FIXED.html#ga1bffba044bb76b8457477d74a91e59f6":[4,18,4,66],
-"group__FIXED.html#ga1f74fa781bcb32c98ee7fc965942cdfb":[4,18,4,29],
 "group__FIXED.html#ga1f74fa781bcb32c98ee7fc965942cdfb":[4,18,4,27],
+"group__FIXED.html#ga1f74fa781bcb32c98ee7fc965942cdfb":[4,18,4,29],
 "group__FIXED.html#ga2366c883e1ae9dd74e38b7d1797bde87":[4,18,4,170]
 };
diff --git a/main/navtreeindex10.js b/main/navtreeindex10.js
@@ -1,5 +1,6 @@
 var NAVTREEINDEX10 =
 {
+"structarm__svm__polynomial__instance__f16.html#a1abe530f26ba6a68edea942ebd904a0a":[5,0,95,5],
 "structarm__svm__polynomial__instance__f16.html#a2d1be16c16d99cbba003a47ee2a3234f":[5,0,95,4],
 "structarm__svm__polynomial__instance__f16.html#a3232c3bca693bfd6a95f03aaec8bd4ef":[5,0,95,1],
 "structarm__svm__polynomial__instance__f16.html#a3fb69b6a70ff2d687329d334d02af9e1":[5,0,95,0],