Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / filter / gr_cma_equalizer_cc.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_CMA_EQUALIZER_CC_H
24 #define INCLUDED_GR_CMA_EQUALIZER_CC_H
25
26 #include <gr_adaptive_fir_ccf.h>
27
28 class gr_cma_equalizer_cc;
29 typedef boost::shared_ptr<gr_cma_equalizer_cc> gr_cma_equalizer_cc_sptr;
30
31 gr_cma_equalizer_cc_sptr 
32 gr_make_cma_equalizer_cc(int num_taps, float modulus, float mu);
33
34 /*!
35  * \brief Implements constant modulus adaptive filter on complex stream
36  * \ingroup eq_blk
37  */
38 class gr_cma_equalizer_cc : public gr_adaptive_fir_ccf
39 {
40 private:
41   float d_modulus;
42   float d_mu;
43   
44   friend gr_cma_equalizer_cc_sptr gr_make_cma_equalizer_cc(int num_taps, float modulus, float mu);
45   gr_cma_equalizer_cc(int num_taps, float modulus, float mu);
46
47 protected:
48
49   virtual float error(const gr_complex &out) 
50   { 
51     return (d_modulus - norm(out)); 
52   }
53
54   virtual void update_tap(float &tap, const gr_complex &in) 
55   {
56     tap += d_mu*d_error*abs(in);
57   }
58   
59 public:
60 };
61
62 #endif