Sophie

Sophie

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

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__fff__generic" kind="class" prot="public">
    <compoundname>gr_fir_fff_generic</compoundname>
    <basecompoundref refid="classgr__fir__fff" prot="public" virt="non-virtual">gr_fir_fff</basecompoundref>
    <derivedcompoundref refid="classgr__fir__fff__altivec" prot="public" virt="non-virtual">gr_fir_fff_altivec</derivedcompoundref>
    <derivedcompoundref refid="classgr__fir__fff__simd" prot="public" virt="non-virtual">gr_fir_fff_simd</derivedcompoundref>
    <includes refid="gr__fir__fff__generic_8h" local="no">gr_fir_fff_generic.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__fir__fff__generic_1a9499e5c3163a6ff74ab8c9df503b775e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fff_generic::gr_fir_fff_generic</definition>
        <argsstring>()</argsstring>
        <name>gr_fir_fff_generic</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fff_generic.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fff_generic.h" bodystart="41" bodyend="41"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fff__generic_1a9ce7456c777a58bb2ecbe6e1343c1be6" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_fir_fff_generic::gr_fir_fff_generic</definition>
        <argsstring>(const std::vector&lt; float &gt; &amp;taps)</argsstring>
        <name>gr_fir_fff_generic</name>
        <param>
          <type>const <ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; float &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_fff_generic.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fff_generic.h" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fff__generic_1a9c78953f14ec2db18421d53309ab2541" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>float</type>
        <definition>virtual float gr_fir_fff_generic::filter</definition>
        <argsstring>(const float input[])</argsstring>
        <name>filter</name>
        <reimplements refid="classgr__fir__fff_1aea3a56a189c75c3752900d05a5b627d3">filter</reimplements>
        <reimplementedby refid="classgr__fir__fff__simd_1af7851e658801505687df0f94f85fb34a">filter</reimplementedby>
        <reimplementedby refid="classgr__fir__fff__altivec_1aa1b8a9d8435b82e208047ab6b79d05be">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__fff_1ac199a4f381799624a28559c9d8f76826" kindref="member">ntaps()</ref> valid entries. input[0] .. input[<ref refid="classgr__fir__fff_1ac199a4f381799624a28559c9d8f76826" 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_fff_generic.h" line="54"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fff__generic_1a7e3e776a481dabaf2511e8c1cb70dcc4" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fff_generic::filterN</definition>
        <argsstring>(float output[], const float input[], unsigned long n)</argsstring>
        <name>filterN</name>
        <reimplements refid="classgr__fir__fff_1ad53a1e12dd89e647fdbeea37691df85a">filterN</reimplements>
        <param>
          <type>float</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__fff_1ac199a4f381799624a28559c9d8f76826" kindref="member">ntaps()</ref>) valid entries. input[0] .. input[n - 1 + <ref refid="classgr__fir__fff_1ac199a4f381799624a28559c9d8f76826" 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_fff_generic.h" line="63"/>
      </memberdef>
      <memberdef kind="function" id="classgr__fir__fff__generic_1aad21a689717ce5e0f1fd7bcdd798ca49" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>virtual void gr_fir_fff_generic::filterNdec</definition>
        <argsstring>(float output[], const float input[], unsigned long n, unsigned decimate)</argsstring>
        <name>filterNdec</name>
        <reimplements refid="classgr__fir__fff_1a930255550bf68802cd694fe79091738f">filterNdec</reimplements>
        <param>
          <type>float</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__fff_1ac199a4f381799624a28559c9d8f76826" kindref="member">ntaps()</ref>) valid entries. input[0] .. input[decimate * (n - 1) + <ref refid="classgr__fir__fff_1ac199a4f381799624a28559c9d8f76826" 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_fff_generic.h" line="73"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Concrete class for generic implementation of FIR with float input, float output and float 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="8558">
        <label>gr_fir_fff_generic</label>
        <link refid="classgr__fir__fff__generic"/>
        <childnode refid="8559" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8560">
        <label>gr_fir_fff_altivec</label>
        <link refid="classgr__fir__fff__altivec"/>
        <childnode refid="8558" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8559">
        <label>gr_fir_fff</label>
        <link refid="classgr__fir__fff"/>
      </node>
      <node id="8563">
        <label>gr_fir_fff_sse</label>
        <link refid="classgr__fir__fff__sse"/>
        <childnode refid="8561" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8561">
        <label>gr_fir_fff_simd</label>
        <link refid="classgr__fir__fff__simd"/>
        <childnode refid="8558" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8562">
        <label>gr_fir_fff_3dnow</label>
        <link refid="classgr__fir__fff__3dnow"/>
        <childnode refid="8561" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="8564">
        <label>gr_fir_fff_generic</label>
        <link refid="classgr__fir__fff__generic"/>
        <childnode refid="8565" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8565">
        <label>gr_fir_fff</label>
        <link refid="classgr__fir__fff"/>
        <childnode refid="8566" relation="usage">
          <edgelabel>d_taps</edgelabel>
        </childnode>
      </node>
      <node id="8566">
        <label>std::vector&lt; float &gt;</label>
        <link refid="classstd_1_1vector"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fff_generic.h" line="35" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_fir_fff_generic.h" bodystart="35" bodyend="75"/>
    <listofallmembers>
      <member refid="classgr__fir__fff_1a1777535e2e5c1ea2618e6034bf27cd03" prot="protected" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>d_taps</name></member>
      <member refid="classgr__fir__fff__generic_1a9c78953f14ec2db18421d53309ab2541" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>filter</name></member>
      <member refid="classgr__fir__fff__generic_1a7e3e776a481dabaf2511e8c1cb70dcc4" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>filterN</name></member>
      <member refid="classgr__fir__fff__generic_1aad21a689717ce5e0f1fd7bcdd798ca49" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>filterNdec</name></member>
      <member refid="classgr__fir__fff_1a4c8fdac7c6d2d3eea81064c7ed5f25e6" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>get_taps</name></member>
      <member refid="classgr__fir__fff_1abb048967e21dc9aca56e551ff4042eec" prot="public" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>gr_fir_fff</name></member>
      <member refid="classgr__fir__fff_1a9f7f901a8030ba8e8940a0c9cd3d795d" prot="public" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>gr_fir_fff</name></member>
      <member refid="classgr__fir__fff__generic_1a9499e5c3163a6ff74ab8c9df503b775e" prot="public" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>gr_fir_fff_generic</name></member>
      <member refid="classgr__fir__fff__generic_1a9ce7456c777a58bb2ecbe6e1343c1be6" prot="public" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>gr_fir_fff_generic</name></member>
      <member refid="classgr__fir__fff_1ac199a4f381799624a28559c9d8f76826" prot="public" virt="non-virtual"><scope>gr_fir_fff_generic</scope><name>ntaps</name></member>
      <member refid="classgr__fir__fff_1ad692c67d571c9fdd45a214bac28c38d6" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>set_taps</name></member>
      <member refid="classgr__fir__fff_1acf438d5de004cd0a852358d52d8d1609" prot="public" virt="virtual"><scope>gr_fir_fff_generic</scope><name>~gr_fir_fff</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>