Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 1654

gnuradio-doc-3.3.0-8mdv2010.1.i586.rpm

<!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>GNU Radio 3.3.0 C++ API: gr_fir_fsf_generic Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>gr_fir_fsf_generic Class Reference</h1><!-- doxytag: class="gr_fir_fsf_generic" --><!-- doxytag: inherits="gr_fir_fsf" -->
<p>Concrete class for generic implementation of FIR with float input, short output and float taps.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="gr__fir__fsf__generic_8h_source.html">gr_fir_fsf_generic.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gr_fir_fsf_generic:</div>
<div class="dynsection">
<div class="center"><img src="classgr__fir__fsf__generic__inherit__graph.png" border="0" usemap="#gr__fir__fsf__generic_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__fir__fsf__generic_inherit__map" id="gr__fir__fsf__generic_inherit__map">
<area shape="rect" id="node5" href="classgr__fir__fsf__simd.html" title="common base class for SIMD versions of gr_fir_fsfThis base class handles alignment..." alt="" coords="77,160,184,189"/><area shape="rect" id="node2" href="classgr__fir__fsf.html" title="Abstract class for FIR with float input, short output and float tapsThis is the abstract..." alt="" coords="95,5,167,35"/><area shape="rect" id="node7" href="classgr__fir__fsf__3dnow.html" title="3DNow! version of gr_fir_fsf" alt="" coords="5,237,123,267"/><area shape="rect" id="node9" href="classgr__fir__fsf__sse.html" title="SSE version of gr_fir_fsf." alt="" coords="147,237,248,267"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classgr__fir__fsf__generic-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf__generic.html#ad54060741ad9661759d6d24acc548f0d">gr_fir_fsf_generic</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf__generic.html#aae20245aa49bd786ec8e49e128aaaa40">gr_fir_fsf_generic</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; float &gt; &amp;<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual short&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf__generic.html#a8a88649387d44e24b3c2ab7033087f82">filter</a> (const float input[])</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute a single output value.  <a href="#a8a88649387d44e24b3c2ab7033087f82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf__generic.html#a5a22acd8dae47ae1bc008198ffa68b5e">filterN</a> (short output[], const float input[], unsigned long n)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute an array of N output values.  <a href="#a5a22acd8dae47ae1bc008198ffa68b5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fir__fsf__generic.html#a4893ed68bbc23906e76e5094b50ffbbf">filterNdec</a> (short output[], const float input[], unsigned long n, unsigned decimate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute an array of N output values, decimating the input  <a href="#a4893ed68bbc23906e76e5094b50ffbbf"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Concrete class for generic implementation of FIR with float input, short output and float taps. </p>
<p>The trailing suffix has the form _IOT where I codes the input type, O codes the output type, and T codes the tap type. I,O,T are elements of the set 's' (short), 'f' (float), 'c' (gr_complex), 'i' (int) </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad54060741ad9661759d6d24acc548f0d"></a><!-- doxytag: member="gr_fir_fsf_generic::gr_fir_fsf_generic" ref="ad54060741ad9661759d6d24acc548f0d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gr_fir_fsf_generic::gr_fir_fsf_generic </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aae20245aa49bd786ec8e49e128aaaa40"></a><!-- doxytag: member="gr_fir_fsf_generic::gr_fir_fsf_generic" ref="aae20245aa49bd786ec8e49e128aaaa40" args="(const std::vector&lt; float &gt; &amp;taps)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gr_fir_fsf_generic::gr_fir_fsf_generic </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; float &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>taps</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8a88649387d44e24b3c2ab7033087f82"></a><!-- doxytag: member="gr_fir_fsf_generic::filter" ref="a8a88649387d44e24b3c2ab7033087f82" args="(const float input[])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual short gr_fir_fsf_generic::filter </td>
          <td>(</td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>input</em>[]</td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute a single output value. </p>
<p><code>input</code> must have <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> valid entries. input[0] .. input[<a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output value.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the filtered input value. </dd></dl>

<p>Implements <a class="el" href="classgr__fir__fsf.html#a72d4b9fb5669d54e826b506a288c3b12">gr_fir_fsf</a>.</p>

<p>Reimplemented in <a class="el" href="classgr__fir__fsf__simd.html#a9b221f60ff010490358eed5e39bc9673">gr_fir_fsf_simd</a>.</p>

</div>
</div>
<a class="anchor" id="a5a22acd8dae47ae1bc008198ffa68b5e"></a><!-- doxytag: member="gr_fir_fsf_generic::filterN" ref="a5a22acd8dae47ae1bc008198ffa68b5e" args="(short output[], const float input[], unsigned long n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gr_fir_fsf_generic::filterN </td>
          <td>(</td>
          <td class="paramtype">short&nbsp;</td>
          <td class="paramname"> <em>output</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>input</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&nbsp;</td>
          <td class="paramname"> <em>n</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute an array of N output values. </p>
<p><code>input</code> must have (n - 1 + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a>) valid entries. input[0] .. input[n - 1 + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output values. </p>

<p>Implements <a class="el" href="classgr__fir__fsf.html#a40b807639ff338eea553e9cfbe5b7852">gr_fir_fsf</a>.</p>

</div>
</div>
<a class="anchor" id="a4893ed68bbc23906e76e5094b50ffbbf"></a><!-- doxytag: member="gr_fir_fsf_generic::filterNdec" ref="a4893ed68bbc23906e76e5094b50ffbbf" args="(short output[], const float input[], unsigned long n, unsigned decimate)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gr_fir_fsf_generic::filterNdec </td>
          <td>(</td>
          <td class="paramtype">short&nbsp;</td>
          <td class="paramname"> <em>output</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>input</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&nbsp;</td>
          <td class="paramname"> <em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>decimate</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute an array of N output values, decimating the input </p>
<p><code>input</code> must have (decimate * (n - 1) + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a>) valid entries. input[0] .. input[decimate * (n - 1) + <a class="el" href="classgr__fir__fsf.html#a695ea61ff30c7b9c196571834002da46">ntaps()</a> - 1] are referenced to compute the output values. </p>

<p>Implements <a class="el" href="classgr__fir__fsf.html#abaa7da67d2c6484fcbf5c509b21794ed">gr_fir_fsf</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__fir__fsf__generic_8h_source.html">gr_fir_fsf_generic.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:45 2010 for GNU Radio 3.3.0 C++ API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>