You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
875 lines
57 KiB
HTML
875 lines
57 KiB
HTML
<!-- HTML header for doxygen 1.9.2-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CMSIS-DSP: Correlation</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="footer.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="$extra_stylesheet" rel="stylesheet" type="text/css" />
|
|
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
|
|
<link href="version.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../version.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 55px;">
|
|
<td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
|
|
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
|
|
<div id="projectname">CMSIS-DSP
|
|
 <span id="projectnumber"><script type="text/javascript">
|
|
<!--
|
|
writeHeader.call(this);
|
|
writeVersionDropdown(this);
|
|
//-->
|
|
</script>
|
|
</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS DSP Software Library</div>
|
|
</td>
|
|
<!--END !PROJECT_NAME-->
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Usage and Description</span></a></li>
|
|
<li class="current"><a href="modules.html"><span> API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__Corr.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Correlation<div class="ingroups"><a class="el" href="group__groupFilters.html">Filtering Functions</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga15c05c2024f43817e8a79f1b9dc1f409"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga15c05c2024f43817e8a79f1b9dc1f409">arm_correlate_f16</a> (const float16_t *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const float16_t *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, float16_t *pDst)</td></tr>
|
|
<tr class="memdesc:ga15c05c2024f43817e8a79f1b9dc1f409"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of floating-point sequences. <a href="group__Corr.html#ga15c05c2024f43817e8a79f1b9dc1f409">More...</a><br /></td></tr>
|
|
<tr class="separator:ga15c05c2024f43817e8a79f1b9dc1f409"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga371054f6e5fd78bec668908251f1b2f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga371054f6e5fd78bec668908251f1b2f2">arm_correlate_f32</a> (const <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:ga371054f6e5fd78bec668908251f1b2f2"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of floating-point sequences. <a href="group__Corr.html#ga371054f6e5fd78bec668908251f1b2f2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga371054f6e5fd78bec668908251f1b2f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga60b0d48a0247d7cc9148d9021844222b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga60b0d48a0247d7cc9148d9021844222b">arm_correlate_f64</a> (const <a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:ga60b0d48a0247d7cc9148d9021844222b"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of floating-point sequences. <a href="group__Corr.html#ga60b0d48a0247d7cc9148d9021844222b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga60b0d48a0247d7cc9148d9021844222b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3fc8d680844a3d24af25e45df96c82f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga3fc8d680844a3d24af25e45df96c82f3">arm_correlate_fast_opt_q15</a> (const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pScratch)</td></tr>
|
|
<tr class="memdesc:ga3fc8d680844a3d24af25e45df96c82f3"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q15 sequences (fast version). <a href="group__Corr.html#ga3fc8d680844a3d24af25e45df96c82f3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3fc8d680844a3d24af25e45df96c82f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab4dea2049c8a26118ee4de9b90f1b9bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#gab4dea2049c8a26118ee4de9b90f1b9bd">arm_correlate_fast_q15</a> (const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:gab4dea2049c8a26118ee4de9b90f1b9bd"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q15 sequences (fast version). <a href="group__Corr.html#gab4dea2049c8a26118ee4de9b90f1b9bd">More...</a><br /></td></tr>
|
|
<tr class="separator:gab4dea2049c8a26118ee4de9b90f1b9bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1e85a8ceac5c0f27007e6ba2c8f20686"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga1e85a8ceac5c0f27007e6ba2c8f20686">arm_correlate_fast_q31</a> (const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:ga1e85a8ceac5c0f27007e6ba2c8f20686"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q31 sequences (fast version). <a href="group__Corr.html#ga1e85a8ceac5c0f27007e6ba2c8f20686">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1e85a8ceac5c0f27007e6ba2c8f20686"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3cfae563b16fa3be577cab5acf63aeea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga3cfae563b16fa3be577cab5acf63aeea">arm_correlate_opt_q15</a> (const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pScratch)</td></tr>
|
|
<tr class="memdesc:ga3cfae563b16fa3be577cab5acf63aeea"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q15 sequences. <a href="group__Corr.html#ga3cfae563b16fa3be577cab5acf63aeea">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3cfae563b16fa3be577cab5acf63aeea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3c672e8ef8360c652d351097535f080d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga3c672e8ef8360c652d351097535f080d">arm_correlate_opt_q7</a> (const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pScratch1, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pScratch2)</td></tr>
|
|
<tr class="memdesc:ga3c672e8ef8360c652d351097535f080d"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q7 sequences. <a href="group__Corr.html#ga3c672e8ef8360c652d351097535f080d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3c672e8ef8360c652d351097535f080d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8fc4e632ab08b28435ff62e7eb65f508"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga8fc4e632ab08b28435ff62e7eb65f508">arm_correlate_q15</a> (const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:ga8fc4e632ab08b28435ff62e7eb65f508"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q15 sequences. <a href="group__Corr.html#ga8fc4e632ab08b28435ff62e7eb65f508">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8fc4e632ab08b28435ff62e7eb65f508"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9e8ad8bae8400dac2afc995d38594744"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#ga9e8ad8bae8400dac2afc995d38594744">arm_correlate_q31</a> (const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:ga9e8ad8bae8400dac2afc995d38594744"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q31 sequences. <a href="group__Corr.html#ga9e8ad8bae8400dac2afc995d38594744">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9e8ad8bae8400dac2afc995d38594744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab5d8acc830313be970de59c2d5a26c72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Corr.html#gab5d8acc830313be970de59c2d5a26c72">arm_correlate_q7</a> (const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcA, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#ace48ed566e2cd6a680f0681192e6af28">srcALen</a>, const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcB, uint32_t <a class="el" href="arm__convolution__example__f32_8c.html#aea71286f498978c5ed3775609b974fc8">srcBLen</a>, <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst)</td></tr>
|
|
<tr class="memdesc:gab5d8acc830313be970de59c2d5a26c72"><td class="mdescLeft"> </td><td class="mdescRight">Correlation of Q7 sequences. <a href="group__Corr.html#gab5d8acc830313be970de59c2d5a26c72">More...</a><br /></td></tr>
|
|
<tr class="separator:gab5d8acc830313be970de59c2d5a26c72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<p >Correlation is a mathematical operation that is similar to convolution. As with convolution, correlation uses two signals to produce a third signal. The underlying algorithms in correlation and convolution are identical except that one of the inputs is flipped in convolution. Correlation is commonly used to measure the similarity between two signals. It has applications in pattern recognition, cryptanalysis, and searching. The CMSIS library provides correlation functions for Q7, Q15, Q31 and floating-point data types. Fast versions of the Q15 and Q31 functions are also provided.</p>
|
|
<dl class="section user"><dt>Algorithm</dt><dd>Let <code>a[n]</code> and <code>b[n]</code> be sequences of length <code>srcALen</code> and <code>srcBLen</code> samples respectively. The convolution of the two signals is denoted by <p class="formulaDsp">
|
|
\[ c[n] = a[n] * b[n] \]
|
|
</p>
|
|
</dd></dl>
|
|
<p>In correlation, one of the signals is flipped in time</p>
|
|
<p class="formulaDsp">
|
|
\[ c[n] = a[n] * b[-n] \]
|
|
</p>
|
|
<dl class="section user"><dt></dt><dd>and this is mathematically defined as <p class="formulaDsp">
|
|
\[ c[n] = \sum_{k=0}^{srcALen} a[k] b[k-n] \]
|
|
</p>
|
|
</dd></dl>
|
|
<dl class="section user"><dt></dt><dd>The <code>pSrcA</code> points to the first input vector of length <code>srcALen</code> and <code>pSrcB</code> points to the second input vector of length <code>srcBLen</code>. The result <code>c[n]</code> is of length <code>2 * max(srcALen, srcBLen) - 1</code> and is defined over the interval <code>n=0, 1, 2, ..., (2 * max(srcALen, srcBLen) - 2)</code>. The output result is written to <code>pDst</code> and the calling function must allocate <code>2 * max(srcALen, srcBLen) - 1</code> words for the result.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>The <code>pDst</code> should be initialized to all zeros before being used.</dd></dl>
|
|
<dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Correlation requires summing up a large number of intermediate products. As such, the Q7, Q15, and Q31 functions run a risk of overflow and saturation. Refer to the function specific documentation below for further details of the particular algorithm used.</dd></dl>
|
|
<dl class="section user"><dt>Fast Versions</dt><dd>Fast versions are supported for Q31 and Q15. Cycles for Fast versions are less compared to Q31 and Q15 of correlate and the design requires the input signals should be scaled down to avoid intermediate overflows.</dd></dl>
|
|
<dl class="section user"><dt>Opt Versions</dt><dd>Opt versions are supported for Q15 and Q7. Design uses internal scratch buffer for getting good optimisation. These versions are optimised in cycles and consumes more memory (Scratch memory) compared to Q15 and Q7 versions of correlate</dd></dl>
|
|
<dl class="section user"><dt>Long versions:</dt><dd>For convolution of long vectors, those functions are no more adapted and will be very slow. An implementation based upon FFTs should be used. </dd></dl>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga15c05c2024f43817e8a79f1b9dc1f409" name="ga15c05c2024f43817e8a79f1b9dc1f409"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga15c05c2024f43817e8a79f1b9dc1f409">◆ </a></span>arm_correlate_f16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_f16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const float16_t * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const float16_t * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float16_t * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga371054f6e5fd78bec668908251f1b2f2" name="ga371054f6e5fd78bec668908251f1b2f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga371054f6e5fd78bec668908251f1b2f2">◆ </a></span>arm_correlate_f32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_f32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga60b0d48a0247d7cc9148d9021844222b" name="ga60b0d48a0247d7cc9148d9021844222b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga60b0d48a0247d7cc9148d9021844222b">◆ </a></span>arm_correlate_f64()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_f64 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ac55f3ae81b5bc9053760baacf57e47f4">float64_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3fc8d680844a3d24af25e45df96c82f3" name="ga3fc8d680844a3d24af25e45df96c82f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3fc8d680844a3d24af25e45df96c82f3">◆ </a></span>arm_correlate_fast_opt_q15()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_fast_opt_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pScratch</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pScratch</td><td>points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>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. There is no saturation on intermediate additions. Thus, if the accumulator overflows it wraps around and distorts the result. The input signals should be scaled down to avoid intermediate overflows. Scale down one of the inputs by 1/min(srcALen, srcBLen) to avoid overflow since a maximum of min(srcALen, srcBLen) number of additions is carried internally. The 2.30 accumulator is right shifted by 15 bits and then saturated to 1.15 format to yield the final result.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#ga8fc4e632ab08b28435ff62e7eb65f508">arm_correlate_q15()</a> for a slower implementation of this function which uses a 64-bit accumulator to avoid wrap around distortion. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab4dea2049c8a26118ee4de9b90f1b9bd" name="gab4dea2049c8a26118ee4de9b90f1b9bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab4dea2049c8a26118ee4de9b90f1b9bd">◆ </a></span>arm_correlate_fast_q15()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_fast_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>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. There is no saturation on intermediate additions. Thus, if the accumulator overflows it wraps around and distorts the result. The input signals should be scaled down to avoid intermediate overflows. Scale down one of the inputs by 1/min(srcALen, srcBLen) to avoid overflow since a maximum of min(srcALen, srcBLen) number of additions is carried internally. The 2.30 accumulator is right shifted by 15 bits and then saturated to 1.15 format to yield the final result.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#ga8fc4e632ab08b28435ff62e7eb65f508">arm_correlate_q15()</a> for a slower implementation of this function which uses a 64-bit accumulator to avoid wrap around distortion. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1e85a8ceac5c0f27007e6ba2c8f20686" name="ga1e85a8ceac5c0f27007e6ba2c8f20686"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1e85a8ceac5c0f27007e6ba2c8f20686">◆ </a></span>arm_correlate_fast_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_fast_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>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 accumulated in a 32-bit register in 2.30 format. Finally, the accumulator is saturated and converted to a 1.31 result. </dd></dl>
|
|
<dl class="section user"><dt></dt><dd>The fast version has the same overflow behavior as the standard version but provides less precision since it discards the low 32 bits of each multiplication result. In order to avoid overflows completely the input signals must be scaled down. The input signals should be scaled down to avoid intermediate overflows. Scale down one of the inputs by 1/min(srcALen, srcBLen)to avoid overflows since a maximum of min(srcALen, srcBLen) number of additions is carried internally.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#ga9e8ad8bae8400dac2afc995d38594744">arm_correlate_q31()</a> for a slower implementation of this function which uses 64-bit accumulation to provide higher precision. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3cfae563b16fa3be577cab5acf63aeea" name="ga3cfae563b16fa3be577cab5acf63aeea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3cfae563b16fa3be577cab5acf63aeea">◆ </a></span>arm_correlate_opt_q15()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_opt_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pScratch</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pScratch</td><td>points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 64-bit internal accumulator. Both inputs are 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. This approach provides 33 guard bits and there is no risk of overflow. The 34.30 result is then truncated to 34.15 format by discarding the low 15 bits and then saturated to 1.15 format.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#gab4dea2049c8a26118ee4de9b90f1b9bd">arm_correlate_fast_q15()</a> for a faster but less precise version of this function. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3c672e8ef8360c652d351097535f080d" name="ga3c672e8ef8360c652d351097535f080d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3c672e8ef8360c652d351097535f080d">◆ </a></span>arm_correlate_opt_q7()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_opt_q7 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pScratch1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pScratch2</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pScratch1</td><td>points to scratch buffer(of type q15_t) of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pScratch2</td><td>points to scratch buffer (of type q15_t) of size min(srcALen, srcBLen). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 32-bit internal accumulator. Both the inputs 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. This approach provides 17 guard bits and there is no risk of overflow as long as <code>max(srcALen, srcBLen)<131072</code>. The 18.14 result is then truncated to 18.7 format by discarding the low 7 bits and then saturated to 1.7 format. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8fc4e632ab08b28435ff62e7eb65f508" name="ga8fc4e632ab08b28435ff62e7eb65f508"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8fc4e632ab08b28435ff62e7eb65f508">◆ </a></span>arm_correlate_q15()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 64-bit internal accumulator. Both inputs are 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. This approach provides 33 guard bits and there is no risk of overflow. The 34.30 result is then truncated to 34.15 format by discarding the low 15 bits and then saturated to 1.15 format.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#gab4dea2049c8a26118ee4de9b90f1b9bd">arm_correlate_fast_q15()</a> for a faster but less precise version of this function. </dd>
|
|
<dd>
|
|
Refer to <a class="el" href="group__Corr.html#ga3cfae563b16fa3be577cab5acf63aeea">arm_correlate_opt_q15()</a> for a faster implementation of this function using scratch buffers. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9e8ad8bae8400dac2afc995d38594744" name="ga9e8ad8bae8400dac2afc995d38594744"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9e8ad8bae8400dac2afc995d38594744">◆ </a></span>arm_correlate_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 64-bit accumulator. The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit. There is no saturation on intermediate additions. Thus, if the accumulator overflows it wraps around and distorts the result. The input signals should be scaled down to avoid intermediate overflows. Scale down one of the inputs by 1/min(srcALen, srcBLen)to avoid overflows since a maximum of min(srcALen, srcBLen) number of additions is carried internally. 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__Corr.html#ga1e85a8ceac5c0f27007e6ba2c8f20686">arm_correlate_fast_q31()</a> for a faster but less precise implementation of this function. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab5d8acc830313be970de59c2d5a26c72" name="gab5d8acc830313be970de59c2d5a26c72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab5d8acc830313be970de59c2d5a26c72">◆ </a></span>arm_correlate_q7()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_correlate_q7 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pSrcA</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcALen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pSrcB</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcBLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td>
|
|
<td class="paramname"><em>pDst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcA</td><td>points to the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcALen</td><td>length of the first input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcBLen</td><td>length of the second input sequence </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
|
|
<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 32-bit internal accumulator. Both the inputs 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. This approach provides 17 guard bits and there is no risk of overflow as long as <code>max(srcALen, srcBLen)<131072</code>. The 18.14 result is then truncated to 18.7 format by discarding the low 7 bits and saturated to 1.7 format.</dd></dl>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>Refer to <a class="el" href="group__Corr.html#ga3c672e8ef8360c652d351097535f080d">arm_correlate_opt_q7()</a> for a faster implementation of this function. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">
|
|
<script type="text/javascript">
|
|
<!--
|
|
writeFooter.call(this);
|
|
//-->
|
|
</script>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|