git.gag.com Git - debian/gnuradio/blob - gr-trellis/src/lib/trellis_metrics_s.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2004 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 // WARNING: this file is machine generated.  Edits will be over written
  24
  25 #ifndef INCLUDED_TRELLIS_METRICS_S_H
  26 #define INCLUDED_TRELLIS_METRICS_S_H
  27
  28 #include <gr_block.h>
  29 #include "trellis_calc_metric.h"
  30
  31 class trellis_metrics_s;
  32 typedef boost::shared_ptr<trellis_metrics_s> trellis_metrics_s_sptr;
  33
  34 trellis_metrics_s_sptr trellis_make_metrics_s (int O, int D,  const std::vector<short> &TABLE, trellis_metric_type_t TYPE);
  35
  36 /*!
  37  * \brief Evaluate metrics for use by the Viterbi algorithm.
  38  * \ingroup coding_blk
  39  */
  40 class trellis_metrics_s : public gr_block
  41 {
  42   int d_O;
  43   int d_D;
  44   trellis_metric_type_t d_TYPE;
  45   std::vector<short> d_TABLE;
  46
  47   friend trellis_metrics_s_sptr trellis_make_metrics_s (int O, int D,  const std::vector<short> &TABLE, trellis_metric_type_t TYPE);
  48   trellis_metrics_s (int O, int D,  const std::vector<short> &TABLE, trellis_metric_type_t TYPE);
  49
  50 public:
  51   int O () const { return d_O; }
  52   int D () const { return d_D; }
  53   trellis_metric_type_t TYPE () const { return d_TYPE; }
  54   std::vector<short> TABLE () const { return d_TABLE; }
  55   void set_TABLE (const std::vector<short> &table);
  56   void forecast (int noutput_items,
  57                  gr_vector_int &ninput_items_required);
  58   int general_work (int noutput_items,
  59                     gr_vector_int &ninput_items,
  60                     gr_vector_const_void_star &input_items,
  61                     gr_vector_void_star &output_items);
  62 };
  63
  64
  65 #endif