efficient moving average filters, should speed up OFDM significantly
[debian/gnuradio] / gnuradio-core / src / lib / gengen / gr_moving_average_XX.h.t
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008 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 <gr_sync_block.h>
29
30 class @NAME@;
31
32 typedef boost::shared_ptr<@NAME@> @SPTR_NAME@;
33
34 @SPTR_NAME@ gr_make_@BASE_NAME@ (int length, @O_TYPE@ scale, int max_iter = 4096);
35
36 /*!
37  * \brief output is the moving sum of the last N samples, scaled by the scale factor
38  * \ingroup filter.  max_iter limits how long we go without flushing the accumulator
39  * This is necessary to avoid numerical instability for float and complex.
40  *
41  */
42 class @NAME@ : public gr_sync_block
43 {
44 private:
45   friend @SPTR_NAME@ gr_make_@BASE_NAME@(int length, @O_TYPE@ scale, int max_iter);
46
47   @NAME@ (int length, @O_TYPE@ scale, int max_iter = 4096);
48
49   int d_length;
50   @O_TYPE@ d_scale;
51   int d_max_iter;
52
53 public:
54   ~@NAME@ ();   
55
56   int work (int noutput_items,
57             gr_vector_const_void_star &input_items,
58             gr_vector_void_star &output_items);
59 };
60
61 #endif /* @GUARD_NAME@ */