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