Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 3321

gnuradio-doc-3.3.0-8mdv2010.1.i586.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.3.0 C++ API: trellis_viterbi_combined_ib Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>trellis_viterbi_combined_ib Class Reference<br/>
<small>
[<a class="el" href="group__coding__blk.html">Information Coding and Decoding</a>]</small>
</h1><!-- doxytag: class="trellis_viterbi_combined_ib" --><!-- doxytag: inherits="gr_block" -->
<p><code>#include &lt;<a class="el" href="trellis__viterbi__combined__ib_8h_source.html">trellis_viterbi_combined_ib.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for trellis_viterbi_combined_ib:</div>
<div class="dynsection">
<div class="center"><img src="classtrellis__viterbi__combined__ib__inherit__graph.png" border="0" usemap="#trellis__viterbi__combined__ib_inherit__map" alt="Inheritance graph"/></div>
<map name="trellis__viterbi__combined__ib_inherit__map" id="trellis__viterbi__combined__ib_inherit__map">
<area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing..." alt="" coords="57,237,127,267"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="37,160,147,189"/><area shape="rect" id="node6" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="31,83,153,112"/><area shape="rect" id="node8" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="23,5,161,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classtrellis__viterbi__combined__ib-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfsm.html">fsm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a361cd5594a78644af504684c5c3861b5">FSM</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a8612914607bb2f1602dafecd1746766e">K</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#aacee8a50e5a80324cdf579d1042ce623">S0</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a3f7f03b1c414ddfb2967f6b498645d31">SK</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a1658c99d85427e76616bb2d7cfd31e36">D</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; int &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a30c87b572a72790a6af13562412a329e">TABLE</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="trellis__metric__type_8h.html#a730999483daebb08342eb009b2c77ad1">trellis_metric_type_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a3c54bcca73799c81fedb6c3116c3db04">TYPE</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#aeeb4b329c3e1e86c87b2c47a4ee09261">set_TABLE</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; int &gt; &amp;table)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a9094db736f412b6cd9afa26587ee8fff">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &amp;ninput_items_required)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Estimate input requirements given output request.  <a href="#a9094db736f412b6cd9afa26587ee8fff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#aff426249d523f25f4cd2fd705fda5f38">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &amp;ninput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute output items from input items  <a href="#aff426249d523f25f4cd2fd705fda5f38"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">trellis_viterbi_combined_ib_sptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__viterbi__combined__ib.html#a167e19f77032e84f37b62c30f5299dc1">trellis_make_viterbi_combined_ib</a> (const <a class="el" href="classfsm.html">fsm</a> &amp;FSM, int K, int S0, int SK, int D, const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; int &gt; &amp;TABLE, <a class="el" href="trellis__metric__type_8h.html#a730999483daebb08342eb009b2c77ad1">trellis_metric_type_t</a> TYPE)</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1658c99d85427e76616bb2d7cfd31e36"></a><!-- doxytag: member="trellis_viterbi_combined_ib::D" ref="a1658c99d85427e76616bb2d7cfd31e36" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int trellis_viterbi_combined_ib::D </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9094db736f412b6cd9afa26587ee8fff"></a><!-- doxytag: member="trellis_viterbi_combined_ib::forecast" ref="a9094db736f412b6cd9afa26587ee8fff" args="(int noutput_items, gr_vector_int &amp;ninput_items_required)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void trellis_viterbi_combined_ib::forecast </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>noutput_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ninput_items_required</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Estimate input requirements given output request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>noutput_items</em>&nbsp;</td><td>number of output items to produce </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ninput_items_required</em>&nbsp;</td><td>number of input items required on each input stream</td></tr>
  </table>
  </dd>
</dl>
<p>Given a request to product <code>noutput_items</code>, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close. </p>

<p>Reimplemented from <a class="el" href="classgr__block.html#aa1f2518b5c97126bb015adb9e2027f4a">gr_block</a>.</p>

</div>
</div>
<a class="anchor" id="a361cd5594a78644af504684c5c3861b5"></a><!-- doxytag: member="trellis_viterbi_combined_ib::FSM" ref="a361cd5594a78644af504684c5c3861b5" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfsm.html">fsm</a> trellis_viterbi_combined_ib::FSM </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aff426249d523f25f4cd2fd705fda5f38"></a><!-- doxytag: member="trellis_viterbi_combined_ib::general_work" ref="aff426249d523f25f4cd2fd705fda5f38" args="(int noutput_items, gr_vector_int &amp;ninput_items, gr_vector_const_void_star &amp;input_items, gr_vector_void_star &amp;output_items)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int trellis_viterbi_combined_ib::general_work </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>noutput_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ninput_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>input_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>output_items</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>compute output items from input items </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>noutput_items</em>&nbsp;</td><td>number of output items to write on each output stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ninput_items</em>&nbsp;</td><td>number of input items available on each input stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>input_items</em>&nbsp;</td><td>vector of pointers to the input items, one entry per input stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>output_items</em>&nbsp;</td><td>vector of pointers to the output items, one entry per output stream</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 &lt;= return value &lt;= noutput_items</dd></dl>
<p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p>

<p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>

</div>
</div>
<a class="anchor" id="a8612914607bb2f1602dafecd1746766e"></a><!-- doxytag: member="trellis_viterbi_combined_ib::K" ref="a8612914607bb2f1602dafecd1746766e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int trellis_viterbi_combined_ib::K </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aacee8a50e5a80324cdf579d1042ce623"></a><!-- doxytag: member="trellis_viterbi_combined_ib::S0" ref="aacee8a50e5a80324cdf579d1042ce623" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int trellis_viterbi_combined_ib::S0 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aeeb4b329c3e1e86c87b2c47a4ee09261"></a><!-- doxytag: member="trellis_viterbi_combined_ib::set_TABLE" ref="aeeb4b329c3e1e86c87b2c47a4ee09261" args="(const std::vector&lt; int &gt; &amp;table)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void trellis_viterbi_combined_ib::set_TABLE </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; int &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>table</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a3f7f03b1c414ddfb2967f6b498645d31"></a><!-- doxytag: member="trellis_viterbi_combined_ib::SK" ref="a3f7f03b1c414ddfb2967f6b498645d31" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int trellis_viterbi_combined_ib::SK </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a30c87b572a72790a6af13562412a329e"></a><!-- doxytag: member="trellis_viterbi_combined_ib::TABLE" ref="a30c87b572a72790a6af13562412a329e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a>&lt;int&gt; trellis_viterbi_combined_ib::TABLE </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a3c54bcca73799c81fedb6c3116c3db04"></a><!-- doxytag: member="trellis_viterbi_combined_ib::TYPE" ref="a3c54bcca73799c81fedb6c3116c3db04" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="trellis__metric__type_8h.html#a730999483daebb08342eb009b2c77ad1">trellis_metric_type_t</a> trellis_viterbi_combined_ib::TYPE </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a167e19f77032e84f37b62c30f5299dc1"></a><!-- doxytag: member="trellis_viterbi_combined_ib::trellis_make_viterbi_combined_ib" ref="a167e19f77032e84f37b62c30f5299dc1" args="(const fsm &amp;FSM, int K, int S0, int SK, int D, const std::vector&lt; int &gt; &amp;TABLE, trellis_metric_type_t TYPE)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">trellis_viterbi_combined_ib_sptr</a> trellis_make_viterbi_combined_ib </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classfsm.html">fsm</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>FSM</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>K</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>S0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>SK</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>D</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; int &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>TABLE</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="trellis__metric__type_8h.html#a730999483daebb08342eb009b2c77ad1">trellis_metric_type_t</a>&nbsp;</td>
          <td class="paramname"> <em>TYPE</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="trellis__viterbi__combined__ib_8h_source.html">trellis_viterbi_combined_ib.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:03 2010 for GNU Radio 3.3.0 C++ API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>