Imported Upstream version 3.2.2
[debian/gnuradio] / gr-trellis / src / lib / trellis_siso_f.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 #ifndef INCLUDED_TRELLIS_SISO_F_H
24 #define INCLUDED_TRELLIS_SISO_F_H
25
26 #include "fsm.h"
27 #include "trellis_siso_type.h"
28 #include <gr_block.h>
29
30 class trellis_siso_f;
31 typedef boost::shared_ptr<trellis_siso_f> trellis_siso_f_sptr;
32
33 trellis_siso_f_sptr trellis_make_siso_f (
34     const fsm &FSM,     // underlying FSM
35     int K,              // block size in trellis steps
36     int S0,             // initial state (put -1 if not specified)
37     int SK,             // final state (put -1 if not specified)
38     bool POSTI,         // true if you want a-posteriori info about the input symbols to be mux-ed in the output
39     bool POSTO,         // true if you want a-posteriori info about the output symbols to be mux-ed in the output
40     trellis_siso_type_t d_SISO_TYPE // perform "min-sum" or "sum-product" combining 
41 );
42
43
44 /*!
45  *  \ingroup coding_blk
46  */
47 class trellis_siso_f : public gr_block
48 {
49   fsm d_FSM;
50   int d_K;
51   int d_S0;
52   int d_SK;
53   bool d_POSTI;
54   bool d_POSTO;
55   trellis_siso_type_t d_SISO_TYPE;
56   //std::vector<float> d_alpha;
57   //std::vector<float> d_beta;
58
59   friend trellis_siso_f_sptr trellis_make_siso_f (
60     const fsm &FSM,
61     int K,
62     int S0,
63     int SK,
64     bool POSTI,
65     bool POSTO,
66     trellis_siso_type_t d_SISO_TYPE);
67
68
69   trellis_siso_f (
70     const fsm &FSM,
71     int K,
72     int S0,
73     int SK,
74     bool POSTI,
75     bool POSTO,
76     trellis_siso_type_t d_SISO_TYPE);
77
78
79 public:
80   fsm FSM () const { return d_FSM; }
81   int K () const { return d_K; }
82   int S0 () const { return d_S0; }
83   int SK () const { return d_SK; }
84   bool POSTI () const { return d_POSTI; }
85   bool POSTO () const { return d_POSTO; }
86   trellis_siso_type_t SISO_TYPE () const { return d_SISO_TYPE; }
87   void forecast (int noutput_items,
88                  gr_vector_int &ninput_items_required);
89   int general_work (int noutput_items,
90                     gr_vector_int &ninput_items,
91                     gr_vector_const_void_star &input_items,
92                     gr_vector_void_star &output_items);
93 };
94
95 #endif