Sophie

Sophie

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

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="group__misc" kind="group">
    <compoundname>misc</compoundname>
    <title>Miscellaneous</title>
    <innerclass refid="classgri__goertzel" prot="public">gri_goertzel</innerclass>
    <innerclass refid="classgr__feval__dd" prot="public">gr_feval_dd</innerclass>
    <innerclass refid="classgr__feval__cc" prot="public">gr_feval_cc</innerclass>
    <innerclass refid="classgr__feval__ll" prot="public">gr_feval_ll</innerclass>
    <innerclass refid="classgr__feval" prot="public">gr_feval</innerclass>
    <innerclass refid="classgr__fxpt" prot="public">gr_fxpt</innerclass>
    <innerclass refid="classgr__fxpt__nco" prot="public">gr_fxpt_nco</innerclass>
    <innerclass refid="classgr__fxpt__vco" prot="public">gr_fxpt_vco</innerclass>
    <innerclass refid="classgr__nco" prot="public">gr_nco</innerclass>
    <innerclass refid="classgr__prefs" prot="public">gr_prefs</innerclass>
    <innerclass refid="classgr__test" prot="public">gr_test</innerclass>
    <innerclass refid="classgr__vco" prot="public">gr_vco</innerclass>
    <innerclass refid="classgri__fft__complex" prot="public">gri_fft_complex</innerclass>
    <innerclass refid="classgri__fft__real__fwd" prot="public">gri_fft_real_fwd</innerclass>
    <innerclass refid="classgri__fft__real__rev" prot="public">gri_fft_real_rev</innerclass>
    <innerclass refid="classgri__glfsr" prot="public">gri_glfsr</innerclass>
    <innerclass refid="classgri__lfsr" prot="public">gri_lfsr</innerclass>
    <innerclass refid="classgri__lfsr__15__1__0" prot="public">gri_lfsr_15_1_0</innerclass>
    <innerclass refid="classgri__lfsr__32k" prot="public">gri_lfsr_32k</innerclass>
    <innerclass refid="classgr__message" prot="public">gr_message</innerclass>
    <innerclass refid="classgr__msg__queue" prot="public">gr_msg_queue</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="group__misc_1gae618d7f851fdb9e2e0a5abc404010043" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>unsigned int</type>
        <definition>unsigned int gr_update_crc32</definition>
        <argsstring>(unsigned int crc, const unsigned char *buf, size_t len)</argsstring>
        <name>gr_update_crc32</name>
        <param>
          <type>unsigned int</type>
          <declname>crc</declname>
        </param>
        <param>
          <type>const unsigned char *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>size_t</type>
          <declname>len</declname>
        </param>
        <briefdescription>
<para>update running CRC-32</para><para>Update a running CRC with the bytes buf[0..len-1] The CRC should be initialized to all 1&apos;s, and the transmitted value is the 1&apos;s complement of the final running CRC. The resulting CRC should be transmitted in big endian order. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_crc32.h" line="39"/>
      </memberdef>
      <memberdef kind="function" id="group__misc_1ga7934920e9dbe8204309c2fd68dce8e1c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>float</type>
        <definition>float gr_fast_atan2f</definition>
        <argsstring>(float y, float x)</argsstring>
        <name>gr_fast_atan2f</name>
        <param>
          <type>float</type>
          <declname>y</declname>
        </param>
        <param>
          <type>float</type>
          <declname>x</declname>
        </param>
        <briefdescription>
<para>Fast arc tangent using table lookup and linear interpolation. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>y</parametername>
</parameternamelist>
<parameterdescription>
<para>component of input vector </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>x</parametername>
</parameternamelist>
<parameterdescription>
<para>component of input vector </para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>float angle angle of vector (x, y) in radians</para></simplesect>
This function calculates the angle of the vector (x,y) based on a table lookup and linear interpolation. The table uses a 256 point table covering -45 to +45 degrees and uses symetry to determine the final angle value in the range of -180 to 180 degrees. Note that this function uses the small angle approximation for values close to zero. This routine calculates the arc tangent with an average error of +/- 0.045 degrees. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_math.h" line="67"/>
        <referencedby refid="gr__math_8h_1ae51b150b5480dc16864d7a9c128d4e2b" compoundref="gr__math_8h" startline="69" endline="72">gr_fast_atan2f</referencedby>
      </memberdef>
      <memberdef kind="function" id="group__misc_1ga8ea5c94b1e483b1de195f1494d2dffa7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gr__realtime_8h_1a37b8bb23e68a45e726f6e9a4a8818375" kindref="member">gr_rt_status_t</ref></type>
        <definition>gr_rt_status_t gr_enable_realtime_scheduling</definition>
        <argsstring>()</argsstring>
        <name>gr_enable_realtime_scheduling</name>
        <briefdescription>
<para>If possible, enable high-priority &quot;real time&quot; scheduling. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_realtime.h" line="34"/>
      </memberdef>
      <memberdef kind="function" id="group__misc_1ga54c4024986ca4db5b59761ae5c15ccbe" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_timer_sptr</ref></type>
        <definition>gr_timer_sptr gr_make_timer</definition>
        <argsstring>(gr_timer_hook, void *)</argsstring>
        <name>gr_make_timer</name>
        <param>
          <type><ref refid="gr__timer_8h_1aaad1a7988cefaef6f86f25ce635e6162" kindref="member">gr_timer_hook</ref></type>
        </param>
        <param>
          <type>void *</type>
        </param>
        <briefdescription>
<para>create a timeout. </para>        </briefdescription>
        <detaileddescription>
<para>gr_timer_hook is called when timer fires. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="39"/>
      </memberdef>
      <memberdef kind="function" id="group__misc_1gadde7fc3925a3b1f5c919523740281728" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>rt_status_t</type>
        <definition>rt_status_t gruel::enable_realtime_scheduling</definition>
        <argsstring>(rt_sched_param=rt_sched_param())</argsstring>
        <name>enable_realtime_scheduling</name>
        <param>
          <type>rt_sched_param</type>
          <defval>rt_sched_param()</defval>
        </param>
        <briefdescription>
<para>If possible, enable &quot;realtime&quot; scheduling.</para><para>In general, this means that the code will be scheduled before any non-realtime (normal) processes. Note that if your code contains an non-blocking infinite loop and you enable realtime scheduling, it&apos;s possible to hang the system. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gruel/src/include/gruel/realtime.h" line="91"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>