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.
295 lines
14 KiB
HTML
295 lines
14 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: arm_lms_norm_instance_q31 Struct Reference</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><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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</span></a></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('structarm__lms__norm__instance__q31.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="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">arm_lms_norm_instance_q31 Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Instance structure for the Q31 normalized LMS filter.
|
|
</p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a751941891e47f522a7f5375fe8990aac"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a751941891e47f522a7f5375fe8990aac">numTaps</a></td></tr>
|
|
<tr class="separator:a751941891e47f522a7f5375fe8990aac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adee4ba3ee8869865af7d8fa08ca913d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#adee4ba3ee8869865af7d8fa08ca913d6">pState</a></td></tr>
|
|
<tr class="separator:adee4ba3ee8869865af7d8fa08ca913d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68888e36167d81cb7836db10367a1682"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a68888e36167d81cb7836db10367a1682">pCoeffs</a></td></tr>
|
|
<tr class="separator:a68888e36167d81cb7836db10367a1682"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21ab4237a726ea7751f5026d89d2e577"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a21ab4237a726ea7751f5026d89d2e577">mu</a></td></tr>
|
|
<tr class="separator:a21ab4237a726ea7751f5026d89d2e577"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74050e9f36542bd56f4052381a82ae8f"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a74050e9f36542bd56f4052381a82ae8f">postShift</a></td></tr>
|
|
<tr class="separator:a74050e9f36542bd56f4052381a82ae8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2e860f11b18d416a6b9aeb4660694dc"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#ac2e860f11b18d416a6b9aeb4660694dc">recipTable</a></td></tr>
|
|
<tr class="separator:ac2e860f11b18d416a6b9aeb4660694dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a012fee0f71095d2557bb633e73ef7355"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a012fee0f71095d2557bb633e73ef7355">energy</a></td></tr>
|
|
<tr class="separator:a012fee0f71095d2557bb633e73ef7355"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a973b8350a0c7b113a5f002bc0b86bf76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a973b8350a0c7b113a5f002bc0b86bf76">x0</a></td></tr>
|
|
<tr class="separator:a973b8350a0c7b113a5f002bc0b86bf76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a012fee0f71095d2557bb633e73ef7355" name="a012fee0f71095d2557bb633e73ef7355"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a012fee0f71095d2557bb633e73ef7355">◆ </a></span>energy</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> energy</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >saves previous frame energy. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21ab4237a726ea7751f5026d89d2e577" name="a21ab4237a726ea7751f5026d89d2e577"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21ab4237a726ea7751f5026d89d2e577">◆ </a></span>mu</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> mu</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >step size that controls filter coefficient updates. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a751941891e47f522a7f5375fe8990aac" name="a751941891e47f522a7f5375fe8990aac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a751941891e47f522a7f5375fe8990aac">◆ </a></span>numTaps</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t numTaps</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >number of coefficients in the filter. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68888e36167d81cb7836db10367a1682" name="a68888e36167d81cb7836db10367a1682"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68888e36167d81cb7836db10367a1682">◆ </a></span>pCoeffs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* pCoeffs</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >points to the coefficient array. The array is of length numTaps. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74050e9f36542bd56f4052381a82ae8f" name="a74050e9f36542bd56f4052381a82ae8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74050e9f36542bd56f4052381a82ae8f">◆ </a></span>postShift</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t postShift</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >bit shift applied to coefficients. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adee4ba3ee8869865af7d8fa08ca913d6" name="adee4ba3ee8869865af7d8fa08ca913d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adee4ba3ee8869865af7d8fa08ca913d6">◆ </a></span>pState</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* pState</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >points to the state variable array. The array is of length numTaps+blockSize-1. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2e860f11b18d416a6b9aeb4660694dc" name="ac2e860f11b18d416a6b9aeb4660694dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2e860f11b18d416a6b9aeb4660694dc">◆ </a></span>recipTable</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* recipTable</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >points to the reciprocal initial value table. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a973b8350a0c7b113a5f002bc0b86bf76" name="a973b8350a0c7b113a5f002bc0b86bf76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a973b8350a0c7b113a5f002bc0b86bf76">◆ </a></span>x0</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> x0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >saves previous input sample. </p>
|
|
|
|
</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="navelem"><a class="el" href="structarm__lms__norm__instance__q31.html">arm_lms_norm_instance_q31</a></li>
|
|
<li class="footer">
|
|
<script type="text/javascript">
|
|
<!--
|
|
writeFooter.call(this);
|
|
//-->
|
|
</script>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|