Sophie

Sophie

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

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__generic" kind="class" prot="public">
    <compoundname>gr_fir_fcc_generic</compoundname>
    <basecompoundref refid="classgr__fir__fcc" prot="public" virt="non-virtual">gr_fir_fcc</basecompoundref>
    <derivedcompoundref refid="classgr__fir__fcc__simd" prot="public" virt="non-virtual">gr_fir_fcc_simd</derivedcompoundref>
    <includes refid="gr__fir__fcc__generic_8h" local="no">gr_fir_fcc_generic.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__fir__fcc__generic_1aa8f55866d711f0ac7b09bc8ce9e05f5b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fcc_generic::gr_fir_fcc_generic</definition>
        <argsstring>()</argsstring>
        <name>gr_fir_fcc_generic</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc_generic.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc_generic.h" bodystart="41" bodyend="41"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc__generic_1a5b4dc47c41270356f818371710fb5433" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fcc_generic::gr_fir_fcc_generic</definition>
        <argsstring>(const std::vector&lt; gr_complex &gt; &amp;taps)</argsstring>
        <name>gr_fir_fcc_generic</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_generic.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc_generic.h" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc__generic_1ab72639ddf12ad3838e468235838ab38d" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
        <definition>virtual gr_complex gr_fir_fcc_generic::filter</definition>
        <argsstring>(const float input[])</argsstring>
        <name>filter</name>
        <reimplements refid="classgr__fir__fcc_1a9eabd99e888d13f96677b430b9408df5">filter</reimplements>
        <reimplementedby refid="classgr__fir__fcc__simd_1a868747af1b2acfc6fd376afd12fdcf29">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_generic.h" line="54"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc__generic_1ab6f6924bfaff50518e5ddcf4abc0a2d8" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fcc_generic::filterN</definition>
        <argsstring>(gr_complex output[], const float input[], unsigned long n)</argsstring>
        <name>filterN</name>
        <reimplements refid="classgr__fir__fcc_1a6fab43ec65ca46a32eb52ec18b0bd669">filterN</reimplements>
        <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_generic.h" line="63"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fcc__generic_1a57bccce1991278446982c0e9c1b7fbae" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fcc_generic::filterNdec</definition>
        <argsstring>(gr_complex output[], const float input[], unsigned long n, unsigned decimate)</argsstring>
        <name>filterNdec</name>
        <reimplements refid="classgr__fir__fcc_1ac51ae358b509b4c578ba7a7380cad4c5">filterNdec</reimplements>
        <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_generic.h" line="73"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Concrete class for generic implementation of FIR with float input, gr_complex output and gr_complex taps. </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="8504">
        <label>gr_fir_fcc_sse</label>
        <link refid="classgr__fir__fcc__sse"/>
        <childnode refid="8502" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8501">
        <label>gr_fir_fcc</label>
        <link refid="classgr__fir__fcc"/>
      </node>
      <node id="8500">
        <label>gr_fir_fcc_generic</label>
        <link refid="classgr__fir__fcc__generic"/>
        <childnode refid="8501" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8503">
        <label>gr_fir_fcc_3dnow</label>
        <link refid="classgr__fir__fcc__3dnow"/>
        <childnode refid="8502" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8502">
        <label>gr_fir_fcc_simd</label>
        <link refid="classgr__fir__fcc__simd"/>
        <childnode refid="8500" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="8506">
        <label>gr_fir_fcc</label>
        <link refid="classgr__fir__fcc"/>
        <childnode refid="8507" relation="usage">
          <edgelabel>d_taps</edgelabel>
        </childnode>
      </node>
      <node id="8507">
        <label>std::vector&lt; gr_complex &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="8508" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="8505">
        <label>gr_fir_fcc_generic</label>
        <link refid="classgr__fir__fcc__generic"/>
        <childnode refid="8506" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8508">
        <label>std::complex</label>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc_generic.h" line="35" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fcc_generic.h" bodystart="35" bodyend="75"/>
    <listofallmembers>
      <member refid="classgr__fir__fcc_1a53f351706cdd0e7cc714087eca85002d" prot="protected" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>d_taps</name></member>
      <member refid="classgr__fir__fcc__generic_1ab72639ddf12ad3838e468235838ab38d" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>filter</name></member>
      <member refid="classgr__fir__fcc__generic_1ab6f6924bfaff50518e5ddcf4abc0a2d8" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>filterN</name></member>
      <member refid="classgr__fir__fcc__generic_1a57bccce1991278446982c0e9c1b7fbae" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>filterNdec</name></member>
      <member refid="classgr__fir__fcc_1ab27c9fa920e78e94219575cca834522a" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>get_taps</name></member>
      <member refid="classgr__fir__fcc_1a602df7de8dc88cda40b9ad4bc9ed4895" prot="public" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>gr_fir_fcc</name></member>
      <member refid="classgr__fir__fcc_1a8485ef01a775803216857a97066687b6" prot="public" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>gr_fir_fcc</name></member>
      <member refid="classgr__fir__fcc__generic_1aa8f55866d711f0ac7b09bc8ce9e05f5b" prot="public" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>gr_fir_fcc_generic</name></member>
      <member refid="classgr__fir__fcc__generic_1a5b4dc47c41270356f818371710fb5433" prot="public" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>gr_fir_fcc_generic</name></member>
      <member refid="classgr__fir__fcc_1a480be7ebc5d223ab61a8a375486acb41" prot="public" virt="non-virtual"><scope>gr_fir_fcc_generic</scope><name>ntaps</name></member>
      <member refid="classgr__fir__fcc_1a03a29e78ad8ea447e52f20156b2b2601" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>set_taps</name></member>
      <member refid="classgr__fir__fcc_1a396ea765ab9c6f2535e927b09342933b" prot="public" virt="virtual"><scope>gr_fir_fcc_generic</scope><name>~gr_fir_fcc</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>