diff options
Diffstat (limited to 'docs/DSP/html/group__LMS.html')
| -rw-r--r-- | docs/DSP/html/group__LMS.html | 177 |
1 files changed, 82 insertions, 95 deletions
diff --git a/docs/DSP/html/group__LMS.html b/docs/DSP/html/group__LMS.html index 3e33b75..b2e329d 100644 --- a/docs/DSP/html/group__LMS.html +++ b/docs/DSP/html/group__LMS.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-DSP -  <span id="projectnumber">Version 1.5.2</span> +  <span id="projectnumber">Version 1.7.0</span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> @@ -116,9 +116,9 @@ $(document).ready(function(){initNavTree('group__LMS.html','');}); <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:gae266d009e682180421601627c79a3843"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#gae266d009e682180421601627c79a3843">arm_lms_f32</a> (const <a class="el" href="structarm__lms__instance__f32.html">arm_lms_instance_f32</a> *S, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pRef, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pOut, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gae266d009e682180421601627c79a3843"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for floating-point LMS filter. <a href="#gae266d009e682180421601627c79a3843">More...</a><br/></td></tr> -<tr class="separator:gae266d009e682180421601627c79a3843"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac518f7acd1778a8ee90e81c421cfbb90"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#gac518f7acd1778a8ee90e81c421cfbb90">arm_lms_f32</a> (const <a class="el" href="structarm__lms__instance__f32.html">arm_lms_instance_f32</a> *S, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pRef, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pOut, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gac518f7acd1778a8ee90e81c421cfbb90"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for floating-point LMS filter. <a href="#gac518f7acd1778a8ee90e81c421cfbb90">More...</a><br/></td></tr> +<tr class="separator:gac518f7acd1778a8ee90e81c421cfbb90"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9fc7adca0966ff2cec1746fca8364cee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#ga9fc7adca0966ff2cec1746fca8364cee">arm_lms_init_f32</a> (<a class="el" href="structarm__lms__instance__f32.html">arm_lms_instance_f32</a> *S, uint16_t numTaps, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pState, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> mu, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> <tr class="memdesc:ga9fc7adca0966ff2cec1746fca8364cee"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for floating-point LMS filter. <a href="#ga9fc7adca0966ff2cec1746fca8364cee">More...</a><br/></td></tr> <tr class="separator:ga9fc7adca0966ff2cec1746fca8364cee"><td class="memSeparator" colspan="2"> </td></tr> @@ -128,12 +128,12 @@ Functions</h2></td></tr> <tr class="memitem:ga8d4bc251169f4b102355097a9f7530d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#ga8d4bc251169f4b102355097a9f7530d6">arm_lms_init_q31</a> (<a class="el" href="structarm__lms__instance__q31.html">arm_lms_instance_q31</a> *S, uint16_t numTaps, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pState, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> mu, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, uint32_t postShift)</td></tr> <tr class="memdesc:ga8d4bc251169f4b102355097a9f7530d6"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for Q31 LMS filter. <a href="#ga8d4bc251169f4b102355097a9f7530d6">More...</a><br/></td></tr> <tr class="separator:ga8d4bc251169f4b102355097a9f7530d6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gacde16c17eb75979f81b34e2e2a58c7ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#gacde16c17eb75979f81b34e2e2a58c7ac">arm_lms_q15</a> (const <a class="el" href="structarm__lms__instance__q15.html">arm_lms_instance_q15</a> *S, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pRef, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gacde16c17eb75979f81b34e2e2a58c7ac"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q15 LMS filter. <a href="#gacde16c17eb75979f81b34e2e2a58c7ac">More...</a><br/></td></tr> -<tr class="separator:gacde16c17eb75979f81b34e2e2a58c7ac"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6a0abfe6041253a6f91c63b383a64257"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#ga6a0abfe6041253a6f91c63b383a64257">arm_lms_q31</a> (const <a class="el" href="structarm__lms__instance__q31.html">arm_lms_instance_q31</a> *S, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pRef, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga6a0abfe6041253a6f91c63b383a64257"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q31 LMS filter. <a href="#ga6a0abfe6041253a6f91c63b383a64257">More...</a><br/></td></tr> -<tr class="separator:ga6a0abfe6041253a6f91c63b383a64257"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga12fd93f61401b365789cdfd5dca07e5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#ga12fd93f61401b365789cdfd5dca07e5b">arm_lms_q15</a> (const <a class="el" href="structarm__lms__instance__q15.html">arm_lms_instance_q15</a> *S, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pRef, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga12fd93f61401b365789cdfd5dca07e5b"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q15 LMS filter. <a href="#ga12fd93f61401b365789cdfd5dca07e5b">More...</a><br/></td></tr> +<tr class="separator:ga12fd93f61401b365789cdfd5dca07e5b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga69c9c64338c067f1fb4990dcdc8c143f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS.html#ga69c9c64338c067f1fb4990dcdc8c143f">arm_lms_q31</a> (const <a class="el" href="structarm__lms__instance__q31.html">arm_lms_instance_q31</a> *S, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pRef, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pErr, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga69c9c64338c067f1fb4990dcdc8c143f"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q31 LMS filter. <a href="#ga69c9c64338c067f1fb4990dcdc8c143f">More...</a><br/></td></tr> +<tr class="separator:ga69c9c64338c067f1fb4990dcdc8c143f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>LMS filters are a class of adaptive filters that are able to "learn" an unknown transfer functions. LMS filters use a gradient descent method in which the filter coefficients are updated based on the instantaneous error signal. Adaptive filters are often used in communication systems, equalizers, and noise removal. The CMSIS DSP Library contains LMS filter functions that operate on Q15, Q31, and floating-point data types. The library also contains normalized LMS filters in which the filter coefficient adaptation is indepedent of the level of the input signal.</p> @@ -144,23 +144,23 @@ Functions</h2></td></tr> Internal structure of the Least Mean Square filter</div></div> <p> The functions operate on blocks of data and each call to the function processes <code>blockSize</code> samples through the filter. <code>pSrc</code> points to input signal, <code>pRef</code> points to reference signal, <code>pOut</code> points to output signal and <code>pErr</code> points to error signal. All arrays contain <code>blockSize</code> values.</p> <p>The functions operate on a block-by-block basis. Internally, the filter coefficients <code>b[n]</code> are updated on a sample-by-sample basis. The convergence of the LMS filter is slower compared to the normalized LMS algorithm.</p> -<dl class="section user"><dt>Algorithm:</dt><dd>The output signal <code>y[n]</code> is computed by a standard FIR filter: <pre> - y[n] = b[0] * x[n] + b[1] * x[n-1] + b[2] * x[n-2] + ...+ b[numTaps-1] * x[n-numTaps+1] - </pre></dd></dl> +<dl class="section user"><dt>Algorithm</dt><dd>The output signal <code>y[n]</code> is computed by a standard FIR filter: <pre> + y[n] = b[0] * x[n] + b[1] * x[n-1] + b[2] * x[n-2] + ...+ b[numTaps-1] * x[n-numTaps+1] +</pre></dd></dl> <dl class="section user"><dt></dt><dd>The error signal equals the difference between the reference signal <code>d[n]</code> and the filter output: <pre> - e[n] = d[n] - y[n]. - </pre></dd></dl> + e[n] = d[n] - y[n]. +</pre></dd></dl> <dl class="section user"><dt></dt><dd>After each sample of the error signal is computed, the filter coefficients <code>b[k]</code> are updated on a sample-by-sample basis: <pre> - b[k] = b[k] + e[n] * mu * x[n-k], for k=0, 1, ..., numTaps-1 - </pre> where <code>mu</code> is the step size and controls the rate of coefficient convergence. </dd></dl> + b[k] = b[k] + e[n] * mu * x[n-k], for k=0, 1, ..., numTaps-1 +</pre> where <code>mu</code> is the step size and controls the rate of coefficient convergence. </dd></dl> <dl class="section user"><dt></dt><dd>In the APIs, <code>pCoeffs</code> points to a coefficient array of size <code>numTaps</code>. Coefficients are stored in time reversed order. </dd></dl> <dl class="section user"><dt></dt><dd><pre> - {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} - </pre> </dd></dl> + {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} +</pre> </dd></dl> <dl class="section user"><dt></dt><dd><code>pState</code> points to a state array of size <code>numTaps + blockSize - 1</code>. Samples in the state buffer are stored in the order: </dd></dl> <dl class="section user"><dt></dt><dd><pre> - {x[n-numTaps+1], x[n-numTaps], x[n-numTaps-1], x[n-numTaps-2]....x[0], x[1], ..., x[blockSize-1]} - </pre> </dd></dl> + {x[n-numTaps+1], x[n-numTaps], x[n-numTaps-1], x[n-numTaps-2]....x[0], x[1], ..., x[blockSize-1]} +</pre> </dd></dl> <dl class="section user"><dt></dt><dd>Note that the length of the state buffer exceeds the length of the coefficient array by <code>blockSize-1</code> samples. The increased state buffer length allows circular addressing, which is traditionally used in FIR filters, to be avoided and yields a significant speed improvement. The state variables are updated after each block of data is processed. </dd></dl> <dl class="section user"><dt>Instance Structure</dt><dd>The coefficients and state variables for a filter are stored together in an instance data structure. A separate instance structure must be defined for each filter and coefficient and state arrays cannot be shared among instances. There are separate instance structure declarations for each of the 3 supported data types.</dd></dl> <dl class="section user"><dt>Initialization Functions</dt><dd>There is also an associated initialization function for each data type. The initialization function performs the following operations:<ul> @@ -169,19 +169,19 @@ Internal structure of the Least Mean Square filter</div></div> </ul> </dd></dl> <dl class="section user"><dt></dt><dd>Use of the initialization function is optional. 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. The code below statically initializes each of the 3 different data type filter instance structures <pre> - <a class="el" href="structarm__lms__instance__f32.html" title="Instance structure for the floating-point LMS filter. ">arm_lms_instance_f32</a> S = {numTaps, pState, pCoeffs, mu}; - <a class="el" href="structarm__lms__instance__q31.html" title="Instance structure for the Q31 LMS filter. ">arm_lms_instance_q31</a> S = {numTaps, pState, pCoeffs, mu, postShift}; - <a class="el" href="structarm__lms__instance__q15.html" title="Instance structure for the Q15 LMS filter. ">arm_lms_instance_q15</a> S = {numTaps, pState, pCoeffs, mu, postShift}; - </pre> where <code>numTaps</code> is the number of filter coefficients in the filter; <code>pState</code> is the address of the state buffer; <code>pCoeffs</code> is the address of the coefficient buffer; <code>mu</code> is the step size parameter; and <code>postShift</code> is the shift applied to coefficients.</dd></dl> -<dl class="section user"><dt>Fixed-Point Behavior:</dt><dd>Care must be taken when using the Q15 and Q31 versions of the LMS filter. The following issues must be considered:<ul> + <a class="el" href="structarm__lms__instance__f32.html" title="Instance structure for the floating-point LMS filter. ">arm_lms_instance_f32</a> S = {numTaps, pState, pCoeffs, mu}; + <a class="el" href="structarm__lms__instance__q31.html" title="Instance structure for the Q31 LMS filter. ">arm_lms_instance_q31</a> S = {numTaps, pState, pCoeffs, mu, postShift}; + <a class="el" href="structarm__lms__instance__q15.html" title="Instance structure for the Q15 LMS filter. ">arm_lms_instance_q15</a> S = {numTaps, pState, pCoeffs, mu, postShift}; +</pre> where <code>numTaps</code> is the number of filter coefficients in the filter; <code>pState</code> is the address of the state buffer; <code>pCoeffs</code> is the address of the coefficient buffer; <code>mu</code> is the step size parameter; and <code>postShift</code> is the shift applied to coefficients.</dd></dl> +<dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the Q15 and Q31 versions of the LMS filter. The following issues must be considered:<ul> <li>Scaling of coefficients</li> <li>Overflow and saturation</li> </ul> </dd></dl> -<dl class="section user"><dt>Scaling of Coefficients:</dt><dd>Filter coefficients are represented as fractional values and coefficients are restricted to lie in the range <code>[-1 +1)</code>. The fixed-point functions have an additional scaling parameter <code>postShift</code>. At the output of the filter's accumulator is a shift register which shifts the result by <code>postShift</code> bits. This essentially scales the filter coefficients by <code>2^postShift</code> and allows the filter coefficients to exceed the range <code>[+1 -1)</code>. The value of <code>postShift</code> is set by the user based on the expected gain through the system being modeled.</dd></dl> -<dl class="section user"><dt>Overflow and Saturation:</dt><dd>Overflow and saturation behavior of the fixed-point Q15 and Q31 versions are described separately as part of the function specific documentation below. </dd></dl> +<dl class="section user"><dt>Scaling of Coefficients</dt><dd>Filter coefficients are represented as fractional values and coefficients are restricted to lie in the range <code>[-1 +1)</code>. The fixed-point functions have an additional scaling parameter <code>postShift</code>. At the output of the filter's accumulator is a shift register which shifts the result by <code>postShift</code> bits. This essentially scales the filter coefficients by <code>2^postShift</code> and allows the filter coefficients to exceed the range <code>[+1 -1)</code>. The value of <code>postShift</code> is set by the user based on the expected gain through the system being modeled.</dd></dl> +<dl class="section user"><dt>Overflow and Saturation</dt><dd>Overflow and saturation behavior of the fixed-point Q15 and Q31 versions are described separately as part of the function specific documentation below. </dd></dl> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gae266d009e682180421601627c79a3843"></a> +<a class="anchor" id="gac518f7acd1778a8ee90e81c421cfbb90"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -194,7 +194,7 @@ Internal structure of the Least Mean Square filter</div></div> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -228,21 +228,18 @@ Internal structure of the Least Mean Square filter</div></div> </tr> </table> </div><div class="memdoc"> -<p>This function operates on floating-point data types.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the floating-point LMS filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the block of input data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pRef</td><td>points to the block of reference data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pOut</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pErr</td><td>points to the block of error data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the floating-point LMS filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the block of input data </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pRef</td><td>points to the block of reference data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>points to the block of output data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pErr</td><td>points to the block of error data </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> - -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="structarm__lms__instance__f32.html#ae2af43d74c93dba16b876e10c97a5b99">arm_lms_instance_f32::mu</a>, <a class="el" href="structarm__lms__instance__f32.html#af73880d9009982f5d14529869494ec3d">arm_lms_instance_f32::numTaps</a>, <a class="el" href="structarm__lms__instance__f32.html#a4795c6f7d3f17cec15c2fd09f66edd1a">arm_lms_instance_f32::pCoeffs</a>, and <a class="el" href="structarm__lms__instance__f32.html#aaf94285be2f99b5b9af40bea8dcb14b9">arm_lms_instance_f32::pState</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> @@ -295,21 +292,19 @@ Internal structure of the Least Mean Square filter</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the floating-point LMS filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the coefficient buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pState</td><td>points to state buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">mu</td><td>step size that controls filter coefficient updates. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the floating-point LMS filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to coefficient buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pState</td><td>points to state buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mu</td><td>step size that controls filter coefficient updates </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> -<dl class="section user"><dt>Description:</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Details</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} -</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#gae266d009e682180421601627c79a3843" title="Processing function for floating-point LMS filter. ">arm_lms_f32()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__lms__instance__f32.html#ae2af43d74c93dba16b876e10c97a5b99">arm_lms_instance_f32::mu</a>, <a class="el" href="structarm__lms__instance__f32.html#af73880d9009982f5d14529869494ec3d">arm_lms_instance_f32::numTaps</a>, <a class="el" href="structarm__lms__instance__f32.html#a4795c6f7d3f17cec15c2fd09f66edd1a">arm_lms_instance_f32::pCoeffs</a>, and <a class="el" href="structarm__lms__instance__f32.html#aaf94285be2f99b5b9af40bea8dcb14b9">arm_lms_instance_f32::pState</a>.</p> +</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#gac518f7acd1778a8ee90e81c421cfbb90" title="Processing function for floating-point LMS filter. ">arm_lms_f32()</a></code>. </dd></dl> </div> </div> @@ -368,22 +363,20 @@ Internal structure of the Least Mean Square filter</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q15 LMS filter structure. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q15 LMS filter structure. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the coefficient buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pState</td><td>points to the state buffer. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to coefficient buffer. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pState</td><td>points to state buffer. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">mu</td><td>step size that controls filter coefficient updates. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">postShift</td><td>bit shift applied to coefficients. </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Description:</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Details</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} -</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to the array of state variables and size of array is <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#gacde16c17eb75979f81b34e2e2a58c7ac" title="Processing function for Q15 LMS filter. ">arm_lms_q15()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__lms__instance__q15.html#aae46129d7cfd7f1c162cc502ed0a9d49">arm_lms_instance_q15::mu</a>, <a class="el" href="structarm__lms__instance__q15.html#a0078e894f805af1b360369e619fb57b3">arm_lms_instance_q15::numTaps</a>, <a class="el" href="structarm__lms__instance__q15.html#a42f95368b94898eb82608e1113d18cab">arm_lms_instance_q15::pCoeffs</a>, <a class="el" href="structarm__lms__instance__q15.html#acca5fbaef4a52ae411de24c9a0b929cf">arm_lms_instance_q15::postShift</a>, and <a class="el" href="structarm__lms__instance__q15.html#a9a575ff82c1e68cbb583083439260d08">arm_lms_instance_q15::pState</a>.</p> +</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to the array of state variables and size of array is <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#ga12fd93f61401b365789cdfd5dca07e5b" title="Processing function for Q15 LMS filter. ">arm_lms_q15()</a></code>. </dd></dl> </div> </div> @@ -442,26 +435,24 @@ Internal structure of the Least Mean Square filter</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q31 LMS filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to coefficient buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pState</td><td>points to state buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">mu</td><td>step size that controls filter coefficient updates. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">postShift</td><td>bit shift applied to coefficients. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q31 LMS filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to coefficient buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pState</td><td>points to state buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">mu</td><td>step size that controls filter coefficient updates </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">postShift</td><td>bit shift applied to coefficients </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Description:</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Details</dt><dd><code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: <pre> {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} -</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#ga6a0abfe6041253a6f91c63b383a64257" title="Processing function for Q31 LMS filter. ">arm_lms_q31()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__lms__instance__q31.html#acb6ca9996b3c5f740d5d6c8e9f4f1d46">arm_lms_instance_q31::mu</a>, <a class="el" href="structarm__lms__instance__q31.html#ac0d84f7d054555931ef8a62511fbcb8a">arm_lms_instance_q31::numTaps</a>, <a class="el" href="structarm__lms__instance__q31.html#a4afe56e991a5416adfd462aa88bda500">arm_lms_instance_q31::pCoeffs</a>, <a class="el" href="structarm__lms__instance__q31.html#a4705a8f0011bb9166e09bf5bd51e595e">arm_lms_instance_q31::postShift</a>, and <a class="el" href="structarm__lms__instance__q31.html#a206d47b49de6f357f933ebe61520753c">arm_lms_instance_q31::pState</a>.</p> +</pre> The initial filter coefficients serve as a starting point for the adaptive filter. <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__LMS.html#ga69c9c64338c067f1fb4990dcdc8c143f" title="Processing function for Q31 LMS filter. ">arm_lms_q31()</a></code>. </dd></dl> </div> </div> -<a class="anchor" id="gacde16c17eb75979f81b34e2e2a58c7ac"></a> +<a class="anchor" id="ga12fd93f61401b365789cdfd5dca07e5b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -474,7 +465,7 @@ Internal structure of the Least Mean Square filter</div></div> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -510,24 +501,22 @@ Internal structure of the Least Mean Square filter</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q15 LMS filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the block of input data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pRef</td><td>points to the block of reference data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pOut</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pErr</td><td>points to the block of error data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q15 LMS filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the block of input data </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pRef</td><td>points to the block of reference data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>points to the block of output data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pErr</td><td>points to the block of error data </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Scaling and Overflow Behavior:</dt><dd>The function is implemented using a 64-bit internal accumulator. Both coefficients and state variables are represented 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. There is no risk of internal overflow with this approach and the full precision of intermediate multiplications is preserved. After all additions have been performed, the accumulator is truncated to 34.15 format by discarding low 15 bits. Lastly, the accumulator is saturated to yield a result in 1.15 format.</dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 64-bit accumulator. Both coefficients and state variables are represented 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. There is no risk of internal overflow with this approach and the full precision of intermediate multiplications is preserved. After all additions have been performed, the accumulator is truncated to 34.15 format by discarding low 15 bits. Lastly, the accumulator is saturated to yield a result in 1.15 format. </dd></dl> <dl class="section user"><dt></dt><dd>In this filter, filter coefficients are updated for each sample and the updation of filter cofficients are saturted. </dd></dl> -<p>References <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#a7aed02041f489a4f65dbd7093073d94e">__SMLALD()</a>, <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="structarm__lms__instance__q15.html#aae46129d7cfd7f1c162cc502ed0a9d49">arm_lms_instance_q15::mu</a>, <a class="el" href="structarm__lms__instance__q15.html#a0078e894f805af1b360369e619fb57b3">arm_lms_instance_q15::numTaps</a>, <a class="el" href="structarm__lms__instance__q15.html#a42f95368b94898eb82608e1113d18cab">arm_lms_instance_q15::pCoeffs</a>, <a class="el" href="structarm__lms__instance__q15.html#acca5fbaef4a52ae411de24c9a0b929cf">arm_lms_instance_q15::postShift</a>, and <a class="el" href="structarm__lms__instance__q15.html#a9a575ff82c1e68cbb583083439260d08">arm_lms_instance_q15::pState</a>.</p> - </div> </div> -<a class="anchor" id="ga6a0abfe6041253a6f91c63b383a64257"></a> +<a class="anchor" id="ga69c9c64338c067f1fb4990dcdc8c143f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -540,7 +529,7 @@ Internal structure of the Least Mean Square filter</div></div> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -576,21 +565,19 @@ Internal structure of the Least Mean Square filter</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q15 LMS filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the block of input data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pRef</td><td>points to the block of reference data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pOut</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pErr</td><td>points to the block of error data. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q31 LMS filter structure. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the block of input data. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pRef</td><td>points to the block of reference data. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>points to the block of output data. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pErr</td><td>points to the block of error data. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Scaling and Overflow Behavior:</dt><dd>The function is implemented using an internal 64-bit accumulator. The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit. Thus, if the accumulator result overflows it wraps around rather than clips. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. The reference signal should not be scaled down. After all multiply-accumulates are performed, the 2.62 accumulator is shifted and saturated to 1.31 format to yield the final result. The output signal and error signal are in 1.31 format.</dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 64-bit accumulator. The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit. Thus, if the accumulator result overflows it wraps around rather than clips. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. The reference signal should not be scaled down. After all multiply-accumulates are performed, the 2.62 accumulator is shifted and saturated to 1.31 format to yield the final result. The output signal and error signal are in 1.31 format. </dd></dl> <dl class="section user"><dt></dt><dd>In this filter, filter coefficients are updated for each sample and the updation of filter cofficients are saturted. </dd></dl> -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a9a94b78de0f083bd8fadf3c3abe40431">clip_q63_to_q31()</a>, <a class="el" href="structarm__lms__instance__q31.html#acb6ca9996b3c5f740d5d6c8e9f4f1d46">arm_lms_instance_q31::mu</a>, <a class="el" href="structarm__lms__instance__q31.html#ac0d84f7d054555931ef8a62511fbcb8a">arm_lms_instance_q31::numTaps</a>, <a class="el" href="structarm__lms__instance__q31.html#a4afe56e991a5416adfd462aa88bda500">arm_lms_instance_q31::pCoeffs</a>, <a class="el" href="structarm__lms__instance__q31.html#a4705a8f0011bb9166e09bf5bd51e595e">arm_lms_instance_q31::postShift</a>, and <a class="el" href="structarm__lms__instance__q31.html#a206d47b49de6f357f933ebe61520753c">arm_lms_instance_q31::pState</a>.</p> - </div> </div> </div><!-- contents --> @@ -598,7 +585,7 @@ Internal structure of the Least Mean Square filter</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:22 for CMSIS-DSP by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:40 for CMSIS-DSP Version 1.7.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |