git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__sin.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: Sine</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42 </div>
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#func-members">Functions</a> &#124;
  46 <a href="#var-members">Variables</a>  </div>
  47   <div class="headertitle">
  48 <h1>Sine<br/>
  49 <small>
  50 [<a class="el" href="group__group_fast_math.html">Fast Math Functions</a>]</small>
  51 </h1>  </div>
  52 </div>
  53 <div class="contents">
  54 <table class="memberdecls">
  55 <tr><td colspan="2"><h2><a name="func-members"></a>
  56 Functions</h2></td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#gae164899c4a3fc0e946dc5d55555fe541">arm_sin_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> x)</td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#ga57aade7d8892585992cdc6375bd82f9c">arm_sin_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> x)</td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#ga1fc6d6640be6cfa688a8bea0a48397ee">arm_sin_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> x)</td></tr>
  60 <tr><td colspan="2"><h2><a name="var-members"></a>
  61 Variables</h2></td></tr>
  62 <tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#ga71a0a466c6d42c65526968509b04790c">sinTable</a> [259]</td></tr>
  63 <tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#gab1ffde7f3deee5adc75ba8b3d0a53106">sinTableQ31</a> [259]</td></tr>
  64 <tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sin.html#ga0bb9449f52f04f5241f073864a72930a">sinTableQ15</a> [259]</td></tr>
  65 </table>
  66 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  67 <p>Computes the trigonometric sine function using a combination of table lookup and cubic interpolation. There are separate functions for Q15, Q31, and floating-point data types. The input to the floating-point version is in radians while the fixed-point Q15 and Q31 have a scaled input with the range [0 1) mapping to [0 2*pi).</p>
  68 <p>The implementation is based on table lookup using 256 values together with cubic interpolation. The steps used are:</p>
  69 <ol type="1">
  70 <li>Calculation of the nearest integer table index</li>
  71 <li>Fetch the four table values a, b, c, and d</li>
  72 <li>Compute the fractional portion (fract) of the table index.</li>
  73 <li>Calculation of wa, wb, wc, wd</li>
  74 <li>The final result equals <code>a*wa + b*wb + c*wc + d*wd</code></li>
  75 </ol>
  76 <p>where </p>
  77 <pre>
  78     a=Table[index-1];
  79     b=Table[index+0];
  80     c=Table[index+1];
  81     d=Table[index+2];
  82  </pre><p> and </p>
  83 <pre>
  84     wa=-(1/6)*fract.^3 + (1/2)*fract.^2 - (1/3)*fract;
  85     wb=(1/2)*fract.^3 - fract.^2 - (1/2)*fract + 1;
  86     wc=-(1/2)*fract.^3+(1/2)*fract.^2+fract;
  87     wd=(1/6)*fract.^3 - (1/6)*fract;
  88  </pre> <hr/><h2>Function Documentation</h2>
  89 <a class="anchor" id="gae164899c4a3fc0e946dc5d55555fe541"></a><!-- doxytag: member="arm_sin_f32.c::arm_sin_f32" ref="gae164899c4a3fc0e946dc5d55555fe541" args="(float32_t x)" -->
  90 <div class="memitem">
  91 <div class="memproto">
  92       <table class="memname">
  93         <tr>
  94           <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_sin_f32 </td>
  95           <td>(</td>
  96           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  97           <td class="paramname"> <em>x</em>&#160;)</td>
  98           <td></td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>Fast approximation to the trigonometric sine function for floating-point data. </p>
 105 <dl><dt><b>Parameters:</b></dt><dd>
 106   <table class="params">
 107     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>input value in radians. </td></tr>
 108   </table>
 109   </dd>
 110 </dl>
 111 <dl class="return"><dt><b>Returns:</b></dt><dd>sin(x). </dd></dl>
 112 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_linear_interp_example_f32_8c-example.html#a12">arm_linear_interp_example_f32.c</a>, and <a class="el" href="arm_sin_cos_example_f32_8c-example.html#a12">arm_sin_cos_example_f32.c</a>.</dd>
 113 </dl>
 114 <p>Definition at line <a class="el" href="arm__sin__f32_8c_source.html#l00195">195</a> of file <a class="el" href="arm__sin__f32_8c_source.html">arm_sin_f32.c</a>.</p>
 115
 116 </div>
 117 </div>
 118 <a class="anchor" id="ga57aade7d8892585992cdc6375bd82f9c"></a><!-- doxytag: member="arm_sin_q31.c::arm_sin_q31" ref="ga57aade7d8892585992cdc6375bd82f9c" args="(q31_t x)" -->
 119 <div class="memitem">
 120 <div class="memproto">
 121       <table class="memname">
 122         <tr>
 123           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_sin_q31 </td>
 124           <td>(</td>
 125           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
 126           <td class="paramname"> <em>x</em>&#160;)</td>
 127           <td></td>
 128         </tr>
 129       </table>
 130 </div>
 131 <div class="memdoc">
 132
 133 <p>Fast approximation to the trigonometric sine function for Q31 data. </p>
 134 <dl><dt><b>Parameters:</b></dt><dd>
 135   <table class="params">
 136     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>Scaled input value in radians. </td></tr>
 137   </table>
 138   </dd>
 139 </dl>
 140 <dl class="return"><dt><b>Returns:</b></dt><dd>sin(x).</dd></dl>
 141 <p>The Q31 input value is in the range [0 +1) and is mapped to a radian value in the range [0 2*pi). </p>
 142
 143 <p>Definition at line <a class="el" href="arm__sin__q31_8c_source.html#l00136">136</a> of file <a class="el" href="arm__sin__q31_8c_source.html">arm_sin_q31.c</a>.</p>
 144
 145 </div>
 146 </div>
 147 <a class="anchor" id="ga1fc6d6640be6cfa688a8bea0a48397ee"></a><!-- doxytag: member="arm_sin_q15.c::arm_sin_q15" ref="ga1fc6d6640be6cfa688a8bea0a48397ee" args="(q15_t x)" -->
 148 <div class="memitem">
 149 <div class="memproto">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_sin_q15 </td>
 153           <td>(</td>
 154           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td>
 155           <td class="paramname"> <em>x</em>&#160;)</td>
 156           <td></td>
 157         </tr>
 158       </table>
 159 </div>
 160 <div class="memdoc">
 161
 162 <p>Fast approximation to the trigonometric sine function for Q15 data. </p>
 163 <dl><dt><b>Parameters:</b></dt><dd>
 164   <table class="params">
 165     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>Scaled input value in radians. </td></tr>
 166   </table>
 167   </dd>
 168 </dl>
 169 <dl class="return"><dt><b>Returns:</b></dt><dd>sin(x).</dd></dl>
 170 <p>The Q15 input value is in the range [0 +1) and is mapped to a radian value in the range [0 2*pi). </p>
 171
 172 <p>Definition at line <a class="el" href="arm__sin__q15_8c_source.html#l00106">106</a> of file <a class="el" href="arm__sin__q15_8c_source.html">arm_sin_q15.c</a>.</p>
 173
 174 </div>
 175 </div>
 176 <hr/><h2>Variable Documentation</h2>
 177 <a class="anchor" id="ga71a0a466c6d42c65526968509b04790c"></a><!-- doxytag: member="arm_sin_f32.c::sinTable" ref="ga71a0a466c6d42c65526968509b04790c" args="[259]" -->
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> <a class="el" href="group__sin.html#ga71a0a466c6d42c65526968509b04790c">sinTable</a>[259]<code> [static]</code></td>
 183         </tr>
 184       </table>
 185 </div>
 186 <div class="memdoc">
 187 <dl class="user"><dt><b></b></dt><dd>Example code for Generation of Floating-point Sin Table: tableSize = 256; <pre>for(n = -1; n &lt; (tableSize + 1); n++)
 188  {
 189         sinTable[n+1]=sin(2*pi*n/tableSize);
 190  }</pre> </dd></dl>
 191 <dl class="user"><dt><b></b></dt><dd>where pi value is 3.14159265358979 </dd></dl>
 192
 193 <p>Definition at line <a class="el" href="arm__sin__f32_8c_source.html#l00088">88</a> of file <a class="el" href="arm__sin__f32_8c_source.html">arm_sin_f32.c</a>.</p>
 194
 195 </div>
 196 </div>
 197 <a class="anchor" id="gab1ffde7f3deee5adc75ba8b3d0a53106"></a><!-- doxytag: member="arm_sin_q31.c::sinTableQ31" ref="gab1ffde7f3deee5adc75ba8b3d0a53106" args="[259]" -->
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> <a class="el" href="group__sin.html#gab1ffde7f3deee5adc75ba8b3d0a53106">sinTableQ31</a>[259]<code> [static]</code></td>
 203         </tr>
 204       </table>
 205 </div>
 206 <div class="memdoc">
 207 <dl class="user"><dt><b></b></dt><dd>Tables generated are in Q31(1.31 Fixed point format) Generation of sin values in floating point: <pre>tableSize = 256;
 208  for(n = -1; n &lt; (tableSize + 1); n++)
 209  {
 210         sinTable[n+1]= sin(2*pi*n/tableSize);
 211  } </pre> where pi value is 3.14159265358979 </dd></dl>
 212 <dl class="user"><dt><b></b></dt><dd>Convert Floating point to Q31(Fixed point): (sinTable[i] * pow(2, 31)) </dd></dl>
 213 <dl class="user"><dt><b></b></dt><dd>rounding to nearest integer is done sinTable[i] += (sinTable[i] &gt; 0 ? 0.5 :-0.5); </dd></dl>
 214
 215 <p>Definition at line <a class="el" href="arm__sin__q31_8c_source.html#l00059">59</a> of file <a class="el" href="arm__sin__q31_8c_source.html">arm_sin_q31.c</a>.</p>
 216
 217 </div>
 218 </div>
 219 <a class="anchor" id="ga0bb9449f52f04f5241f073864a72930a"></a><!-- doxytag: member="arm_sin_q15.c::sinTableQ15" ref="ga0bb9449f52f04f5241f073864a72930a" args="[259]" -->
 220 <div class="memitem">
 221 <div class="memproto">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> <a class="el" href="group__sin.html#ga0bb9449f52f04f5241f073864a72930a">sinTableQ15</a>[259]<code> [static]</code></td>
 225         </tr>
 226       </table>
 227 </div>
 228 <div class="memdoc">
 229 <dl class="user"><dt><b></b></dt><dd>Example code for Generation of Q15 Sin Table: </dd></dl>
 230 <dl class="user"><dt><b></b></dt><dd><pre>tableSize = 256;
 231  for(n = -1; n &lt; (tableSize + 1); n++)
 232  {
 233         sinTable[n+1]=sin(2*pi*n/tableSize);
 234  } </pre> where pi value is 3.14159265358979 </dd></dl>
 235 <dl class="user"><dt><b></b></dt><dd>Convert Floating point to Q15(Fixed point): (sinTable[i] * pow(2, 15)) </dd></dl>
 236 <dl class="user"><dt><b></b></dt><dd>rounding to nearest integer is done sinTable[i] += (sinTable[i] &gt; 0 ? 0.5 :-0.5); </dd></dl>
 237
 238 <p>Definition at line <a class="el" href="arm__sin__q15_8c_source.html#l00061">61</a> of file <a class="el" href="arm__sin__q15_8c_source.html">arm_sin_q15.c</a>.</p>
 239
 240 </div>
 241 </div>
 242 </div>
 243 <!--- window showing the filter options -->
 244 <div id="MSearchSelectWindow"
 245      onmouseover="return searchBox.OnSearchSelectShow()"
 246      onmouseout="return searchBox.OnSearchSelectHide()"
 247      onkeydown="return searchBox.OnSearchSelectKey(event)">
 248 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 249
 250 <!-- iframe showing the search results (closed by default) -->
 251 <div id="MSearchResultsWindow">
 252 <iframe src="" frameborder="0"
 253         name="MSearchResults" id="MSearchResults">
 254 </iframe>
 255 </div>
 256
 257 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:20 for CMSIS DSP Software Library by&#160;
 258 <a href="http://www.doxygen.org/index.html">
 259 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 260 </body>
 261 </html>