Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / filter / qa_gr_fir_ccf.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2002 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 /*
24  * FIXME.  This code is virtually identical to qa_gr_fir_?CC.cc
25  *   Kludge up some kind of macro to handle the minor differences.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 #include <config.h>
30 #endif
31
32 #include <gr_types.h>
33
34 typedef gr_complex      i_type;
35 typedef gr_complex      o_type;
36 typedef float           tap_type;
37 typedef gr_complex      acc_type;
38
39
40 #include <qa_gr_fir_ccf.h>
41 #include <gr_fir_ccf.h>
42 #include <gr_fir_util.h>
43 #include <string.h>
44 #include <iostream>
45 #include <cmath>
46 #include <gr_types.h>
47 #include <cppunit/TestAssert.h>
48 #include <random.h>
49 #include <malloc16.h>
50
51 using std::vector;
52
53 #define ERR_DELTA       (1e-5)
54
55 #define NELEM(x) (sizeof (x) / sizeof (x[0]))
56
57 //
58 // typedef for something logically "pointer to constructor".
59 // there may be a better way, please let me know...
60 //
61 typedef gr_fir_ccf* (*fir_maker_t)(const std::vector<tap_type> &taps);
62
63 static float
64 uniform ()
65 {
66   return 2.0 * ((float) random () / RANDOM_MAX - 0.5);  // uniformly (-1, 1)
67 }
68
69 static void
70 random_floats (float *buf, unsigned n)
71 {
72   for (unsigned i = 0; i < n; i++)
73     buf[i] = (float) rint (uniform () * 32767);
74 }
75
76 static void
77 random_complex (gr_complex *buf, unsigned n)
78 {
79   for (unsigned i = 0; i < n; i++){
80     float re = rint (uniform () * 32767);
81     float im = rint (uniform () * 32767);
82     buf[i] = gr_complex (re, im);
83   }
84 }
85
86 static o_type
87 ref_dotprod (const i_type input[], const tap_type taps[], int ntaps)
88 {
89   acc_type      sum = 0;
90   for (int i = 0; i < ntaps; i++)
91     sum += input[i] * taps[ntaps - i - 1];
92
93   return sum;
94 }
95
96 //
97 // Test for ntaps in [0,9], and input lengths in [0,17].
98 // This ensures that we are building the shifted taps correctly,
99 // and exercises all corner cases on input alignment and length.
100 //
101
102 static void
103 test_random_io (fir_maker_t maker)  
104 {
105   const int     MAX_TAPS        = 9;
106   const int     OUTPUT_LEN      = 17;
107   const int     INPUT_LEN       = MAX_TAPS + OUTPUT_LEN;
108
109   // Our SIMD ccc kernel requires that the complex input be 64-bit (8-byte) aligned.
110   //i_type      input[INPUT_LEN];
111   i_type       *input = (i_type *)malloc16Align(INPUT_LEN * sizeof(i_type));
112   o_type        expected_output[OUTPUT_LEN];
113   o_type        actual_output[OUTPUT_LEN];
114   tap_type      taps[MAX_TAPS];
115
116
117   srandom (0);  // we want reproducibility
118
119   for (int n = 0; n <= MAX_TAPS; n++){
120     for (int ol = 0; ol <= OUTPUT_LEN; ol++){
121
122       // cerr << "@@@ n:ol " << n << ":" << ol << endl;
123
124       // build random test case
125       random_complex (input, INPUT_LEN);
126       random_floats (taps, MAX_TAPS);
127
128       // compute expected output values
129       for (int o = 0; o < ol; o++){
130         expected_output[o] = ref_dotprod (&input[o], taps, n);
131       }
132
133       // build filter
134
135       vector<tap_type> f1_taps (&taps[0], &taps[n]);
136       gr_fir_ccf *f1 = maker (f1_taps);
137
138       // zero the output, then do the filtering
139       memset (actual_output, 0, sizeof (actual_output));
140       f1->filterN (actual_output, input, ol);
141
142       // check results
143       //
144       // we use a sloppy error margin because on the x86 architecture,
145       // our reference implementation is using 80 bit floating point
146       // arithmetic, while the SSE version is using 32 bit float point
147       // arithmetic.
148       
149       for (int o = 0; o < ol; o++){
150         ASSERT_COMPLEXES_EQUAL (expected_output[o], actual_output[o],
151                                 abs (expected_output[o]) * ERR_DELTA);
152       }
153
154       delete f1;
155     }
156   }
157   free16Align(input);
158 }
159
160
161 static void
162 for_each (void (*f)(fir_maker_t))
163 {
164   std::vector<gr_fir_ccf_info>          info;
165   gr_fir_util::get_gr_fir_ccf_info (&info);     // get all known ccf implementations 
166
167   for (std::vector<gr_fir_ccf_info>::iterator p = info.begin ();
168        p != info.end ();
169        ++p){
170
171     std::cerr << " [" << p->name << "]";
172     f (p->create);
173   }
174
175   std::cerr << std::endl;
176 }
177
178
179 void
180 qa_gr_fir_ccf::t1 ()
181 {
182   for_each (test_random_io);
183 }