diff options
Diffstat (limited to 'Drivers/CMSIS/docs/DSP/html/group__FIR.html')
| -rw-r--r-- | Drivers/CMSIS/docs/DSP/html/group__FIR.html | 326 |
1 files changed, 149 insertions, 177 deletions
diff --git a/Drivers/CMSIS/docs/DSP/html/group__FIR.html b/Drivers/CMSIS/docs/DSP/html/group__FIR.html index 8308a1818..8c0e0d9c3 100644 --- a/Drivers/CMSIS/docs/DSP/html/group__FIR.html +++ b/Drivers/CMSIS/docs/DSP/html/group__FIR.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,73 +116,72 @@ $(document).ready(function(){initNavTree('group__FIR.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:gae8fb334ea67eb6ecbd31824ddc14cd6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gae8fb334ea67eb6ecbd31824ddc14cd6a">arm_fir_f32</a> (const <a class="el" href="structarm__fir__instance__f32.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gae8fb334ea67eb6ecbd31824ddc14cd6a"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the floating-point FIR filter. <a href="#gae8fb334ea67eb6ecbd31824ddc14cd6a">More...</a><br/></td></tr> -<tr class="separator:gae8fb334ea67eb6ecbd31824ddc14cd6a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac7d35e9472e49ccd88800f37f3476bd3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gac7d35e9472e49ccd88800f37f3476bd3">arm_fir_fast_q15</a> (const <a class="el" href="structarm__fir__instance__q15.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gac7d35e9472e49ccd88800f37f3476bd3"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the fast Q15 FIR filter for Cortex-M3 and Cortex-M4. <a href="#gac7d35e9472e49ccd88800f37f3476bd3">More...</a><br/></td></tr> -<tr class="separator:gac7d35e9472e49ccd88800f37f3476bd3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga70d11af009dcd25594c58c75cdb5d6e3"><td class="memItemLeft" align="right" valign="top">IAR_ONLY_LOW_OPTIMIZATION_ENTER <br class="typebreak"/> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga70d11af009dcd25594c58c75cdb5d6e3">arm_fir_fast_q31</a> (const <a class="el" href="structarm__fir__instance__q31.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga70d11af009dcd25594c58c75cdb5d6e3"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the fast Q31 FIR filter for Cortex-M3 and Cortex-M4. <a href="#ga70d11af009dcd25594c58c75cdb5d6e3">More...</a><br/></td></tr> -<tr class="separator:ga70d11af009dcd25594c58c75cdb5d6e3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga98d13def6427e29522829f945d0967db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga98d13def6427e29522829f945d0967db">arm_fir_init_f32</a> (<a class="el" href="structarm__fir__instance__f32.html">arm_fir_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga98d13def6427e29522829f945d0967db"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point FIR filter. <a href="#ga98d13def6427e29522829f945d0967db">More...</a><br/></td></tr> -<tr class="separator:ga98d13def6427e29522829f945d0967db"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gae2a50f692f41ba57e44ed0719b1368bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gae2a50f692f41ba57e44ed0719b1368bd">arm_fir_init_q15</a> (<a class="el" href="structarm__fir__instance__q15.html">arm_fir_instance_q15</a> *S, uint16_t numTaps, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pState, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gae2a50f692f41ba57e44ed0719b1368bd"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q15 FIR filter. <a href="#gae2a50f692f41ba57e44ed0719b1368bd">More...</a><br/></td></tr> -<tr class="separator:gae2a50f692f41ba57e44ed0719b1368bd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac00d53af87684cbbe135767b55e748a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gac00d53af87684cbbe135767b55e748a5">arm_fir_init_q31</a> (<a class="el" href="structarm__fir__instance__q31.html">arm_fir_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gac00d53af87684cbbe135767b55e748a5"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q31 FIR filter. <a href="#gac00d53af87684cbbe135767b55e748a5">More...</a><br/></td></tr> -<tr class="separator:gac00d53af87684cbbe135767b55e748a5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga88e48688224d42dc173dbcec702f0c1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga88e48688224d42dc173dbcec702f0c1d">arm_fir_init_q7</a> (<a class="el" href="structarm__fir__instance__q7.html">arm_fir_instance_q7</a> *S, uint16_t numTaps, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pState, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga88e48688224d42dc173dbcec702f0c1d"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q7 FIR filter. <a href="#ga88e48688224d42dc173dbcec702f0c1d">More...</a><br/></td></tr> -<tr class="separator:ga88e48688224d42dc173dbcec702f0c1d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga262d173058d6f80fdf60404ba262a8f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga262d173058d6f80fdf60404ba262a8f5">arm_fir_q15</a> (const <a class="el" href="structarm__fir__instance__q15.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga262d173058d6f80fdf60404ba262a8f5"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR filter. <a href="#ga262d173058d6f80fdf60404ba262a8f5">More...</a><br/></td></tr> -<tr class="separator:ga262d173058d6f80fdf60404ba262a8f5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaadd938c68ab08967cbb5fc696f384bb5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gaadd938c68ab08967cbb5fc696f384bb5">arm_fir_q31</a> (const <a class="el" href="structarm__fir__instance__q31.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:gaadd938c68ab08967cbb5fc696f384bb5"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR filter. <a href="#gaadd938c68ab08967cbb5fc696f384bb5">More...</a><br/></td></tr> -<tr class="separator:gaadd938c68ab08967cbb5fc696f384bb5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga31c91a0bf0962327ef8f626fae68ea32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga31c91a0bf0962327ef8f626fae68ea32">arm_fir_q7</a> (const <a class="el" href="structarm__fir__instance__q7.html">arm_fir_instance_q7</a> *S, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> -<tr class="memdesc:ga31c91a0bf0962327ef8f626fae68ea32"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q7 FIR filter. <a href="#ga31c91a0bf0962327ef8f626fae68ea32">More...</a><br/></td></tr> -<tr class="separator:ga31c91a0bf0962327ef8f626fae68ea32"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0cf008f650a75f5e2cf82d10691b64d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga0cf008f650a75f5e2cf82d10691b64d9">arm_fir_f32</a> (const <a class="el" href="structarm__fir__instance__f32.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga0cf008f650a75f5e2cf82d10691b64d9"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for floating-point FIR filter. <a href="#ga0cf008f650a75f5e2cf82d10691b64d9">More...</a><br/></td></tr> +<tr class="separator:ga0cf008f650a75f5e2cf82d10691b64d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf58eee6c38f0b666897b24ca02f9d58d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gaf58eee6c38f0b666897b24ca02f9d58d">arm_fir_fast_q15</a> (const <a class="el" href="structarm__fir__instance__q15.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gaf58eee6c38f0b666897b24ca02f9d58d"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR filter (fast version). <a href="#gaf58eee6c38f0b666897b24ca02f9d58d">More...</a><br/></td></tr> +<tr class="separator:gaf58eee6c38f0b666897b24ca02f9d58d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga07051c8e9f0f228c9634b4a9ca2bcac3"><td class="memItemLeft" align="right" valign="top">IAR_ONLY_LOW_OPTIMIZATION_ENTER <br class="typebreak"/> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga07051c8e9f0f228c9634b4a9ca2bcac3">arm_fir_fast_q31</a> (const <a class="el" href="structarm__fir__instance__q31.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga07051c8e9f0f228c9634b4a9ca2bcac3"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR filter (fast version). <a href="#ga07051c8e9f0f228c9634b4a9ca2bcac3">More...</a><br/></td></tr> +<tr class="separator:ga07051c8e9f0f228c9634b4a9ca2bcac3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5afaa7b8e6735bbc19e582aa9755b0e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga5afaa7b8e6735bbc19e582aa9755b0e1">arm_fir_init_f32</a> (<a class="el" href="structarm__fir__instance__f32.html">arm_fir_instance_f32</a> *S, uint16_t numTaps, const <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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga5afaa7b8e6735bbc19e582aa9755b0e1"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point FIR filter. <a href="#ga5afaa7b8e6735bbc19e582aa9755b0e1">More...</a><br/></td></tr> +<tr class="separator:ga5afaa7b8e6735bbc19e582aa9755b0e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf4bfa7e20520f3b6e9f03a52ad6d0e41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gaf4bfa7e20520f3b6e9f03a52ad6d0e41">arm_fir_init_q15</a> (<a class="el" href="structarm__fir__instance__q15.html">arm_fir_instance_q15</a> *S, uint16_t numTaps, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pState, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gaf4bfa7e20520f3b6e9f03a52ad6d0e41"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q15 FIR filter. <a href="#gaf4bfa7e20520f3b6e9f03a52ad6d0e41">More...</a><br/></td></tr> +<tr class="separator:gaf4bfa7e20520f3b6e9f03a52ad6d0e41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga23ef4b2597aecc4d43cce7c4b456ae71"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga23ef4b2597aecc4d43cce7c4b456ae71">arm_fir_init_q31</a> (<a class="el" href="structarm__fir__instance__q31.html">arm_fir_instance_q31</a> *S, uint16_t numTaps, const <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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga23ef4b2597aecc4d43cce7c4b456ae71"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q31 FIR filter. <a href="#ga23ef4b2597aecc4d43cce7c4b456ae71">More...</a><br/></td></tr> +<tr class="separator:ga23ef4b2597aecc4d43cce7c4b456ae71"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabd62c4543b243c25e315e7acb57f726c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gabd62c4543b243c25e315e7acb57f726c">arm_fir_init_q7</a> (<a class="el" href="structarm__fir__instance__q7.html">arm_fir_instance_q7</a> *S, uint16_t numTaps, const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pCoeffs, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pState, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gabd62c4543b243c25e315e7acb57f726c"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q7 FIR filter. <a href="#gabd62c4543b243c25e315e7acb57f726c">More...</a><br/></td></tr> +<tr class="separator:gabd62c4543b243c25e315e7acb57f726c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad9f84fdadbb59292592c7fac81adb09c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gad9f84fdadbb59292592c7fac81adb09c">arm_fir_q15</a> (const <a class="el" href="structarm__fir__instance__q15.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gad9f84fdadbb59292592c7fac81adb09c"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR filter. <a href="#gad9f84fdadbb59292592c7fac81adb09c">More...</a><br/></td></tr> +<tr class="separator:gad9f84fdadbb59292592c7fac81adb09c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2f6fc6582ab4491b3ea8c038c5247ecf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#ga2f6fc6582ab4491b3ea8c038c5247ecf">arm_fir_q31</a> (const <a class="el" href="structarm__fir__instance__q31.html">arm_fir_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> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:ga2f6fc6582ab4491b3ea8c038c5247ecf"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q31 FIR filter. <a href="#ga2f6fc6582ab4491b3ea8c038c5247ecf">More...</a><br/></td></tr> +<tr class="separator:ga2f6fc6582ab4491b3ea8c038c5247ecf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac333f1139ef35124e89b0ee7494ad0a2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR.html#gac333f1139ef35124e89b0ee7494ad0a2">arm_fir_q7</a> (const <a class="el" href="structarm__fir__instance__q7.html">arm_fir_instance_q7</a> *S, const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr> +<tr class="memdesc:gac333f1139ef35124e89b0ee7494ad0a2"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for Q7 FIR filter. <a href="#gac333f1139ef35124e89b0ee7494ad0a2">More...</a><br/></td></tr> +<tr class="separator:gac333f1139ef35124e89b0ee7494ad0a2"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>This set of functions implements Finite Impulse Response (FIR) filters for Q7, Q15, Q31, and floating-point data types. Fast versions of Q15 and Q31 are also provided. The functions operate on blocks of input and output data and each call to the function processes <code>blockSize</code> samples through the filter. <code>pSrc</code> and <code>pDst</code> points to input and output arrays containing <code>blockSize</code> values.</p> -<dl class="section user"><dt>Algorithm:</dt><dd>The FIR filter algorithm is based upon a sequence of multiply-accumulate (MAC) operations. Each filter coefficient <code>b[n]</code> is multiplied by a state variable which equals a previous input sample <code>x[n]</code>. <pre> +<dl class="section user"><dt>Algorithm</dt><dd>The FIR filter algorithm is based upon a sequence of multiply-accumulate (MAC) operations. Each filter coefficient <code>b[n]</code> is multiplied by a state variable which equals a previous input sample <code>x[n]</code>. <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> +</pre> </dd></dl> <dl class="section user"><dt></dt><dd><div class="image"> -<img src="FIR.gif" alt="FIR.gif"/> +<img src="FIR.GIF" alt="FIR.GIF"/> <div class="caption"> Finite Impulse Response filter</div></div> - </dd></dl> +</dd></dl> <dl class="section user"><dt></dt><dd><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> +</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 following 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> -<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>. The increased state buffer length allows circular addressing, which is traditionally used in the FIR filters, to be avoided and yields a significant speed improvement. The state variables are updated after each block of data is processed; the coefficients are untouched. </dd></dl> +</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>. The increased state buffer length allows circular addressing, which is traditionally used in the FIR filters, to be avoided and yields a significant speed improvement. The state variables are updated after each block of data is processed; the coefficients are untouched.</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. Coefficient arrays may be shared among several instances while state variable arrays cannot be shared. There are separate instance structure declarations for each of the 4 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> <li>Sets the values of the internal structure fields.</li> -<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: numTaps, pCoeffs, pState. Also set all of the values in pState to zero.</li> +<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: numTaps, pCoeffs, pState. Also set all of the values in pState to zero. </li> </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 4 different data type filter instance structures <pre> -<a class="el" href="structarm__fir__instance__f32.html" title="Instance structure for the floating-point FIR filter. ">arm_fir_instance_f32</a> S = {numTaps, pState, pCoeffs}; -<a class="el" href="structarm__fir__instance__q31.html" title="Instance structure for the Q31 FIR filter. ">arm_fir_instance_q31</a> S = {numTaps, pState, pCoeffs}; -<a class="el" href="structarm__fir__instance__q15.html" title="Instance structure for the Q15 FIR filter. ">arm_fir_instance_q15</a> S = {numTaps, pState, pCoeffs}; -<a class="el" href="structarm__fir__instance__q7.html" title="Instance structure for the Q7 FIR filter. ">arm_fir_instance_q7</a> S = {numTaps, pState, pCoeffs}; - </pre></dd></dl> -<p>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.</p> + <a class="el" href="structarm__fir__instance__f32.html" title="Instance structure for the floating-point FIR filter. ">arm_fir_instance_f32</a> S = {numTaps, pState, pCoeffs}; + <a class="el" href="structarm__fir__instance__q31.html" title="Instance structure for the Q31 FIR filter. ">arm_fir_instance_q31</a> S = {numTaps, pState, pCoeffs}; + <a class="el" href="structarm__fir__instance__q15.html" title="Instance structure for the Q15 FIR filter. ">arm_fir_instance_q15</a> S = {numTaps, pState, pCoeffs}; + <a class="el" href="structarm__fir__instance__q7.html" title="Instance structure for the Q7 FIR filter. ">arm_fir_instance_q7</a> S = {numTaps, pState, pCoeffs}; +</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.</dd></dl> <dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the fixed-point versions of the FIR filter functions. In particular, the overflow and saturation behavior of the accumulator used in each function must be considered. Refer to the function specific documentation below for usage guidelines. </dd></dl> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gae8fb334ea67eb6ecbd31824ddc14cd6a"></a> +<a class="anchor" id="ga0cf008f650a75f5e2cf82d10691b64d9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -195,7 +194,7 @@ Finite Impulse Response 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> @@ -217,24 +216,21 @@ Finite Impulse Response filter</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the floating-point FIR filter.</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 FIR 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">[out]</td><td class="paramname">*pDst</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the floating-point FIR 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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="structarm__fir__instance__f32.html#a20cf98c92b5323799b7881c9ff4d2f7c">arm_fir_instance_f32::numTaps</a>, <a class="el" href="structarm__fir__instance__f32.html#a1c9cfca901d5902afeb640f2831488f4">arm_fir_instance_f32::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__f32.html#a7afcf4022e8560db9b8fd28b0d090a15">arm_fir_instance_f32::pState</a>.</p> - -<p>Referenced by <a class="el" href="arm__fir__example__f32_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="gac7d35e9472e49ccd88800f37f3476bd3"></a> +<a class="anchor" id="gaf58eee6c38f0b666897b24ca02f9d58d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -247,7 +243,7 @@ Finite Impulse Response 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> @@ -269,25 +265,23 @@ Finite Impulse Response filter</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the fast Q15 FIR filter (fast version).</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 Q15 FIR 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">[out]</td><td class="paramname">*pDst</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q15 FIR 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></dt><dd>This fast version uses a 32-bit accumulator with 2.30 format. The accumulator maintains full precision of the intermediate multiplication results but provides only a single guard bit. Thus, if the accumulator result overflows it wraps around and distorts the result. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. The 2.30 accumulator is then truncated to 2.15 format and saturated to yield the 1.15 result.</dd></dl> -<dl class="section user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR.html#ga262d173058d6f80fdf60404ba262a8f5" title="Processing function for the Q15 FIR filter. ">arm_fir_q15()</a></code> for a slower implementation of this function which uses 64-bit accumulation to avoid wrap around distortion. Both the slow and the fast versions use the same instance structure. Use the function <code><a class="el" href="group__FIR.html#gae2a50f692f41ba57e44ed0719b1368bd" title="Initialization function for the Q15 FIR filter. ">arm_fir_init_q15()</a></code> to initialize the filter structure. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#aa505179349146cf6186640b4c8b47714">__PKHBT</a>, <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#aa611fdbf6c56c46553701d6596a79aaf">__SMLAD()</a>, <a class="el" href="arm__math_8h.html#a7fc670277db1ad9ac34d52d771c7c305">__SMLADX()</a>, <a class="el" href="arm__math_8h.html#af0d54ec57b936994a34f073d0049ea3f">_SIMD32_OFFSET</a>, <a class="el" href="structarm__fir__instance__q15.html#a0e46f93cf51bfb18b1be808be9c5bfc9">arm_fir_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__instance__q15.html#a6d16db16a5f8f0db54938f2967244d9e">arm_fir_instance_q15::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q15.html#aa8d25f44f45b6a6c4cf38c31569b8a01">arm_fir_instance_q15::pState</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>This fast version uses a 32-bit accumulator with 2.30 format. The accumulator maintains full precision of the intermediate multiplication results but provides only a single guard bit. Thus, if the accumulator result overflows it wraps around and distorts the result. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. The 2.30 accumulator is then truncated to 2.15 format and saturated to yield the 1.15 result.</dd></dl> +<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR.html#gad9f84fdadbb59292592c7fac81adb09c">arm_fir_q15()</a> for a slower implementation of this function which uses 64-bit accumulation to avoid wrap around distortion. Both the slow and the fast versions use the same instance structure. Use function <a class="el" href="group__FIR.html#gaf4bfa7e20520f3b6e9f03a52ad6d0e41">arm_fir_init_q15()</a> to initialize the filter structure. </dd></dl> </div> </div> -<a class="anchor" id="ga70d11af009dcd25594c58c75cdb5d6e3"></a> +<a class="anchor" id="ga07051c8e9f0f228c9634b4a9ca2bcac3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -300,7 +294,7 @@ Finite Impulse Response 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> @@ -322,25 +316,23 @@ Finite Impulse Response filter</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the fast Q31 FIR filter (fast version).</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 Q31 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">[out]</td><td class="paramname">*pDst</td><td>points to the block output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q31 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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><b>Scaling and Overflow Behavior:</b></p> -<dl class="section user"><dt></dt><dd>This function is optimized for speed at the expense of fixed-point precision and overflow protection. The result of each 1.31 x 1.31 multiplication is truncated to 2.30 format. These intermediate results are added to a 2.30 accumulator. Finally, the accumulator is saturated and converted to a 1.31 result. The fast version has the same overflow behavior as the standard version and provides less precision since it discards the low 32 bits of each multiplication result. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits.</dd></dl> -<dl class="section user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR.html#gaadd938c68ab08967cbb5fc696f384bb5" title="Processing function for the Q31 FIR filter. ">arm_fir_q31()</a></code> for a slower implementation of this function which uses a 64-bit accumulator to provide higher precision. Both the slow and the fast versions use the same instance structure. Use the function <code><a class="el" href="group__FIR.html#gac00d53af87684cbbe135767b55e748a5" title="Initialization function for the Q31 FIR filter. ">arm_fir_init_q31()</a></code> to initialize the filter structure. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#aba3e538352fc7f9d6d15f9a18d469399">multAcc_32x32_keep32_R</a>, <a class="el" href="structarm__fir__instance__q31.html#a918fadd775b7a0482b21bf34dae2f094">arm_fir_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__instance__q31.html#afaae4c884bdf11a4ec2f3b9bb2bb51d0">arm_fir_instance_q31::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q31.html#a409f39c93b744784648bdc365541444d">arm_fir_instance_q31::pState</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>This function is optimized for speed at the expense of fixed-point precision and overflow protection. The result of each 1.31 x 1.31 multiplication is truncated to 2.30 format. These intermediate results are added to a 2.30 accumulator. Finally, the accumulator is saturated and converted to a 1.31 result. The fast version has the same overflow behavior as the standard version and provides less precision since it discards the low 32 bits of each multiplication result. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits.</dd></dl> +<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR.html#ga2f6fc6582ab4491b3ea8c038c5247ecf">arm_fir_q31()</a> for a slower implementation of this function which uses a 64-bit accumulator to provide higher precision. Both the slow and the fast versions use the same instance structure. Use function <a class="el" href="group__FIR.html#ga23ef4b2597aecc4d43cce7c4b456ae71">arm_fir_init_q31()</a> to initialize the filter structure. </dd></dl> </div> </div> -<a class="anchor" id="ga98d13def6427e29522829f945d0967db"></a> +<a class="anchor" id="ga5afaa7b8e6735bbc19e582aa9755b0e1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -359,7 +351,7 @@ Finite Impulse Response 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>pCoeffs</em>, </td> </tr> <tr> @@ -383,28 +375,23 @@ Finite Impulse Response filter</div></div> </div><div class="memdoc"> <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 FIR filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>Number of filter coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples that are processed per call. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the floating-point FIR filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples processed per call </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<p><b>Description:</b> </p> -<dl class="section user"><dt></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]} +<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> </dd></dl> -<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#gae8fb334ea67eb6ecbd31824ddc14cd6a" title="Processing function for the floating-point FIR filter. ">arm_fir_f32()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__fir__instance__f32.html#a20cf98c92b5323799b7881c9ff4d2f7c">arm_fir_instance_f32::numTaps</a>, <a class="el" href="structarm__fir__instance__f32.html#a1c9cfca901d5902afeb640f2831488f4">arm_fir_instance_f32::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__f32.html#a7afcf4022e8560db9b8fd28b0d090a15">arm_fir_instance_f32::pState</a>.</p> - -<p>Referenced by <a class="el" href="arm__fir__example__f32_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p> +<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#ga0cf008f650a75f5e2cf82d10691b64d9" title="Processing function for the floating-point FIR filter. ">arm_fir_f32()</a></code>. </dd></dl> </div> </div> -<a class="anchor" id="gae2a50f692f41ba57e44ed0719b1368bd"></a> +<a class="anchor" id="gaf4bfa7e20520f3b6e9f03a52ad6d0e41"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -423,7 +410,7 @@ Finite Impulse Response 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>pCoeffs</em>, </td> </tr> <tr> @@ -447,18 +434,21 @@ Finite Impulse Response filter</div></div> </div><div class="memdoc"> <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 Q15 FIR filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>Number of filter coefficients in the filter. Must be even and greater than or equal to 4. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>is number of samples processed per call. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the Q15 FIR filter structure. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients in the filter. Must be even and greater than or equal to 4. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples processed per call. </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization is successful or ARM_MATH_ARGUMENT_ERROR if <code>numTaps</code> is not greater than or equal to 4 and even.</dd></dl> -<p><b>Description:</b> </p> -<dl class="section user"><dt></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]} +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : <code>numTaps</code> is not greater than or equal to 4 and even</li> +</ul> +</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> Note that <code>numTaps</code> must be even and greater than or equal to 4. To implement an odd length filter simply increase <code>numTaps</code> by 1 and set the last coefficient to zero. For example, to implement a filter with <code>numTaps=3</code> and coefficients <pre> {0.3, -0.8, 0.3} </pre> set <code>numTaps=4</code> and use the coefficients: <pre> @@ -467,14 +457,11 @@ Finite Impulse Response filter</div></div> {0.3, -0.3} </pre> set <code>numTaps=4</code> and use the coefficients: <pre> {0.3, -0.3, 0, 0}. -</pre> </dd></dl> -<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is of length <code>numTaps+blockSize</code>, when running on Cortex-M4 and Cortex-M3 and is of length <code>numTaps+blockSize-1</code>, when running on Cortex-M0 where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__FIR.html#ga262d173058d6f80fdf60404ba262a8f5" title="Processing function for the Q15 FIR filter. ">arm_fir_q15()</a></code>. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__fir__instance__q15.html#a0e46f93cf51bfb18b1be808be9c5bfc9">arm_fir_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__instance__q15.html#a6d16db16a5f8f0db54938f2967244d9e">arm_fir_instance_q15::pCoeffs</a>, <a class="el" href="structarm__fir__instance__q15.html#aa8d25f44f45b6a6c4cf38c31569b8a01">arm_fir_instance_q15::pState</a>, and <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>.</p> +</pre> <code>pState</code> points to the array of state variables. <code>pState</code> is of length <code>numTaps+blockSize</code>, when running on Cortex-M4 and Cortex-M3 and is of length <code>numTaps+blockSize-1</code>, when running on Cortex-M0 where <code>blockSize</code> is the number of input samples processed by each call to <code><a class="el" href="group__FIR.html#gad9f84fdadbb59292592c7fac81adb09c" title="Processing function for the Q15 FIR filter. ">arm_fir_q15()</a></code>. </dd></dl> </div> </div> -<a class="anchor" id="gac00d53af87684cbbe135767b55e748a5"></a> +<a class="anchor" id="ga23ef4b2597aecc4d43cce7c4b456ae71"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -493,7 +480,7 @@ Finite Impulse Response 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>pCoeffs</em>, </td> </tr> <tr> @@ -517,26 +504,22 @@ Finite Impulse Response filter</div></div> </div><div class="memdoc"> <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 Q31 FIR filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>Number of filter coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples that are processed per call. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the Q31 FIR filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples processed </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<p><b>Description:</b> </p> -<dl class="section user"><dt></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> </dd></dl> -<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#gaadd938c68ab08967cbb5fc696f384bb5" title="Processing function for the Q31 FIR filter. ">arm_fir_q31()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__fir__instance__q31.html#a918fadd775b7a0482b21bf34dae2f094">arm_fir_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__instance__q31.html#afaae4c884bdf11a4ec2f3b9bb2bb51d0">arm_fir_instance_q31::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q31.html#a409f39c93b744784648bdc365541444d">arm_fir_instance_q31::pState</a>.</p> +<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> <code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#ga2f6fc6582ab4491b3ea8c038c5247ecf" title="Processing function for the Q31 FIR filter. ">arm_fir_q31()</a></code>. </dd></dl> </div> </div> -<a class="anchor" id="ga88e48688224d42dc173dbcec702f0c1d"></a> +<a class="anchor" id="gabd62c4543b243c25e315e7acb57f726c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -555,7 +538,7 @@ Finite Impulse Response filter</div></div> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> <td class="paramname"><em>pCoeffs</em>, </td> </tr> <tr> @@ -579,26 +562,23 @@ Finite Impulse Response filter</div></div> </div><div class="memdoc"> <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 Q7 FIR filter structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>Number of filter coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples that are processed per call. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the Q7 FIR filter structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of filter coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients 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">blockSize</td><td>number of samples processed </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>none</dd></dl> -<p><b>Description:</b> </p> -<dl class="section user"><dt></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]} +<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> </dd></dl> -<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#ga31c91a0bf0962327ef8f626fae68ea32" title="Processing function for the Q7 FIR filter. ">arm_fir_q7()</a></code>. </dd></dl> - -<p>References <a class="el" href="structarm__fir__instance__q7.html#a9b50840e2c5ef5b17e1a584fb4cf0d06">arm_fir_instance_q7::numTaps</a>, <a class="el" href="structarm__fir__instance__q7.html#a0e45aedefc3fffad6cb315c5b6e5bd49">arm_fir_instance_q7::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q7.html#aaddea3b9c7e16ddfd9428b7bf9f9c200">arm_fir_instance_q7::pState</a>.</p> +<dl class="section user"><dt></dt><dd><code>pState</code> points to the array of state variables. <code>pState</code> is 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__FIR.html#gac333f1139ef35124e89b0ee7494ad0a2" title="Processing function for the Q7 FIR filter. ">arm_fir_q7()</a></code>. </dd></dl> </div> </div> -<a class="anchor" id="ga262d173058d6f80fdf60404ba262a8f5"></a> +<a class="anchor" id="gad9f84fdadbb59292592c7fac81adb09c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -611,7 +591,7 @@ Finite Impulse Response 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> @@ -635,24 +615,20 @@ Finite Impulse Response 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 FIR 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">[out]</td><td class="paramname">*pDst</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q15 FIR 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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>Restrictions</dt><dd>If the silicon does not support unaligned memory access enable the macro UNALIGNED_SUPPORT_DISABLE In this case input, output, state buffers should be aligned by 32-bit</dd></dl> -<p><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></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 user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR.html#gac7d35e9472e49ccd88800f37f3476bd3" title="Processing function for the fast Q15 FIR filter for Cortex-M3 and Cortex-M4. ">arm_fir_fast_q15()</a></code> for a faster but less precise implementation of this function. </dd></dl> - -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="structarm__fir__instance__q15.html#a0e46f93cf51bfb18b1be808be9c5bfc9">arm_fir_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__instance__q15.html#a6d16db16a5f8f0db54938f2967244d9e">arm_fir_instance_q15::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q15.html#aa8d25f44f45b6a6c4cf38c31569b8a01">arm_fir_instance_q15::pState</a>.</p> +<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 remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR.html#gaf58eee6c38f0b666897b24ca02f9d58d">arm_fir_fast_q15()</a> for a faster but less precise implementation of this function. </dd></dl> </div> </div> -<a class="anchor" id="gaadd938c68ab08967cbb5fc696f384bb5"></a> +<a class="anchor" id="ga2f6fc6582ab4491b3ea8c038c5247ecf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -665,7 +641,7 @@ Finite Impulse Response 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> @@ -687,25 +663,23 @@ Finite Impulse Response filter</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the Q31 FIR filter.</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 Q31 FIR 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">[out]</td><td class="paramname">*pDst</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q31 FIR 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></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 clip. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. After all multiply-accumulates are performed, the 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.</dd></dl> -<dl class="section user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR.html#ga70d11af009dcd25594c58c75cdb5d6e3" title="Processing function for the fast Q31 FIR filter for Cortex-M3 and Cortex-M4. ">arm_fir_fast_q31()</a></code> for a faster but less precise implementation of this filter for Cortex-M3 and Cortex-M4. </dd></dl> - -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="structarm__fir__instance__q31.html#a918fadd775b7a0482b21bf34dae2f094">arm_fir_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__instance__q31.html#afaae4c884bdf11a4ec2f3b9bb2bb51d0">arm_fir_instance_q31::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q31.html#a409f39c93b744784648bdc365541444d">arm_fir_instance_q31::pState</a>.</p> +<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 clip. In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits. After all multiply-accumulates are performed, the 2.62 accumulator is right shifted by 31 bits and saturated to 1.31 format to yield the final result.</dd></dl> +<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR.html#ga07051c8e9f0f228c9634b4a9ca2bcac3">arm_fir_fast_q31()</a> for a faster but less precise implementation of this filter. </dd></dl> </div> </div> -<a class="anchor" id="ga31c91a0bf0962327ef8f626fae68ea32"></a> +<a class="anchor" id="gac333f1139ef35124e89b0ee7494ad0a2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -718,7 +692,7 @@ Finite Impulse Response filter</div></div> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -740,20 +714,18 @@ Finite Impulse Response filter</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the Q7 FIR filter.</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 Q7 FIR 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">[out]</td><td class="paramname">*pDst</td><td>points to the block of output data. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process per call. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q7 FIR 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">[out]</td><td class="paramname">pDst</td><td>points to the block of output 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><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></dt><dd>The function is implemented using a 32-bit internal accumulator. Both coefficients and state variables are represented in 1.7 format and multiplications yield a 2.14 result. The 2.14 intermediate results are accumulated in a 32-bit accumulator in 18.14 format. There is no risk of internal overflow with this approach and the full precision of intermediate multiplications is preserved. The accumulator is converted to 18.7 format by discarding the low 7 bits. Finally, the result is truncated to 1.7 format. </dd></dl> - -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="structarm__fir__instance__q7.html#a9b50840e2c5ef5b17e1a584fb4cf0d06">arm_fir_instance_q7::numTaps</a>, <a class="el" href="structarm__fir__instance__q7.html#a0e45aedefc3fffad6cb315c5b6e5bd49">arm_fir_instance_q7::pCoeffs</a>, and <a class="el" href="structarm__fir__instance__q7.html#aaddea3b9c7e16ddfd9428b7bf9f9c200">arm_fir_instance_q7::pState</a>.</p> +<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 32-bit internal accumulator. Both coefficients and state variables are represented in 1.7 format and multiplications yield a 2.14 result. The 2.14 intermediate results are accumulated in a 32-bit accumulator in 18.14 format. There is no risk of internal overflow with this approach and the full precision of intermediate multiplications is preserved. The accumulator is converted to 18.7 format by discarding the low 7 bits. Finally, the result is truncated to 1.7 format. </dd></dl> </div> </div> @@ -762,7 +734,7 @@ Finite Impulse Response 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:21 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 |