Update main documentation

gh-pages
github-actions 3 years ago
parent 58762e3e85
commit 30067a6773

@ -1,7 +1,7 @@
function writeHeader() {
document.write('Version 1.14.1-dev3');
document.write('Version 1.14.1-dev4');
};
function writeFooter() {
document.write('Generated on Thu Sep 29 2022 06:23:46 for CMSIS-DSP 1.14.1-dev3+g3d5fb83. Copyright © 2022 Arm Limited (or its affiliates). All rights reserved.');
document.write('Generated on Thu Sep 29 2022 06:35:41 for CMSIS-DSP 1.14.1-dev4+g8ed2ef7. Copyright © 2022 Arm Limited (or its affiliates). All rights reserved.');
};

@ -190,12 +190,7 @@ Single transposed Direct Form II Biquad</div></div>
<li>Zeros out the values in the state buffer. To do this manually without calling the init function, assign the follow subfields of the instance structure: numStages, pCoeffs, pState. Also set all of the values in pState to zero. </li>
</ul>
</dd></dl>
<dl class="section user"><dt></dt><dd><pre class="fragment"> Use of the initialization function is optional except for the vectorized versions (Helium and Neon).
However, if the initialization function is used, then the instance structure cannot be placed into a const data section.
To place an instance structure into a const data section, the instance structure must be manually initialized.
Set the values in the state buffer to zeros before static initialization.
For example, to statically initialize the instance structure use
</pre> <pre>
<dl class="section user"><dt></dt><dd>Use of the initialization function is optional except for the vectorized versions (Helium and Neon). However, if the initialization function is used, then the instance structure cannot be placed into a const data section. To place an instance structure into a const data section, the instance structure must be manually initialized. Set the values in the state buffer to zeros before static initialization. For example, to statically initialize the instance structure use <pre>
<a class="el" href="structarm__biquad__cascade__df2T__instance__f64.html" title="Instance structure for the floating-point transposed direct form II Biquad cascade filter.">arm_biquad_cascade_df2T_instance_f64</a> S1 = {numStages, pState, pCoeffs};
<a class="el" href="structarm__biquad__cascade__df2T__instance__f32.html" title="Instance structure for the floating-point transposed direct form II Biquad cascade filter.">arm_biquad_cascade_df2T_instance_f32</a> S1 = {numStages, pState, pCoeffs};
</pre> where <code>numStages</code> is the number of Biquad stages in the filter; <code>pState</code> is the address of the state buffer. <code>pCoeffs</code> is the address of the coefficient buffer;</dd></dl>

@ -1,6 +1,6 @@
//--- list of versions ---
const versions = {
"main": "1.14.1-dev3",
"main": "1.14.1-dev4",
"latest": "1.14.0",
"v1.12.0": "1.12.0",
"v1.11.0": "1.11.0",

Loading…
Cancel
Save