summaryrefslogtreecommitdiffstats
path: root/tests/manual/spectrum/3rdparty/fftreal/TestAccuracy.hpp
blob: 5c794f747bf1b4295a54ae121bcd0d3a9965edea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
/*****************************************************************************

        TestAccuracy.hpp
        Copyright (c) 2005 Laurent de Soras

--- Legal stuff ---

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*Tab=3***********************************************************************/



#if defined (TestAccuracy_CURRENT_CODEHEADER)
	#error Recursive inclusion of TestAccuracy code header.
#endif
#define	TestAccuracy_CURRENT_CODEHEADER

#if ! defined (TestAccuracy_CODEHEADER_INCLUDED)
#define	TestAccuracy_CODEHEADER_INCLUDED



/*\\\ INCLUDE FILES \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/

#include	"def.h"
#include	"test_fnc.h"
#include	"TestWhiteNoiseGen.h"

#include	<typeinfo>
#include	<vector>

#include	<cmath>
#include	<cstdio>



static const double	TestAccuracy_LN10	= 2.3025850929940456840179914546844;



/*\\\ PUBLIC \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/



template <class FO>
int	TestAccuracy <FO>::perform_test_single_object (FO &fft)
{
	assert (&fft != 0);

	using namespace std;

	int				ret_val = 0;

	const std::type_info &	ti = typeid (fft);
	const char *	class_name_0 = ti.name ();

	if (ret_val == 0)
	{
		ret_val = perform_test_d (fft, class_name_0);
	}
	if (ret_val == 0)
	{
		ret_val = perform_test_i (fft, class_name_0);
	}
	if (ret_val == 0)
	{
		ret_val = perform_test_di (fft, class_name_0);
	}

	if (ret_val == 0)
	{
		printf ("\n");
	}

	return (ret_val);
}



template <class FO>
int	TestAccuracy <FO>::perform_test_d (FO &fft, const char *class_name_0)
{
	assert (&fft != 0);
   assert (class_name_0 != 0);

	using namespace std;

	int				ret_val = 0;
	const long		len = fft.get_length ();
   const long     nbr_tests = limit (
      NBR_ACC_TESTS / len / len,
      1L,
      static_cast <long> (MAX_NBR_TESTS)
   );

	printf ("Testing %s::do_fft () [%ld samples]... ", class_name_0, len);
	fflush (stdout);
	TestWhiteNoiseGen <DataType>	noise;
	std::vector <DataType>	x (len);
	std::vector <DataType>	s1 (len);
	std::vector <DataType>	s2 (len);
	BigFloat			err_avg = 0;

	for (long test = 0; test < nbr_tests && ret_val == 0; ++ test)
	{
		noise.generate (&x [0], len);
		fft.do_fft (&s1 [0], &x [0]);
		compute_tf (&s2 [0], &x [0], len);

		BigFloat			max_err;
		compare_vect_display (&s1 [0], &s2 [0], len, max_err);
		err_avg += max_err;
	}
	err_avg /= NBR_ACC_TESTS;

	printf ("done.\n");
	printf (
		"Average maximum error: %.6f %% (%f dB)\n",
		static_cast <double> (err_avg * 100),
		static_cast <double> ((20 / TestAccuracy_LN10) * log (err_avg))
	);

	return (ret_val);
}



template <class FO>
int	TestAccuracy <FO>::perform_test_i (FO &fft, const char *class_name_0)
{
	assert (&fft != 0);
   assert (class_name_0 != 0);

	using namespace std;

	int				ret_val = 0;
	const long		len = fft.get_length ();
   const long     nbr_tests = limit (
      NBR_ACC_TESTS / len / len,
      10L,
      static_cast <long> (MAX_NBR_TESTS)
   );

	printf ("Testing %s::do_ifft () [%ld samples]... ", class_name_0, len);
	fflush (stdout);
	TestWhiteNoiseGen <DataType>	noise;
	std::vector <DataType>	s (len);
	std::vector <DataType>	x1 (len);
	std::vector <DataType>	x2 (len);
	BigFloat			err_avg = 0;

	for (long test = 0; test < nbr_tests && ret_val == 0; ++ test)
	{
		noise.generate (&s [0], len);
		fft.do_ifft (&s [0], &x1 [0]);
		compute_itf (&x2 [0], &s [0], len);

		BigFloat			max_err;
		compare_vect_display (&x1 [0], &x2 [0], len, max_err);
		err_avg += max_err;
	}
	err_avg /= NBR_ACC_TESTS;

	printf ("done.\n");
	printf (
		"Average maximum error: %.6f %% (%f dB)\n",
		static_cast <double> (err_avg * 100),
		static_cast <double> ((20 / TestAccuracy_LN10) * log (err_avg))
	);

	return (ret_val);
}



template <class FO>
int	TestAccuracy <FO>::perform_test_di (FO &fft, const char *class_name_0)
{
	assert (&fft != 0);
   assert (class_name_0 != 0);

	using namespace std;

	int				ret_val = 0;
	const long		len = fft.get_length ();
   const long     nbr_tests = limit (
      NBR_ACC_TESTS / len / len,
      1L,
      static_cast <long> (MAX_NBR_TESTS)
   );

	printf (
		"Testing %s::do_fft () / do_ifft () / rescale () [%ld samples]... ",
		class_name_0,
		len
	);
	fflush (stdout);
	TestWhiteNoiseGen <DataType>	noise;
	std::vector <DataType>	x (len);
	std::vector <DataType>	s (len);
	std::vector <DataType>	y (len);
	BigFloat			err_avg = 0;

	for (long test = 0; test < nbr_tests && ret_val == 0; ++ test)
	{
		noise.generate (&x [0], len);
		fft.do_fft (&s [0], &x [0]);
		fft.do_ifft (&s [0], &y [0]);
		fft.rescale (&y [0]);

		BigFloat			max_err;
		compare_vect_display (&x [0], &y [0], len, max_err);
		err_avg += max_err;
	}
	err_avg /= NBR_ACC_TESTS;

	printf ("done.\n");
	printf (
		"Average maximum error: %.6f %% (%f dB)\n",
		static_cast <double> (err_avg * 100),
		static_cast <double> ((20 / TestAccuracy_LN10) * log (err_avg))
	);

	return (ret_val);
}



/*\\\ PROTECTED \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/



/*\\\ PRIVATE \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/



// Positive transform
template <class FO>
void	TestAccuracy <FO>::compute_tf (DataType s [], const DataType x [], long length)
{
	assert (s != 0);
	assert (x != 0);
	assert (length >= 2);
	assert ((length & 1) == 0);

	const long		nbr_bins = length >> 1;

	// DC and Nyquist
	BigFloat			dc = 0;
	BigFloat			ny = 0;
	for (long pos = 0; pos < length; pos += 2)
	{
		const BigFloat	even = x [pos    ];
		const BigFloat	odd  = x [pos + 1];
		dc += even + odd;
		ny += even - odd;
	}
	s [0       ] = static_cast <DataType> (dc);
	s [nbr_bins] = static_cast <DataType> (ny);

	// Regular bins
	for (long bin = 1; bin < nbr_bins; ++ bin)
	{
		BigFloat			sum_r = 0;
		BigFloat			sum_i = 0;

		const BigFloat	m = bin * static_cast <BigFloat> (2 * PI) / length;

		for (long pos = 0; pos < length; ++pos)
		{
			using namespace std;

			const BigFloat	phase = pos * m;
			const BigFloat	e_r = cos (phase);
			const BigFloat	e_i = sin (phase);

			sum_r += x [pos] * e_r;
			sum_i += x [pos] * e_i;
		}

		s [           bin] = static_cast <DataType> (sum_r);
		s [nbr_bins + bin] = static_cast <DataType> (sum_i);
	}
}



// Negative transform
template <class FO>
void	TestAccuracy <FO>::compute_itf (DataType x [], const DataType s [], long length)
{
	assert (s != 0);
	assert (x != 0);
	assert (length >= 2);
	assert ((length & 1) == 0);

	const long		nbr_bins = length >> 1;

	// DC and Nyquist
	BigFloat			dc = s [0       ];
	BigFloat			ny = s [nbr_bins];

	// Regular bins
	for (long pos = 0; pos < length; ++pos)
	{
		BigFloat				sum = dc + ny * (1 - 2 * (pos & 1));

		const BigFloat		m = pos * static_cast <BigFloat> (-2 * PI) / length;

		for (long bin = 1; bin < nbr_bins; ++ bin)
		{
			using namespace std;

			const BigFloat	phase = bin * m;
			const BigFloat	e_r = cos (phase);
			const BigFloat	e_i = sin (phase);

			sum += 2 * (  e_r * s [bin           ]
			            - e_i * s [bin + nbr_bins]);
		}

		x [pos] = static_cast <DataType> (sum);
	}
}



template <class FO>
int	TestAccuracy <FO>::compare_vect_display (const DataType x_ptr [], const DataType y_ptr [], long len, BigFloat &max_err_rel)
{
	assert (x_ptr != 0);
	assert (y_ptr != 0);
	assert (len > 0);
	assert (&max_err_rel != 0);

	using namespace std;

	int				ret_val = 0;

	BigFloat			power = compute_power (&x_ptr [0], &y_ptr [0], len);
	BigFloat			power_dif;
	long				max_err_pos;
	compare_vect (&x_ptr [0], &y_ptr [0], power_dif, max_err_pos, len);

	if (power == 0)
	{
		power = power_dif;
	}
	const BigFloat	power_err_rel = power_dif / power;

	BigFloat	      max_err = 0;
	max_err_rel = 0;
	if (max_err_pos >= 0)
	{
      max_err = y_ptr [max_err_pos] - x_ptr [max_err_pos];
		max_err_rel = 2 * fabs (max_err) / (  fabs (y_ptr [max_err_pos])
		                                    + fabs (x_ptr [max_err_pos]));
	}

	if (power_err_rel > 0.001)
	{
		printf ("Power error  : %f (%.6f %%)\n",
			static_cast <double> (power_err_rel),
			static_cast <double> (power_err_rel * 100)
		);
		if (max_err_pos >= 0)
		{
			printf (
				"Maximum error: %f - %f = %f (%f)\n",
				static_cast <double> (y_ptr [max_err_pos]),
				static_cast <double> (x_ptr [max_err_pos]),
				static_cast <double> (max_err),
				static_cast <double> (max_err_pos)
			);
		}
	}

	return (ret_val);
}



template <class FO>
typename TestAccuracy <FO>::BigFloat	TestAccuracy <FO>::compute_power (const DataType x_ptr [], long len)
{
	assert (x_ptr != 0);
	assert (len > 0);

	BigFloat		power = 0;
	for (long pos = 0; pos < len; ++pos)
	{
		const BigFloat	val = x_ptr [pos];

		power += val * val;
	}

	using namespace std;

	power = sqrt (power) / len;

	return (power);
}



template <class FO>
typename TestAccuracy <FO>::BigFloat	TestAccuracy <FO>::compute_power (const DataType x_ptr [], const DataType y_ptr [], long len)
{
	assert (x_ptr != 0);
	assert (y_ptr != 0);
	assert (len > 0);

	return ((compute_power (x_ptr, len) + compute_power (y_ptr, len)) * 0.5);
}



template <class FO>
void	TestAccuracy <FO>::compare_vect (const DataType x_ptr [], const DataType y_ptr [], BigFloat &power, long &max_err_pos, long len)
{
	assert (x_ptr != 0);
	assert (y_ptr != 0);
	assert (len > 0);
	assert (&power != 0);
	assert (&max_err_pos != 0);

	power = 0;
	BigFloat			max_dif2 = 0;
	max_err_pos = -1;

	for (long pos = 0; pos < len; ++pos)
	{
		const BigFloat	x = x_ptr [pos];
		const BigFloat	y = y_ptr [pos];
		const BigFloat	dif = y - x;
		const BigFloat	dif2 = dif * dif;

		power += dif2;
		if (dif2 > max_dif2)
		{
			max_err_pos = pos;
			max_dif2 = dif2;
		}
	}

	using namespace std;

	power = sqrt (power) / len;
}



#endif	// TestAccuracy_CODEHEADER_INCLUDED

#undef TestAccuracy_CURRENT_CODEHEADER



/*\\\ EOF \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/