Several updates on gr-trellis: 1) new fsm constructor for a joint trellis, 2) Corresp...
[debian/gnuradio] / gr-trellis / src / lib / trellis_metrics_X.h.t
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@
24
25 #ifndef @GUARD_NAME@
26 #define @GUARD_NAME@
27
28 #include <gr_block.h>
29 #include "trellis_calc_metric.h"
30
31 class @NAME@;
32 typedef boost::shared_ptr<@NAME@> @SPTR_NAME@;
33
34 @SPTR_NAME@ trellis_make_@BASE_NAME@ (int O, int D,  const std::vector<@I_TYPE@> &TABLE, trellis_metric_type_t TYPE);
35
36 /*!
37  * \brief Evaluate metrics for use by the Viterbi algorithm.
38  * \ingroup block
39  *
40  */
41 class @NAME@ : public gr_block
42 {
43   int d_O;
44   int d_D;
45   trellis_metric_type_t d_TYPE;
46   std::vector<@I_TYPE@> d_TABLE;
47
48   friend @SPTR_NAME@ trellis_make_@BASE_NAME@ (int O, int D,  const std::vector<@I_TYPE@> &TABLE, trellis_metric_type_t TYPE);
49   @NAME@ (int O, int D,  const std::vector<@I_TYPE@> &TABLE, trellis_metric_type_t TYPE);
50
51 public:
52   int O () const { return d_O; }
53   int D () const { return d_D; }
54   trellis_metric_type_t TYPE () const { return d_TYPE; }
55   std::vector<@I_TYPE@> TABLE () const { return d_TABLE; }
56   void set_TABLE (const std::vector<@I_TYPE@> &table);
57   void forecast (int noutput_items,
58                  gr_vector_int &ninput_items_required);
59   int general_work (int noutput_items,
60                     gr_vector_int &ninput_items,
61                     gr_vector_const_void_star &input_items,
62                     gr_vector_void_star &output_items);
63 };
64
65
66 #endif