Sophie

Sophie

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

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__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4" kind="class" prot="public">
    <compoundname>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</compoundname>
    <includes refid="gr__single__pole__iir_8h" local="no">gr_single_pole_iir.h</includes>
    <templateparamlist>
      <param>
        <type>class i_type</type>
      </param>
    </templateparamlist>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a2609b118c141b19665d16e18cc37cf0e" prot="protected" static="no" mutable="no">
        <type>double</type>
        <definition>double gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_alpha</definition>
        <argsstring></argsstring>
        <name>d_alpha</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="161" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="161" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1af5a95fc377d50f3b1f74a4258fdfb9df" prot="protected" static="no" mutable="no">
        <type>double</type>
        <definition>double gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_one_minus_alpha</definition>
        <argsstring></argsstring>
        <name>d_one_minus_alpha</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="162" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="162" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a89dcb1aebab3a22b2fa5186238f696d8" prot="protected" static="no" mutable="no">
        <type><ref refid="gr__complex_8h_1a90c065671dd1c4b7aed7e08b265e23f7" kindref="member">gr_complexd</ref></type>
        <definition>gr_complexd gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::d_prev_output</definition>
        <argsstring></argsstring>
        <name>d_prev_output</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="163" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="163" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a60f697c8924bd2d2ca6a370d606d2483" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::gr_single_pole_iir</definition>
        <argsstring>(double alpha=1.0)</argsstring>
        <name>gr_single_pole_iir</name>
        <param>
          <type>double</type>
          <declname>alpha</declname>
          <defval>1.0</defval>
        </param>
        <briefdescription>
<para>construct new single pole IIR with given alpha </para>        </briefdescription>
        <detaileddescription>
<para>computes y(i) = (1-alpha) * y(i-1) + alpha * x(i) </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="123" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="122" bodyend="126"/>
        <references refid="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" compoundref="gr__single__pole__iir_8h" startline="79">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</references>
        <references refid="classgr__single__pole__iir_1af8f1dfca2e1492caf5ef10a6d01f7851" compoundref="gr__single__pole__iir_8h" startline="59" endline="66">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::set_taps</references>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa833356db2d31691b39b166efd615880" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
        <definition>gr_complex gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filter</definition>
        <argsstring>(const i_type input)</argsstring>
        <name>filter</name>
        <param>
          <type>const i_type</type>
          <declname>input</declname>
        </param>
        <briefdescription>
<para>compute a single output value. </para>        </briefdescription>
        <detaileddescription>
<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_single_pole_iir.h" line="132" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="168" bodyend="176"/>
        <references refid="classgr__single__pole__iir_1a3cecd484003a907e60ff8d0eff8fa887" compoundref="gr__single__pole__iir_8h" startline="77">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_alpha</references>
        <references refid="classgr__single__pole__iir_1a5e0f640e76cd29ba756d962097ede891" compoundref="gr__single__pole__iir_8h" startline="78">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_one_minus_alpha</references>
        <references refid="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" compoundref="gr__single__pole__iir_8h" startline="79">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</references>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a8e96513599ab00798aac14f76b451ca2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filterN</definition>
        <argsstring>(gr_complex output[], const i_type input[], unsigned long n)</argsstring>
        <name>filterN</name>
        <param>
          <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
          <declname>output</declname>
          <array>[]</array>
        </param>
        <param>
          <type>const i_type</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. <computeroutput>input</computeroutput> must have n valid entries. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="138" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="182" bodyend="188"/>
        <references refid="classgr__single__pole__iir_1ad8cecedbfed0bc1f24524d08914288c7" compoundref="gr__single__pole__iir_8h" startline="88" endline="96">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::filter</references>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa97e7a76ddbefd08b3a32d674891ce8a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::set_taps</definition>
        <argsstring>(double alpha)</argsstring>
        <name>set_taps</name>
        <param>
          <type>double</type>
          <declname>alpha</declname>
        </param>
        <briefdescription>
<para>install <computeroutput>alpha</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_single_pole_iir.h" line="144" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="143" bodyend="150"/>
        <references refid="classgr__single__pole__iir_1a3cecd484003a907e60ff8d0eff8fa887" compoundref="gr__single__pole__iir_8h" startline="77">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_alpha</references>
        <references refid="classgr__single__pole__iir_1a5e0f640e76cd29ba756d962097ede891" compoundref="gr__single__pole__iir_8h" startline="78">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_one_minus_alpha</references>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a93048bf18a6017347b42c6395564981b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::reset</definition>
        <argsstring>()</argsstring>
        <name>reset</name>
        <briefdescription>
<para>reset state to zero </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="154" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="153" bodyend="156"/>
        <references refid="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" compoundref="gr__single__pole__iir_8h" startline="79">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</references>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a443a747cd842732ea49484d871212ed0" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gr__complex_8h_1a90c065671dd1c4b7aed7e08b265e23f7" kindref="member">gr_complexd</ref></type>
        <definition>gr_complexd gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::prev_output</definition>
        <argsstring>()</argsstring>
        <name>prev_output</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="158" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="158" bodyend="158"/>
        <references refid="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" compoundref="gr__single__pole__iir_8h" startline="79">gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="12838">
        <label>std::complex&lt; double &gt;</label>
      </node>
      <node id="12837">
        <label>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</label>
        <link refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4"/>
        <childnode refid="12838" relation="usage">
          <edgelabel>d_prev_output</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="115" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="115" bodyend="164"/>
    <listofallmembers>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a2609b118c141b19665d16e18cc37cf0e" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>d_alpha</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1af5a95fc377d50f3b1f74a4258fdfb9df" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>d_one_minus_alpha</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a89dcb1aebab3a22b2fa5186238f696d8" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>d_prev_output</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa833356db2d31691b39b166efd615880" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>filter</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a8e96513599ab00798aac14f76b451ca2" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>filterN</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a60f697c8924bd2d2ca6a370d606d2483" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>gr_single_pole_iir</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a443a747cd842732ea49484d871212ed0" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>prev_output</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a93048bf18a6017347b42c6395564981b" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>reset</name></member>
      <member refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa97e7a76ddbefd08b3a32d674891ce8a" prot="public" virt="non-virtual"><scope>gr_single_pole_iir&lt; gr_complex, i_type, double &gt;</scope><name>set_taps</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>