Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gr-trellis / src / lib / trellis_viterbi_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 "fsm.h"
29 #include <gr_block.h>
30
31 class @NAME@;
32 typedef boost::shared_ptr<@NAME@> @SPTR_NAME@;
33
34 @SPTR_NAME@ trellis_make_@BASE_NAME@ (
35     const fsm &FSM, 
36     int K,
37     int S0,
38     int SK);
39
40
41
42 class @NAME@ : public gr_block
43 {
44   fsm d_FSM;
45   int d_K;
46   int d_S0;
47   int d_SK;
48   //std::vector<int> d_trace;
49
50   friend @SPTR_NAME@ trellis_make_@BASE_NAME@ (
51     const fsm &FSM,
52     int K,
53     int S0,
54     int SK);
55
56
57   @NAME@ (
58     const fsm &FSM,
59     int K,
60     int S0,
61     int SK);
62
63
64 public:
65   fsm FSM () const { return d_FSM; }
66   int K () const { return d_K; }
67   int S0 () const { return d_S0; }
68   int SK () const { return d_SK; }
69   //std::vector<int> trace () const { return d_trace; }
70   void forecast (int noutput_items,
71                  gr_vector_int &ninput_items_required);
72   int general_work (int noutput_items,
73                     gr_vector_int &ninput_items,
74                     gr_vector_const_void_star &input_items,
75                     gr_vector_void_star &output_items);
76 };
77
78 #endif