<!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.2.2 C++ API: trellis_metrics_i Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU Radio 3.2.2 C++ API</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classtrellis__metrics__i.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <h1>trellis_metrics_i Class Reference<div class="ingroups"><a class="el" href="group__coding__blk.html">Information Coding and Decoding</a></div></h1> </div> </div> <div class="contents"> <!-- doxytag: class="trellis_metrics_i" --><!-- doxytag: inherits="gr_block" --> <p>Evaluate metrics for use by the Viterbi algorithm. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="trellis__metrics__i_8h_source.html">trellis_metrics_i.h</a>></code></p> <div class="dynheader"> Inheritance diagram for trellis_metrics_i:</div> <div class="dyncontent"> <div class="center"><img src="classtrellis__metrics__i__inherit__graph.png" border="0" usemap="#trellis__metrics__i_inherit__map" alt="Inheritance graph"/></div> <map name="trellis__metrics__i_inherit__map" id="trellis__metrics__i_inherit__map"> <area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="27,83,96,112"/><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 abstraction of an ..." alt="" coords="7,5,116,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classtrellis__metrics__i-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#a4984ec7c12950b0730676f55e0b44704">O</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#a67dfb0693fa3706d8b63b6873eb9885e">D</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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#ad701dfbb7d53aecd56038d868057e122">TYPE</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#aed13db82b04d750c214bc98479db9af5">TABLE</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#aa7a5ba91051b769526bd7ad3b8399bb8">set_TABLE</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< int > &table)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#ac80d52cfd2a1b31960d216daa35a3b85">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items_required)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Estimate input requirements given output request. <a href="#ac80d52cfd2a1b31960d216daa35a3b85"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#acfa28b3ac7748f9952a8a260b3fc54f8">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#acfa28b3ac7748f9952a8a260b3fc54f8"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="friends"></a> Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">trellis_metrics_i_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__i.html#aaac06955faa8cf40fcec00e6e6a82dc9">trellis_make_metrics_i</a> (int O, int D, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< int > &TABLE, <a class="el" href="trellis__metric__type_8h.html#a730999483daebb08342eb009b2c77ad1">trellis_metric_type_t</a> TYPE)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Evaluate metrics for use by the Viterbi algorithm. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a67dfb0693fa3706d8b63b6873eb9885e"></a><!-- doxytag: member="trellis_metrics_i::D" ref="a67dfb0693fa3706d8b63b6873eb9885e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int trellis_metrics_i::D </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac80d52cfd2a1b31960d216daa35a3b85"></a><!-- doxytag: member="trellis_metrics_i::forecast" ref="ac80d52cfd2a1b31960d216daa35a3b85" args="(int noutput_items, gr_vector_int &ninput_items_required)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void trellis_metrics_i::forecast </td> <td>(</td> <td class="paramtype">int </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> & </td> <td class="paramname"><em>ninput_items_required</em> </td> </tr> <tr> <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 class="params"> <tr><td class="paramname">noutput_items</td><td>number of output items to produce </td></tr> <tr><td class="paramname">ninput_items_required</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="acfa28b3ac7748f9952a8a260b3fc54f8"></a><!-- doxytag: member="trellis_metrics_i::general_work" ref="acfa28b3ac7748f9952a8a260b3fc54f8" args="(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int trellis_metrics_i::general_work </td> <td>(</td> <td class="paramtype">int </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> & </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> & </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> & </td> <td class="paramname"><em>output_items</em> </td> </tr> <tr> <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 class="params"> <tr><td class="paramname">noutput_items</td><td>number of output items to write on each output stream </td></tr> <tr><td class="paramname">ninput_items</td><td>number of input items available on each input stream </td></tr> <tr><td class="paramname">input_items</td><td>vector of pointers to the input items, one entry per input stream </td></tr> <tr><td class="paramname">output_items</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 <= return value <= 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="a4984ec7c12950b0730676f55e0b44704"></a><!-- doxytag: member="trellis_metrics_i::O" ref="a4984ec7c12950b0730676f55e0b44704" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int trellis_metrics_i::O </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa7a5ba91051b769526bd7ad3b8399bb8"></a><!-- doxytag: member="trellis_metrics_i::set_TABLE" ref="aa7a5ba91051b769526bd7ad3b8399bb8" args="(const std::vector< int > &table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void trellis_metrics_i::set_TABLE </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< int > & </td> <td class="paramname"><em>table</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aed13db82b04d750c214bc98479db9af5"></a><!-- doxytag: member="trellis_metrics_i::TABLE" ref="aed13db82b04d750c214bc98479db9af5" 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><int> trellis_metrics_i::TABLE </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ad701dfbb7d53aecd56038d868057e122"></a><!-- doxytag: member="trellis_metrics_i::TYPE" ref="ad701dfbb7d53aecd56038d868057e122" 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_metrics_i::TYPE </td> <td>(</td> <td class="paramname"></td><td>)</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="aaac06955faa8cf40fcec00e6e6a82dc9"></a><!-- doxytag: member="trellis_metrics_i::trellis_make_metrics_i" ref="aaac06955faa8cf40fcec00e6e6a82dc9" args="(int O, int D, const std::vector< int > &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_metrics_i_sptr</a> trellis_make_metrics_i </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>O</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </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>< int > & </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> </td> <td class="paramname"><em>TYPE</em> </td> </tr> <tr> <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__metrics__i_8h_source.html">trellis_metrics_i.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classtrellis__metrics__i.html">trellis_metrics_i</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>