711 lines
33 KiB
HTML
711 lines
33 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
|
|
<title>math_helper.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="cmsis.css" rel="stylesheet" type="text/css" />
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div! -->
|
|
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 46px;">
|
|
<td id="proglogo"><img alt="CMSIS Logo" src="CMSIS_Logo_Final.png"></td>
|
|
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">CMSIS-DSP
|
|
 <span id="projectnumber">Verison 1.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS DSP Software Library</div>
|
|
</td>
|
|
|
|
|
|
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
|
|
<div id="CMSISnav" class="tabs1">
|
|
<ul class="tablist">
|
|
<li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
|
|
<li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
|
|
<li class="current"><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
|
|
<li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
|
|
<li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.7.5.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
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.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
initNavTree('math__helper_8h.html','');
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">math_helper.h File Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#aeea2952e70a1040a6efa555564bbeeab">arm_snr_f32</a> (float *pRef, float *pTest, uint32_t buffSize)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Caluclation of SNR. <a href="#aeea2952e70a1040a6efa555564bbeeab"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a23f94b0fbfed6d620f38e26bc64cf2f8">arm_float_to_q12_20</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts float to fixed in q12.20 format. <a href="#a23f94b0fbfed6d620f38e26bc64cf2f8"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#ac8209be1b8081e833c3ec2e85ad2255b">arm_provide_guard_bits_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *input_buf, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, uint32_t guard_bits)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide guard bits for Input buffer. <a href="#ac8209be1b8081e833c3ec2e85ad2255b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#aead320f821f927000386d9d7d5ad6d27">arm_provide_guard_bits_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *input_buf, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, uint32_t guard_bits)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide guard bits for Input buffer. <a href="#aead320f821f927000386d9d7d5ad6d27"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a23cdb5202efd9233f4e92b5f22287eac">arm_float_to_q14</a> (float *pIn, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts float to fixed q14. <a href="#a23cdb5202efd9233f4e92b5f22287eac"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a098c587b93469a7a6bcc521d42fdf6f9">arm_float_to_q29</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts float to fixed q30 format. <a href="#a098c587b93469a7a6bcc521d42fdf6f9"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#aa1049b3adb14331612bb762237391625">arm_float_to_q28</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts float to fixed q28 format. <a href="#aa1049b3adb14331612bb762237391625"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a16764fdbc174a79f04b07032cf902079">arm_float_to_q30</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts float to fixed q30 format. <a href="#a16764fdbc174a79f04b07032cf902079"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#ab9768d92bb94894d8294047bdf76a16a">arm_clip_f32</a> (float *pIn, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clip the float values to +/- 1. <a href="#ab9768d92bb94894d8294047bdf76a16a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a60ff6e0b31a5e9105c7280797e457742">arm_calc_guard_bits</a> (uint32_t num_adds)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Caluclates number of guard bits. <a href="#a60ff6e0b31a5e9105c7280797e457742"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a13580a6ff7a8a68146de727bdf8fba88">arm_apply_guard_bits</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIn, uint32_t numSamples, uint32_t guard_bits)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts Q15 to floating-point. <a href="#a13580a6ff7a8a68146de727bdf8fba88"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a64d5207c035db13cddde479317dd131e">arm_compare_fixed_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pIn, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare MATLAB Reference Output and ARM Test output. <a href="#a64d5207c035db13cddde479317dd131e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a32f9f3d19e53161382c5bd39e3df50fb">arm_compare_fixed_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare MATLAB Reference Output and ARM Test output. <a href="#a32f9f3d19e53161382c5bd39e3df50fb"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="math__helper_8h.html#a7c94faac575a175e824d5f9879c97c68">arm_calc_2pow</a> (uint32_t guard_bits)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates pow(2, numShifts) <a href="#a7c94faac575a175e824d5f9879c97c68"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="a13580a6ff7a8a68146de727bdf8fba88"></a><!-- doxytag: member="math_helper.h::arm_apply_guard_bits" ref="a13580a6ff7a8a68146de727bdf8fba88" args="(float32_t *pIn, uint32_t numSamples, uint32_t guard_bits)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_apply_guard_bits </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td>
|
|
<td class="paramname"><em>pIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>guard_bits</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
|
|
|
|
<p>References <a class="el" href="math__helper_8h.html#a7c94faac575a175e824d5f9879c97c68">arm_calc_2pow()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7c94faac575a175e824d5f9879c97c68"></a><!-- doxytag: member="math_helper.h::arm_calc_2pow" ref="a7c94faac575a175e824d5f9879c97c68" args="(uint32_t guard_bits)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t arm_calc_2pow </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numShifts</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of shifts </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>pow(2, numShifts) </dd></dl>
|
|
|
|
<p>Referenced by <a class="el" href="math__helper_8c.html#a13580a6ff7a8a68146de727bdf8fba88">arm_apply_guard_bits()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a60ff6e0b31a5e9105c7280797e457742"></a><!-- doxytag: member="math_helper.h::arm_calc_guard_bits" ref="a60ff6e0b31a5e9105c7280797e457742" args="(uint32_t num_adds)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t arm_calc_guard_bits </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>num_adds</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of additions </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function Caluclates the number of guard bits depending on the numtaps </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab9768d92bb94894d8294047bdf76a16a"></a><!-- doxytag: member="math_helper.h::arm_clip_f32" ref="ab9768d92bb94894d8294047bdf76a16a" args="(float *pIn, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_clip_f32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pIn</td><td>input buffer </td></tr>
|
|
<tr><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a64d5207c035db13cddde479317dd131e"></a><!-- doxytag: member="math_helper.h::arm_compare_fixed_q15" ref="a64d5207c035db13cddde479317dd131e" args="(q15_t *pIn, q15_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t arm_compare_fixed_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>pIn</em>, </td>
|
|
</tr>
|
|
<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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q15_t*</td><td>Pointer to Ref buffer </td></tr>
|
|
<tr><td class="paramname">q15_t*</td><td>Pointer to Test buffer </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a32f9f3d19e53161382c5bd39e3df50fb"></a><!-- doxytag: member="math_helper.h::arm_compare_fixed_q31" ref="a32f9f3d19e53161382c5bd39e3df50fb" args="(q31_t *pIn, q31_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t arm_compare_fixed_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>pIn</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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q31_t*</td><td>Pointer to Ref buffer </td></tr>
|
|
<tr><td class="paramname">q31_t*</td><td>Pointer to Test buffer </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a23f94b0fbfed6d620f38e26bc64cf2f8"></a><!-- doxytag: member="math_helper.h::arm_float_to_q12_20" ref="a23f94b0fbfed6d620f38e26bc64cf2f8" args="(float *pIn, q31_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_float_to_q12_20 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point(q12.20) values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a23cdb5202efd9233f4e92b5f22287eac"></a><!-- doxytag: member="math_helper.h::arm_float_to_q14" ref="a23cdb5202efd9233f4e92b5f22287eac" args="(float *pIn, q15_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_float_to_q14 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</em>, </td>
|
|
</tr>
|
|
<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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa1049b3adb14331612bb762237391625"></a><!-- doxytag: member="math_helper.h::arm_float_to_q28" ref="aa1049b3adb14331612bb762237391625" args="(float *pIn, q31_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_float_to_q28 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a098c587b93469a7a6bcc521d42fdf6f9"></a><!-- doxytag: member="math_helper.h::arm_float_to_q29" ref="a098c587b93469a7a6bcc521d42fdf6f9" args="(float *pIn, q31_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_float_to_q29 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a16764fdbc174a79f04b07032cf902079"></a><!-- doxytag: member="math_helper.h::arm_float_to_q30" ref="a16764fdbc174a79f04b07032cf902079" args="(float *pIn, q31_t *pOut, uint32_t numSamples)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_float_to_q30 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pIn</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="paramname"><em>pOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>numSamples</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uint32_t</td><td>number of samples in the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function converts floating point values to fixed point values </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac8209be1b8081e833c3ec2e85ad2255b"></a><!-- doxytag: member="math_helper.h::arm_provide_guard_bits_q15" ref="ac8209be1b8081e833c3ec2e85ad2255b" args="(q15_t *input_buf, uint32_t blockSize, uint32_t guard_bits)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_provide_guard_bits_q15 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td>
|
|
<td class="paramname"><em>input_buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>blockSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>guard_bits</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q15_t*</td><td>Pointer to input buffer </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>blockSize </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>guard_bits </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function Provides the guard bits for the buffer to avoid overflow </dd></dl>
|
|
|
|
<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aead320f821f927000386d9d7d5ad6d27"></a><!-- doxytag: member="math_helper.h::arm_provide_guard_bits_q31" ref="aead320f821f927000386d9d7d5ad6d27" args="(q31_t *input_buf, uint32_t blockSize, uint32_t guard_bits)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_provide_guard_bits_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>input_buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>blockSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>guard_bits</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q31_t*</td><td>Pointer to input buffer </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>blockSize </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>guard_bits </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>none The function Provides the guard bits for the buffer to avoid overflow </dd></dl>
|
|
|
|
<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeea2952e70a1040a6efa555564bbeeab"></a><!-- doxytag: member="math_helper.h::arm_snr_f32" ref="aeea2952e70a1040a6efa555564bbeeab" args="(float *pRef, float *pTest, uint32_t buffSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float arm_snr_f32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pRef</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>pTest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>buffSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">float*</td><td>Pointer to the reference buffer </td></tr>
|
|
<tr><td class="paramname">float*</td><td>Pointer to the test buffer </td></tr>
|
|
<tr><td class="paramname">uint32_t</td><td>total number of samples </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>float SNR The function Caluclates signal to noise ratio for the reference output and test output </dd></dl>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_convolution_example_f32_8c-example.html#a19">arm_convolution_example_f32.c</a>, <a class="el" href="arm_fir_example_f32_8c-example.html#a16">arm_fir_example_f32.c</a>, <a class="el" href="arm_graphic_equalizer_example_q31_8c-example.html#a29">arm_graphic_equalizer_example_q31.c</a>, <a class="el" href="arm_linear_interp_example_f32_8c-example.html#a14">arm_linear_interp_example_f32.c</a>, and <a class="el" href="arm_matrix_example_f32_8c-example.html#a15">arm_matrix_example_f32.c</a>.</dd>
|
|
</dl>
|
|
<p>Referenced by <a class="el" href="arm__convolution__example__f32_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="math__helper_8h.html">math_helper.h</a> </li>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></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>
|
|
|
|
|
|
<li class="footer">Generated on Wed Mar 28 2012 15:38:08 for CMSIS-DSP by ARM Ltd. All rights reserved.
|
|
<!--
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|