<!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_f 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__f.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_f 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_f" --><!-- 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__f_8h_source.html">trellis_metrics_f.h</a>></code></p> <div class="dynheader"> Inheritance diagram for trellis_metrics_f:</div> <div class="dyncontent"> <div class="center"><img src="classtrellis__metrics__f__inherit__graph.png" border="0" usemap="#trellis__metrics__f_inherit__map" alt="Inheritance graph"/></div> <map name="trellis__metrics__f_inherit__map" id="trellis__metrics__f_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="28,83,97,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="8,5,117,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classtrellis__metrics__f-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__f.html#a81771f6dcab0c4f86ebc80e3727dd931">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__f.html#a6b15a78c7052a114188f286b85632fc2">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__f.html#ab00942eb1d6f2ccad8a690a17dfd5657">TYPE</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__f.html#a6de75ce8233ad21134c43f61245e6747">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__f.html#a735444215b61d0fed1667629b1497699">set_TABLE</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &table)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__f.html#a6bf59f54ce3092e8ae0049936b0044ff">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="#a6bf59f54ce3092e8ae0049936b0044ff"></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__f.html#aefb740cfb8d560b60b179efb907d61e6">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="#aefb740cfb8d560b60b179efb907d61e6"></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_f_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrellis__metrics__f.html#a345cd37cdd2633c4dcc7cfefac821e15">trellis_make_metrics_f</a> (int O, int D, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &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="a6b15a78c7052a114188f286b85632fc2"></a><!-- doxytag: member="trellis_metrics_f::D" ref="a6b15a78c7052a114188f286b85632fc2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int trellis_metrics_f::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="a6bf59f54ce3092e8ae0049936b0044ff"></a><!-- doxytag: member="trellis_metrics_f::forecast" ref="a6bf59f54ce3092e8ae0049936b0044ff" 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_f::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="aefb740cfb8d560b60b179efb907d61e6"></a><!-- doxytag: member="trellis_metrics_f::general_work" ref="aefb740cfb8d560b60b179efb907d61e6" 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_f::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="a81771f6dcab0c4f86ebc80e3727dd931"></a><!-- doxytag: member="trellis_metrics_f::O" ref="a81771f6dcab0c4f86ebc80e3727dd931" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int trellis_metrics_f::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="a735444215b61d0fed1667629b1497699"></a><!-- doxytag: member="trellis_metrics_f::set_TABLE" ref="a735444215b61d0fed1667629b1497699" args="(const std::vector< float > &table)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void trellis_metrics_f::set_TABLE </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"><em>table</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6de75ce8233ad21134c43f61245e6747"></a><!-- doxytag: member="trellis_metrics_f::TABLE" ref="a6de75ce8233ad21134c43f61245e6747" 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><float> trellis_metrics_f::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="ab00942eb1d6f2ccad8a690a17dfd5657"></a><!-- doxytag: member="trellis_metrics_f::TYPE" ref="ab00942eb1d6f2ccad8a690a17dfd5657" 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_f::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="a345cd37cdd2633c4dcc7cfefac821e15"></a><!-- doxytag: member="trellis_metrics_f::trellis_make_metrics_f" ref="a345cd37cdd2633c4dcc7cfefac821e15" args="(int O, int D, const std::vector< float > &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_f_sptr</a> trellis_make_metrics_f </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>< float > & </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__f_8h_source.html">trellis_metrics_f.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classtrellis__metrics__f.html">trellis_metrics_f</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>