Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / filter / gr_adaptive_fir_ccf.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 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_GR_ADAPTIVE_FIR_CCF_H
24 #define INCLUDED_GR_ADAPTIVE_FIR_CCF_H
25
26 #include <gr_sync_decimator.h>
27
28 /*!
29  * \brief Adaptive FIR filter with gr_complex input, gr_complex output and float taps
30  * \ingroup filter_blk
31  */
32 class gr_adaptive_fir_ccf : public gr_sync_decimator
33 {
34 private:
35   std::vector<float>  d_new_taps;
36   bool                d_updated;
37
38 protected:
39   float               d_error;
40   std::vector<float>  d_taps;
41
42   // Override to calculate error signal per output
43   virtual float error(const gr_complex &out) = 0; 
44
45   // Override to calculate new weight from old, corresponding input
46   virtual void update_tap(float &tap, const gr_complex &in) = 0;
47
48   gr_adaptive_fir_ccf(const char *name, int decimation, const std::vector<float> &taps);
49
50 public:
51   void set_taps(const std::vector<float> &taps);
52
53   int work(int noutput_items,
54            gr_vector_const_void_star &input_items,
55            gr_vector_void_star &output_items);
56 };
57
58 #endif