diff options
Diffstat (limited to 'docs/DSP/html/group__FIR__decimate.html')
| -rw-r--r-- | docs/DSP/html/group__FIR__decimate.html | 258 |
1 files changed, 124 insertions, 134 deletions
diff --git a/docs/DSP/html/group__FIR__decimate.html b/docs/DSP/html/group__FIR__decimate.html index 6296034..01ca22b 100644 --- a/docs/DSP/html/group__FIR__decimate.html +++ b/docs/DSP/html/group__FIR__decimate.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,30 +116,30 @@ $(document).ready(function(){initNavTree('group__FIR__decimate.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:ga25aa3d58a90bf91b6a82272a0bc518f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#ga25aa3d58a90bf91b6a82272a0bc518f7">arm_fir_decimate_f32</a> (const <a class="el" href="structarm__fir__decimate__instance__f32.html">arm_fir_decimate_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:ga25aa3d58a90bf91b6a82272a0bc518f7"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the floating-point FIR decimator. <a href="#ga25aa3d58a90bf91b6a82272a0bc518f7">More...</a><br/></td></tr> -<tr class="separator:ga25aa3d58a90bf91b6a82272a0bc518f7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga3f434c9a5d3b4e68061feac0714ea2ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#ga3f434c9a5d3b4e68061feac0714ea2ac">arm_fir_decimate_fast_q15</a> (const <a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_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:ga3f434c9a5d3b4e68061feac0714ea2ac"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4. <a href="#ga3f434c9a5d3b4e68061feac0714ea2ac">More...</a><br/></td></tr> -<tr class="separator:ga3f434c9a5d3b4e68061feac0714ea2ac"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga3c18cc3d0548a410c577f1bead9582b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#ga3c18cc3d0548a410c577f1bead9582b7">arm_fir_decimate_fast_q31</a> (<a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_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:ga3c18cc3d0548a410c577f1bead9582b7"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4. <a href="#ga3c18cc3d0548a410c577f1bead9582b7">More...</a><br/></td></tr> -<tr class="separator:ga3c18cc3d0548a410c577f1bead9582b7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaaa2524b08220fd6c3f753e692ffc7d3b"><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__decimate.html#gaaa2524b08220fd6c3f753e692ffc7d3b">arm_fir_decimate_init_f32</a> (<a class="el" href="structarm__fir__decimate__instance__f32.html">arm_fir_decimate_instance_f32</a> *S, uint16_t numTaps, uint8_t M, <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:gaaa2524b08220fd6c3f753e692ffc7d3b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point FIR decimator. <a href="#gaaa2524b08220fd6c3f753e692ffc7d3b">More...</a><br/></td></tr> -<tr class="separator:gaaa2524b08220fd6c3f753e692ffc7d3b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gada660e54b93d5d32178c6f5e1c6f368d"><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__decimate.html#gada660e54b93d5d32178c6f5e1c6f368d">arm_fir_decimate_init_q15</a> (<a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_instance_q15</a> *S, uint16_t numTaps, uint8_t M, <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:gada660e54b93d5d32178c6f5e1c6f368d"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q15 FIR decimator. <a href="#gada660e54b93d5d32178c6f5e1c6f368d">More...</a><br/></td></tr> -<tr class="separator:gada660e54b93d5d32178c6f5e1c6f368d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9ed47c4e0f58affa935d84e0508a7f39"><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__decimate.html#ga9ed47c4e0f58affa935d84e0508a7f39">arm_fir_decimate_init_q31</a> (<a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_instance_q31</a> *S, uint16_t numTaps, uint8_t M, <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:ga9ed47c4e0f58affa935d84e0508a7f39"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q31 FIR decimator. <a href="#ga9ed47c4e0f58affa935d84e0508a7f39">More...</a><br/></td></tr> -<tr class="separator:ga9ed47c4e0f58affa935d84e0508a7f39"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab8bef6d0f6a26fdbfce9485727713ce5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#gab8bef6d0f6a26fdbfce9485727713ce5">arm_fir_decimate_q15</a> (const <a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_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:gab8bef6d0f6a26fdbfce9485727713ce5"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR decimator. <a href="#gab8bef6d0f6a26fdbfce9485727713ce5">More...</a><br/></td></tr> -<tr class="separator:gab8bef6d0f6a26fdbfce9485727713ce5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaef8e86add28f15fdc5ecc484e9dd7a4e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#gaef8e86add28f15fdc5ecc484e9dd7a4e">arm_fir_decimate_q31</a> (const <a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_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:gaef8e86add28f15fdc5ecc484e9dd7a4e"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR decimator. <a href="#gaef8e86add28f15fdc5ecc484e9dd7a4e">More...</a><br/></td></tr> -<tr class="separator:gaef8e86add28f15fdc5ecc484e9dd7a4e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab9402a0d9b0fffc0b50083a7d56c5905"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#gab9402a0d9b0fffc0b50083a7d56c5905">arm_fir_decimate_f32</a> (const <a class="el" href="structarm__fir__decimate__instance__f32.html">arm_fir_decimate_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:gab9402a0d9b0fffc0b50083a7d56c5905"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for floating-point FIR decimator. <a href="#gab9402a0d9b0fffc0b50083a7d56c5905">More...</a><br/></td></tr> +<tr class="separator:gab9402a0d9b0fffc0b50083a7d56c5905"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab43fa1edb45d3b2e875dc8cd381770cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#gab43fa1edb45d3b2e875dc8cd381770cc">arm_fir_decimate_fast_q15</a> (const <a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_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:gab43fa1edb45d3b2e875dc8cd381770cc"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR decimator (fast variant). <a href="#gab43fa1edb45d3b2e875dc8cd381770cc">More...</a><br/></td></tr> +<tr class="separator:gab43fa1edb45d3b2e875dc8cd381770cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac03b837d289c8bc4a86a34a89e44afdf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#gac03b837d289c8bc4a86a34a89e44afdf">arm_fir_decimate_fast_q31</a> (const <a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_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:gac03b837d289c8bc4a86a34a89e44afdf"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR decimator (fast variant). <a href="#gac03b837d289c8bc4a86a34a89e44afdf">More...</a><br/></td></tr> +<tr class="separator:gac03b837d289c8bc4a86a34a89e44afdf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga67c80582fc296552fef2bd1f208d853b"><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__decimate.html#ga67c80582fc296552fef2bd1f208d853b">arm_fir_decimate_init_f32</a> (<a class="el" href="structarm__fir__decimate__instance__f32.html">arm_fir_decimate_instance_f32</a> *S, uint16_t numTaps, uint8_t M, 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:ga67c80582fc296552fef2bd1f208d853b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point FIR decimator. <a href="#ga67c80582fc296552fef2bd1f208d853b">More...</a><br/></td></tr> +<tr class="separator:ga67c80582fc296552fef2bd1f208d853b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3b01ec9df00d759f79c934b239cead73"><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__decimate.html#ga3b01ec9df00d759f79c934b239cead73">arm_fir_decimate_init_q15</a> (<a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_instance_q15</a> *S, uint16_t numTaps, uint8_t M, 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:ga3b01ec9df00d759f79c934b239cead73"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q15 FIR decimator. <a href="#ga3b01ec9df00d759f79c934b239cead73">More...</a><br/></td></tr> +<tr class="separator:ga3b01ec9df00d759f79c934b239cead73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6a19d62083e85b3f5e34e8a8283c1ea0"><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__decimate.html#ga6a19d62083e85b3f5e34e8a8283c1ea0">arm_fir_decimate_init_q31</a> (<a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_instance_q31</a> *S, uint16_t numTaps, uint8_t M, 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:ga6a19d62083e85b3f5e34e8a8283c1ea0"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q31 FIR decimator. <a href="#ga6a19d62083e85b3f5e34e8a8283c1ea0">More...</a><br/></td></tr> +<tr class="separator:ga6a19d62083e85b3f5e34e8a8283c1ea0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga262636462d9e24dab67ec792160afcbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#ga262636462d9e24dab67ec792160afcbf">arm_fir_decimate_q15</a> (const <a class="el" href="structarm__fir__decimate__instance__q15.html">arm_fir_decimate_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:ga262636462d9e24dab67ec792160afcbf"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q15 FIR decimator. <a href="#ga262636462d9e24dab67ec792160afcbf">More...</a><br/></td></tr> +<tr class="separator:ga262636462d9e24dab67ec792160afcbf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga27c05d7892f8a327aab86fbfee9b0f29"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FIR__decimate.html#ga27c05d7892f8a327aab86fbfee9b0f29">arm_fir_decimate_q31</a> (const <a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_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:ga27c05d7892f8a327aab86fbfee9b0f29"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 FIR decimator. <a href="#ga27c05d7892f8a327aab86fbfee9b0f29">More...</a><br/></td></tr> +<tr class="separator:ga27c05d7892f8a327aab86fbfee9b0f29"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>These functions combine an FIR filter together with a decimator. They are used in multirate systems for reducing the sample rate of a signal without introducing aliasing distortion. Conceptually, the functions are equivalent to the block diagram below: </p> @@ -151,31 +151,31 @@ Components included in the FIR Decimator functions</div></div> <p>The FIR decimator functions provided in the CMSIS DSP Library combine the FIR filter and the decimator in an efficient manner. Instead of calculating all of the FIR filter outputs and discarding <code>M-1</code> out of every <code>M</code>, only the samples output by the decimator are computed. The functions operate on blocks of input and output data. <code>pSrc</code> points to an array of <code>blockSize</code> input values and <code>pDst</code> points to an array of <code>blockSize/M</code> output values. In order to have an integer number of output samples <code>blockSize</code> must always be a multiple of the decimation factor <code>M</code>.</p> <p>The library provides separate functions for Q15, Q31 and floating-point data types.</p> <dl class="section user"><dt>Algorithm:</dt><dd>The FIR portion of the algorithm uses the standard form 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] + y[n] = b[0] * x[n] + b[1] * x[n-1] + b[2] * x[n-2] + ...+ b[numTaps-1] * x[n-numTaps+1] </pre> where, <code>b[n]</code> are the filter coefficients. </dd></dl> <dl class="section user"><dt></dt><dd>The <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]} + {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]} + {x[n-numTaps+1], x[n-numTaps], x[n-numTaps-1], x[n-numTaps-2]....x[0], x[1], ..., x[blockSize-1]} </pre> 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 array should be allocated separately. 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> <li>Sets the values of the internal structure fields.</li> <li>Zeros out the values in the state buffer.</li> -<li>Checks to make sure that the size of the input is a multiple of the decimation factor. To do this manually without calling the init function, assign the follow subfields of the instance structure: numTaps, pCoeffs, M (decimation factor), pState. Also set all of the values in pState to zero.</li> +<li>Checks to make sure that the size of the input is a multiple of the decimation factor. To do this manually without calling the init function, assign the follow subfields of the instance structure: numTaps, pCoeffs, M (decimation factor), 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. The code below statically initializes each of the 3 different data type filter instance structures <pre> -<a class="el" href="structarm__fir__decimate__instance__f32.html" title="Instance structure for the floating-point FIR decimator. ">arm_fir_decimate_instance_f32</a> S = {M, numTaps, pCoeffs, pState}; -<a class="el" href="structarm__fir__decimate__instance__q31.html" title="Instance structure for the Q31 FIR decimator. ">arm_fir_decimate_instance_q31</a> S = {M, numTaps, pCoeffs, pState}; -<a class="el" href="structarm__fir__decimate__instance__q15.html" title="Instance structure for the Q15 FIR decimator. ">arm_fir_decimate_instance_q15</a> S = {M, numTaps, pCoeffs, pState}; + <a class="el" href="structarm__fir__decimate__instance__f32.html" title="Instance structure for floating-point FIR decimator. ">arm_fir_decimate_instance_f32</a> S = {M, numTaps, pCoeffs, pState}; + <a class="el" href="structarm__fir__decimate__instance__q31.html" title="Instance structure for the Q31 FIR decimator. ">arm_fir_decimate_instance_q31</a> S = {M, numTaps, pCoeffs, pState}; + <a class="el" href="structarm__fir__decimate__instance__q15.html" title="Instance structure for the Q15 FIR decimator. ">arm_fir_decimate_instance_q15</a> S = {M, numTaps, pCoeffs, pState}; </pre> where <code>M</code> is the decimation factor; <code>numTaps</code> is the number of filter coefficients in the filter; <code>pCoeffs</code> is the address of the coefficient buffer; <code>pState</code> is the address of the state buffer. Be sure to set the values in the state buffer to zeros when doing static initialization.</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 decimate 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="ga25aa3d58a90bf91b6a82272a0bc518f7"></a> +<a class="anchor" id="gab9402a0d9b0fffc0b50083a7d56c5905"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -188,7 +188,7 @@ Components included in the FIR Decimator functions</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> @@ -212,20 +212,18 @@ Components included in the FIR Decimator functions</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 FIR decimator 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 input 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 decimator 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__decimate__instance__f32.html#a76a8b2161731638eb3d67f277919f95d">arm_fir_decimate_instance_f32::M</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a2aa2986129db8affef03ede88dd45a03">arm_fir_decimate_instance_f32::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a268a8b0e80a3d9764baf33e4bc10dde2">arm_fir_decimate_instance_f32::pCoeffs</a>, and <a class="el" href="structarm__fir__decimate__instance__f32.html#a5bddf29aaaf2011d2e3bcec59a83f633">arm_fir_decimate_instance_f32::pState</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga3f434c9a5d3b4e68061feac0714ea2ac"></a> +<a class="anchor" id="gab43fa1edb45d3b2e875dc8cd381770cc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -238,7 +236,7 @@ Components included in the FIR Decimator functions</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> @@ -260,39 +258,36 @@ Components included in the FIR Decimator functions</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the Q15 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4.</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 decimator 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 input 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 decimator 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 input samples to process per call </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>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 (log2 is read as log to the base 2). 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__decimate.html#gab8bef6d0f6a26fdbfce9485727713ce5" title="Processing function for the Q15 FIR decimator. ">arm_fir_decimate_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__decimate.html#gada660e54b93d5d32178c6f5e1c6f368d" title="Initialization function for the Q15 FIR decimator. ">arm_fir_decimate_init_q15()</a></code> to initialize the filter structure. </dd></dl> - -<p>References <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="structarm__fir__decimate__instance__q15.html#aad9320284218b3aa378527ea518cf093">arm_fir_decimate_instance_q15::M</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#ac1e9844488ec717da334fbd4c4f41990">arm_fir_decimate_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#a01cacab67e73945e8289075598ede14d">arm_fir_decimate_instance_q15::pCoeffs</a>, and <a class="el" href="structarm__fir__decimate__instance__q15.html#a3f7b5184bb28853ef401b001df121047">arm_fir_decimate_instance_q15::pState</a>.</p> +<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 (log2 is read as log to the base 2). 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__decimate.html#ga262636462d9e24dab67ec792160afcbf">arm_fir_decimate_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__decimate.html#ga3b01ec9df00d759f79c934b239cead73">arm_fir_decimate_init_q15()</a> to initialize the filter structure. </dd></dl> </div> </div> -<a class="anchor" id="ga3c18cc3d0548a410c577f1bead9582b7"></a> +<a class="anchor" id="gac03b837d289c8bc4a86a34a89e44afdf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_fir_decimate_fast_q31 </td> <td>(</td> - <td class="paramtype"><a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_instance_q31</a> * </td> + <td class="paramtype">const <a class="el" href="structarm__fir__decimate__instance__q31.html">arm_fir_decimate_instance_q31</a> * </td> <td class="paramname"><em>S</em>, </td> </tr> <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> @@ -314,25 +309,23 @@ Components included in the FIR Decimator functions</div></div> </tr> </table> </div><div class="memdoc"> +<p>Processing function for the Q31 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4.</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 decimator 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 input 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 decimator 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 (where log2 is read as log to the base 2).</dd></dl> -<dl class="section user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR__decimate.html#gaef8e86add28f15fdc5ecc484e9dd7a4e" title="Processing function for the Q31 FIR decimator. ">arm_fir_decimate_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__decimate.html#ga9ed47c4e0f58affa935d84e0508a7f39" title="Initialization function for the Q31 FIR decimator. ">arm_fir_decimate_init_q31()</a></code> to initialize the filter structure. </dd></dl> - -<p>References <a class="el" href="structarm__fir__decimate__instance__q31.html#ad3d6936c36303b30dd38f1eddf248ae5">arm_fir_decimate_instance_q31::M</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a37915d42b0dc5e3057ebe83110798482">arm_fir_decimate_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a030d0391538c2481c5b348fd09a952ff">arm_fir_decimate_instance_q31::pCoeffs</a>, and <a class="el" href="structarm__fir__decimate__instance__q31.html#a0ef0ef9e265f7ab873cfc6daa7593fdb">arm_fir_decimate_instance_q31::pState</a>.</p> +<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 (where log2 is read as log to the base 2).</dd></dl> +<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR__decimate.html#ga27c05d7892f8a327aab86fbfee9b0f29">arm_fir_decimate_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__decimate.html#ga6a19d62083e85b3f5e34e8a8283c1ea0">arm_fir_decimate_init_q31()</a> to initialize the filter structure. </dd></dl> </div> </div> -<a class="anchor" id="gaaa2524b08220fd6c3f753e692ffc7d3b"></a> +<a class="anchor" id="ga67c80582fc296552fef2bd1f208d853b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -357,7 +350,7 @@ Components included in the FIR Decimator functions</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> @@ -381,27 +374,28 @@ Components included in the FIR Decimator functions</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 decimator structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients. </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 input samples to process 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 decimator structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients </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 input samples to process per call </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization was successful or ARM_MATH_LENGTH_ERROR if <code>blockSize</code> is not a multiple of <code>M</code>.</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#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a> : <code>blockSize</code> is not a multiple of <code>M</code></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> </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> words where <code>blockSize</code> is the number of input samples passed to <code><a class="el" href="group__FIR__decimate.html#ga25aa3d58a90bf91b6a82272a0bc518f7" title="Processing function for the floating-point FIR decimator. ">arm_fir_decimate_f32()</a></code>. <code>M</code> is the decimation factor. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a76a8b2161731638eb3d67f277919f95d">arm_fir_decimate_instance_f32::M</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a2aa2986129db8affef03ede88dd45a03">arm_fir_decimate_instance_f32::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a268a8b0e80a3d9764baf33e4bc10dde2">arm_fir_decimate_instance_f32::pCoeffs</a>, <a class="el" href="structarm__fir__decimate__instance__f32.html#a5bddf29aaaf2011d2e3bcec59a83f633">arm_fir_decimate_instance_f32::pState</a>, and <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</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> words where <code>blockSize</code> is the number of input samples passed to <code><a class="el" href="group__FIR__decimate.html#gab9402a0d9b0fffc0b50083a7d56c5905" title="Processing function for floating-point FIR decimator. ">arm_fir_decimate_f32()</a></code>. <code>M</code> is the decimation factor. </dd></dl> </div> </div> -<a class="anchor" id="gada660e54b93d5d32178c6f5e1c6f368d"></a> +<a class="anchor" id="ga3b01ec9df00d759f79c934b239cead73"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -426,7 +420,7 @@ Components included in the FIR Decimator functions</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> @@ -450,27 +444,28 @@ Components included in the FIR Decimator functions</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 decimator structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients. </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 input samples to process 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 decimator structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients </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 input samples to process </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization was successful or ARM_MATH_LENGTH_ERROR if <code>blockSize</code> is not a multiple of <code>M</code>.</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#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a> : <code>blockSize</code> is not a multiple of <code>M</code></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> </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> words where <code>blockSize</code> is the number of input samples to the call <code><a class="el" href="group__FIR__decimate.html#gab8bef6d0f6a26fdbfce9485727713ce5" title="Processing function for the Q15 FIR decimator. ">arm_fir_decimate_q15()</a></code>. <code>M</code> is the decimation factor. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#aad9320284218b3aa378527ea518cf093">arm_fir_decimate_instance_q15::M</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#ac1e9844488ec717da334fbd4c4f41990">arm_fir_decimate_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#a01cacab67e73945e8289075598ede14d">arm_fir_decimate_instance_q15::pCoeffs</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#a3f7b5184bb28853ef401b001df121047">arm_fir_decimate_instance_q15::pState</a>, and <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</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> words where <code>blockSize</code> is the number of input samples to the call <code><a class="el" href="group__FIR__decimate.html#ga262636462d9e24dab67ec792160afcbf" title="Processing function for the Q15 FIR decimator. ">arm_fir_decimate_q15()</a></code>. <code>M</code> is the decimation factor. </dd></dl> </div> </div> -<a class="anchor" id="ga9ed47c4e0f58affa935d84e0508a7f39"></a> +<a class="anchor" id="ga6a19d62083e85b3f5e34e8a8283c1ea0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -495,7 +490,7 @@ Components included in the FIR Decimator functions</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> @@ -519,27 +514,28 @@ Components included in the FIR Decimator functions</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 decimator structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pCoeffs</td><td>points to the filter coefficients. </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 input samples to process 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 decimator structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numTaps</td><td>number of coefficients in the filter </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">M</td><td>decimation factor </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pCoeffs</td><td>points to the filter coefficients </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 input samples to process </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization was successful or ARM_MATH_LENGTH_ERROR if <code>blockSize</code> is not a multiple of <code>M</code>.</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#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a> : <code>blockSize</code> is not a multiple of <code>M</code></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> </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> words where <code>blockSize</code> is the number of input samples passed to <code><a class="el" href="group__FIR__decimate.html#gaef8e86add28f15fdc5ecc484e9dd7a4e" title="Processing function for the Q31 FIR decimator. ">arm_fir_decimate_q31()</a></code>. <code>M</code> is the decimation factor. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#ad3d6936c36303b30dd38f1eddf248ae5">arm_fir_decimate_instance_q31::M</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a37915d42b0dc5e3057ebe83110798482">arm_fir_decimate_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a030d0391538c2481c5b348fd09a952ff">arm_fir_decimate_instance_q31::pCoeffs</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a0ef0ef9e265f7ab873cfc6daa7593fdb">arm_fir_decimate_instance_q31::pState</a>, and <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</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> words where <code>blockSize</code> is the number of input samples passed to <code><a class="el" href="group__FIR__decimate.html#ga27c05d7892f8a327aab86fbfee9b0f29" title="Processing function for the Q31 FIR decimator. ">arm_fir_decimate_q31()</a></code>. <code>M</code> is the decimation factor. </dd></dl> </div> </div> -<a class="anchor" id="gab8bef6d0f6a26fdbfce9485727713ce5"></a> +<a class="anchor" id="ga262636462d9e24dab67ec792160afcbf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -552,7 +548,7 @@ Components included in the FIR Decimator functions</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> @@ -576,23 +572,20 @@ Components included in the FIR Decimator functions</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 decimator 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 location where the output result is written. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of input 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 decimator 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 input samples to process per call </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 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__decimate.html#ga3f434c9a5d3b4e68061feac0714ea2ac" title="Processing function for the Q15 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4. ">arm_fir_decimate_fast_q15()</a></code> for a faster but less precise implementation of this function for Cortex-M3 and Cortex-M4. </dd></dl> - -<p>References <a class="el" href="structarm__fir__decimate__instance__q15.html#aad9320284218b3aa378527ea518cf093">arm_fir_decimate_instance_q15::M</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#ac1e9844488ec717da334fbd4c4f41990">arm_fir_decimate_instance_q15::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q15.html#a01cacab67e73945e8289075598ede14d">arm_fir_decimate_instance_q15::pCoeffs</a>, and <a class="el" href="structarm__fir__decimate__instance__q15.html#a3f7b5184bb28853ef401b001df121047">arm_fir_decimate_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__decimate.html#gab43fa1edb45d3b2e875dc8cd381770cc">arm_fir_decimate_fast_q15()</a> for a faster but less precise implementation of this function. </dd></dl> </div> </div> -<a class="anchor" id="gaef8e86add28f15fdc5ecc484e9dd7a4e"></a> +<a class="anchor" id="ga27c05d7892f8a327aab86fbfee9b0f29"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -605,7 +598,7 @@ Components included in the FIR Decimator functions</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> @@ -629,19 +622,16 @@ Components included in the FIR Decimator functions</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 FIR decimator 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 input 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 decimator 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 (where log2 is read as log to the base 2). After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.</dd></dl> -<dl class="section user"><dt></dt><dd>Refer to the function <code><a class="el" href="group__FIR__decimate.html#ga3c18cc3d0548a410c577f1bead9582b7" title="Processing function for the Q31 FIR decimator (fast variant) for Cortex-M3 and Cortex-M4. ">arm_fir_decimate_fast_q31()</a></code> for a faster but less precise implementation of this function for Cortex-M3 and Cortex-M4. </dd></dl> - -<p>References <a class="el" href="structarm__fir__decimate__instance__q31.html#ad3d6936c36303b30dd38f1eddf248ae5">arm_fir_decimate_instance_q31::M</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a37915d42b0dc5e3057ebe83110798482">arm_fir_decimate_instance_q31::numTaps</a>, <a class="el" href="structarm__fir__decimate__instance__q31.html#a030d0391538c2481c5b348fd09a952ff">arm_fir_decimate_instance_q31::pCoeffs</a>, and <a class="el" href="structarm__fir__decimate__instance__q31.html#a0ef0ef9e265f7ab873cfc6daa7593fdb">arm_fir_decimate_instance_q31::pState</a>.</p> +<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 (where log2 is read as log to the base 2). After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.</dd></dl> +<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__FIR__decimate.html#gac03b837d289c8bc4a86a34a89e44afdf">arm_fir_decimate_fast_q31()</a> for a faster but less precise implementation of this function. </dd></dl> </div> </div> @@ -650,7 +640,7 @@ Components included in the FIR Decimator functions</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 |