Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7603

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="classgr__fir__fcc" kind="class" prot="public">
    <compoundname>gr_fir_fcc</compoundname>
    <derivedcompoundref refid="classgr__fir__fcc__generic" prot="public" virt="non-virtual">gr_fir_fcc_generic</derivedcompoundref>
    <includes refid="gr__fir__fcc_8h" local="no">gr_fir_fcc.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" prot="protected" static="no" mutable="no">
        <type><ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref> &gt;</type>
        <definition>std::vector&lt;gr_complex&gt; gr_fir_fcc::d_taps</definition>
        <argsstring></argsstring>
        <name>d_taps</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="50" bodyend="-1"/>
        <referencedby refid="classgr__fir__fcc_1ab27c9fa920e78e94219575cca834522a" compoundref="gr__fir__fcc_8h" startline="117" endline="120">get_taps</referencedby>
        <referencedby refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" compoundref="gr__fir__fcc_8h" startline="112" endline="112">ntaps</referencedby>
        <referencedby refid="classgr__fir__fcc_1a03a29e78ad8ea447e52f20156b2b2601" compoundref="gr__fir__fcc_8h" startline="102" endline="105">set_taps</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__fir__fcc_1a602df7de8dc88cda40b9ad4bc9ed4895" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fcc::gr_fir_fcc</definition>
        <argsstring>()</argsstring>
        <name>gr_fir_fcc</name>
        <briefdescription>
<para>construct new FIR with given taps. </para>        </briefdescription>
        <detaileddescription>
<para>Note that taps must be in forward order, e.g., coefficient 0 is stored in new_taps[0], coefficient 1 is stored in new_taps[1], etc. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="63" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="63" bodyend="63"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a8485ef01a775803216857a97066687b6" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fcc::gr_fir_fcc</definition>
        <argsstring>(const std::vector&lt; gr_complex &gt; &amp;taps)</argsstring>
        <name>gr_fir_fcc</name>
        <param>
          <type>const <ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref> &gt; &amp;</type>
          <declname>taps</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="64" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="64" bodyend="64"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a396ea765ab9c6f2535e927b09342933b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual gr_fir_fcc::~gr_fir_fcc</definition>
        <argsstring>()</argsstring>
        <name>~gr_fir_fcc</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="66"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a9eabd99e888d13f96677b430b9408df5" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
        <definition>virtual gr_complex gr_fir_fcc::filter</definition>
        <argsstring>(const float input[])=0</argsstring>
        <name>filter</name>
        <reimplementedby refid="classgr__fir__fcc__simd_1a868747af1b2acfc6fd376afd12fdcf29">filter</reimplementedby>
        <reimplementedby refid="classgr__fir__fcc__generic_1ab72639ddf12ad3838e468235838ab38d">filter</reimplementedby>
        <param>
          <type>const float</type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <briefdescription>
<para>compute a single output value. </para>        </briefdescription>
        <detaileddescription>
<para><computeroutput>input</computeroutput> must have <ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref> valid entries. input[0] .. input[<ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref> - 1] are referenced to compute the output value.</para><para><simplesect kind="return"><para>the filtered input value. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="78"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a6fab43ec65ca46a32eb52ec18b0bd669" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fcc::filterN</definition>
        <argsstring>(gr_complex output[], const float input[], unsigned long n)=0</argsstring>
        <name>filterN</name>
        <reimplementedby refid="classgr__fir__fcc__generic_1ab6f6924bfaff50518e5ddcf4abc0a2d8">filterN</reimplementedby>
        <param>
          <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
          <declname>output</declname>
          <array>[]</array>
        </param>
        <param>
          <type>const float</type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <param>
          <type>unsigned long</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>compute an array of N output values. </para>        </briefdescription>
        <detaileddescription>
<para><computeroutput>input</computeroutput> must have (n - 1 + <ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref>) valid entries. input[0] .. input[n - 1 + <ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref> - 1] are referenced to compute the output values. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="87"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1ac51ae358b509b4c578ba7a7380cad4c5" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fcc::filterNdec</definition>
        <argsstring>(gr_complex output[], const float input[], unsigned long n, unsigned decimate)=0</argsstring>
        <name>filterNdec</name>
        <reimplementedby refid="classgr__fir__fcc__generic_1a57bccce1991278446982c0e9c1b7fbae">filterNdec</reimplementedby>
        <param>
          <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
          <declname>output</declname>
          <array>[]</array>
        </param>
        <param>
          <type>const float</type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <param>
          <type>unsigned long</type>
          <declname>n</declname>
        </param>
        <param>
          <type>unsigned</type>
          <declname>decimate</declname>
        </param>
        <briefdescription>
<para>compute an array of N output values, decimating the input </para>        </briefdescription>
        <detaileddescription>
<para><computeroutput>input</computeroutput> must have (decimate * (n - 1) + <ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref>) valid entries. input[0] .. input[decimate * (n - 1) + <ref refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" kindref="member">ntaps()</ref> - 1] are referenced to compute the output values. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="97"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a03a29e78ad8ea447e52f20156b2b2601" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fcc::set_taps</definition>
        <argsstring>(const std::vector&lt; gr_complex &gt; &amp;taps)</argsstring>
        <name>set_taps</name>
        <reimplementedby refid="classgr__fir__fcc__simd_1addafd951a10d29910605186df87db899">set_taps</reimplementedby>
        <param>
          <type>const <ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref> &gt; &amp;</type>
          <declname>taps</declname>
        </param>
        <briefdescription>
<para>install <computeroutput>new_taps</computeroutput> as the current taps. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="103" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="102" bodyend="105"/>
        <references refid="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" compoundref="gr__fir__fcc_8h" startline="50">d_taps</references>
        <references refid="gr__reverse_8h_1a0e0995ad6539dd54e5e331ccb3681932">gr_reverse</references>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>unsigned</type>
        <definition>unsigned gr_fir_fcc::ntaps</definition>
        <argsstring>() const </argsstring>
        <name>ntaps</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>number of taps in filter. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="112" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="112" bodyend="112"/>
        <references refid="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" compoundref="gr__fir__fcc_8h" startline="50">d_taps</references>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc_1ab27c9fa920e78e94219575cca834522a" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>const <ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref> &gt;</type>
        <definition>virtual const std::vector&lt;gr_complex&gt; gr_fir_fcc::get_taps</definition>
        <argsstring>() const </argsstring>
        <name>get_taps</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>current taps </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="118" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="117" bodyend="120"/>
        <references refid="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" compoundref="gr__fir__fcc_8h" startline="50">d_taps</references>
        <references refid="gr__reverse_8h_1a0e0995ad6539dd54e5e331ccb3681932">gr_reverse</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Abstract class for FIR with float input, gr_complex output and gr_complex taps</para><para>This is the abstract class for a Finite Impulse Response filter. </para>    </briefdescription>
    <detaileddescription>
<para>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 &apos;s&apos; (short), &apos;f&apos; (float), &apos;c&apos; (gr_complex), &apos;i&apos; (int) </para>    </detaileddescription>
    <inheritancegraph>
      <node id="8486">
        <label>gr_fir_fcc_sse</label>
        <link refid="classgr__fir__fcc__sse"/>
        <childnode refid="8484" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8482">
        <label>gr_fir_fcc</label>
        <link refid="classgr__fir__fcc"/>
      </node>
      <node id="8483">
        <label>gr_fir_fcc_generic</label>
        <link refid="classgr__fir__fcc__generic"/>
        <childnode refid="8482" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8485">
        <label>gr_fir_fcc_3dnow</label>
        <link refid="classgr__fir__fcc__3dnow"/>
        <childnode refid="8484" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8484">
        <label>gr_fir_fcc_simd</label>
        <link refid="classgr__fir__fcc__simd"/>
        <childnode refid="8483" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="8487">
        <label>gr_fir_fcc</label>
        <link refid="classgr__fir__fcc"/>
        <childnode refid="8488" relation="usage">
          <edgelabel>d_taps</edgelabel>
        </childnode>
      </node>
      <node id="8488">
        <label>std::vector&lt; gr_complex &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="8489" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="8489">
        <label>std::complex</label>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc.h" bodystart="47" bodyend="121"/>
    <listofallmembers>
      <member refid="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" prot="protected" virt="non-virtual"><scope>gr_fir_fcc</scope><name>d_taps</name></member>
      <member refid="classgr__fir__fcc_1a9eabd99e888d13f96677b430b9408df5" prot="public" virt="pure-virtual"><scope>gr_fir_fcc</scope><name>filter</name></member>
      <member refid="classgr__fir__fcc_1a6fab43ec65ca46a32eb52ec18b0bd669" prot="public" virt="pure-virtual"><scope>gr_fir_fcc</scope><name>filterN</name></member>
      <member refid="classgr__fir__fcc_1ac51ae358b509b4c578ba7a7380cad4c5" prot="public" virt="pure-virtual"><scope>gr_fir_fcc</scope><name>filterNdec</name></member>
      <member refid="classgr__fir__fcc_1ab27c9fa920e78e94219575cca834522a" prot="public" virt="virtual"><scope>gr_fir_fcc</scope><name>get_taps</name></member>
      <member refid="classgr__fir__fcc_1a602df7de8dc88cda40b9ad4bc9ed4895" prot="public" virt="non-virtual"><scope>gr_fir_fcc</scope><name>gr_fir_fcc</name></member>
      <member refid="classgr__fir__fcc_1a8485ef01a775803216857a97066687b6" prot="public" virt="non-virtual"><scope>gr_fir_fcc</scope><name>gr_fir_fcc</name></member>
      <member refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" prot="public" virt="non-virtual"><scope>gr_fir_fcc</scope><name>ntaps</name></member>
      <member refid="classgr__fir__fcc_1a03a29e78ad8ea447e52f20156b2b2601" prot="public" virt="virtual"><scope>gr_fir_fcc</scope><name>set_taps</name></member>
      <member refid="classgr__fir__fcc_1a396ea765ab9c6f2535e927b09342933b" prot="public" virt="virtual"><scope>gr_fir_fcc</scope><name>~gr_fir_fcc</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>