trellis_metrics_s Class Reference
Evaluate metrics for use by the Viterbi algorithm. More...
#include <trellis_metrics_s.h>
Inheritance diagram for trellis_metrics_s:
Public Member Functions | |
| int | O () const |
| int | D () const |
| trellis_metric_type_t | TYPE () const |
| std::vector< short > | TABLE () const |
| void | set_TABLE (const std::vector< short > &table) |
| void | forecast (int noutput_items, gr_vector_int &ninput_items_required) |
| Estimate input requirements given output request. | |
| int | general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) |
| compute output items from input items | |
Friends | |
| TRELLIS_API trellis_metrics_s_sptr | trellis_make_metrics_s (int O, int D, const std::vector< short > &TABLE, trellis_metric_type_t TYPE) |
Detailed Description
Evaluate metrics for use by the Viterbi algorithm.
Member Function Documentation
| int trellis_metrics_s::D | ( | ) | const [inline] |
| void trellis_metrics_s::forecast | ( | int | noutput_items, |
| gr_vector_int & | ninput_items_required | ||
| ) | [virtual] |
Estimate input requirements given output request.
- Parameters:
-
noutput_items number of output items to produce ninput_items_required number of input items required on each input stream
Given a request to product noutput_items, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.
Reimplemented from gr_block.
| int trellis_metrics_s::general_work | ( | int | noutput_items, |
| gr_vector_int & | ninput_items, | ||
| gr_vector_const_void_star & | input_items, | ||
| gr_vector_void_star & | output_items | ||
| ) | [virtual] |
compute output items from input items
- Parameters:
-
noutput_items number of output items to write on each output stream ninput_items number of input items available on each input stream input_items vector of pointers to the input items, one entry per input stream output_items vector of pointers to the output items, one entry per output stream
- Returns:
- 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
general_work must call consume or consume_each to indicate how many items were consumed on each input stream.
Reimplemented from gr_block.
| int trellis_metrics_s::O | ( | ) | const [inline] |
| void trellis_metrics_s::set_TABLE | ( | const std::vector< short > & | table | ) |
| std::vector<short> trellis_metrics_s::TABLE | ( | ) | const [inline] |
| trellis_metric_type_t trellis_metrics_s::TYPE | ( | ) | const [inline] |
Friends And Related Function Documentation
| TRELLIS_API trellis_metrics_s_sptr trellis_make_metrics_s | ( | int | O, |
| int | D, | ||
| const std::vector< short > & | TABLE, | ||
| trellis_metric_type_t | TYPE | ||
| ) | [friend] |
The documentation for this class was generated from the following file:
