annotate scripts/signal/fftfilt.m @ 20614:10ec79b47808

use new string_value method to handle value extraction errors * __voronoi__.cc, chol.cc, colamd.cc, fftw.cc: Use new string_value method.
author John W. Eaton <jwe@octave.org>
date Thu, 08 Oct 2015 18:15:56 -0400
parents f1d0f506ee78
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 17753
diff changeset
1 ## Copyright (C) 1994-2015 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
18
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
17717
76f448d8089d doc: minor cleanup of fftfilt docstring
Mike Miller <mtmiller@ieee.org>
parents: 17170
diff changeset
20 ## @deftypefn {Function File} {} fftfilt (@var{b}, @var{x})
76f448d8089d doc: minor cleanup of fftfilt docstring
Mike Miller <mtmiller@ieee.org>
parents: 17170
diff changeset
21 ## @deftypefnx {Function File} {} fftfilt (@var{b}, @var{x}, @var{n})
20200
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
22 ## Filter @var{x} with the FIR filter @var{b} using the FFT.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3367
diff changeset
23 ##
20200
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
24 ## If @var{x} is a matrix, filter each column of the matrix.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3367
diff changeset
25 ##
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
26 ## Given the optional third argument, @var{n}, @code{fftfilt} uses the
20200
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
27 ## overlap-add method to filter @var{x} with @var{b} using an N-point FFT@.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
28 ## The FFT size must be an even power of 2 and must be greater than or equal to
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
29 ## the length of @var{b}. If the specified @var{n} does not meet these
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
30 ## criteria, it is automatically adjusted to the nearest value that does.
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
31 ##
12546
39ca02387a32 Improve docstrings for a number of functions.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
32 ## @seealso{filter, filter2}
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
33 ## @end deftypefn
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
34
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
35 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
36 ## Created: 3 September 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
37 ## Adapted-By: jwe
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
38
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
39 function y = fftfilt (b, x, n)
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
40
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
41 ## If N is not specified explicitly, we do not use the overlap-add
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
42 ## method at all because loops are really slow. Otherwise, we only
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
43 ## ensure that the number of points in the FFT is the smallest power
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
44 ## of two larger than N and length(b). This could result in length
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
45 ## one blocks, but if the user knows better ...
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
46
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
47 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
48 print_usage ();
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
49 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
50
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
51 transpose = (rows (x) == 1);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
52
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
53 if (transpose)
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
54 x = x.';
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
55 endif
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
56
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
57 [r_x, c_x] = size (x);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
58 [r_b, c_b] = size (b);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
59
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
60 if (! isvector (b))
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
61 error ("fftfilt: B must be a vector");
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
62 endif
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
63
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
64 if (ndims (x) != 2)
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
65 error ("fftfilt: X must be a 1-D or 2-D array");
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
66 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
67
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
68 l_b = r_b * c_b;
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
69 b = reshape (b, l_b, 1);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
70
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
71 if (nargin == 2)
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
72 ## Use FFT with the smallest power of 2 which is >= length (x) +
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
73 ## length (b) - 1 as number of points ...
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
74 n = 2 ^ nextpow2 (r_x + l_b - 1);
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
75 B = fft (b, n);
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
76 y = ifft (fft (x, n) .* B(:, ones (1, c_x)));
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
77 else
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
78 ## Use overlap-add method ...
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
79 if (! (isscalar (n)))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11469
diff changeset
80 error ("fftfilt: N has to be a scalar");
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
81 endif
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
82 n = 2 ^ nextpow2 (max ([n, l_b]));
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
83 L = n - l_b + 1;
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
84 B = fft (b, n);
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
85 B = B(:, ones (c_x,1));
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
86 R = ceil (r_x / L);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
87 y = zeros (r_x, c_x);
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
88 for r = 1:R;
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
89 lo = (r - 1) * L + 1;
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
90 hi = min (r * L, r_x);
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
91 tmp = zeros (n, c_x);
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
92 tmp(1:(hi-lo+1),:) = x(lo:hi,:);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
93 tmp = ifft (fft (tmp) .* B);
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 7017
diff changeset
94 hi = min (lo+n-1, r_x);
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
95 y(lo:hi,:) = y(lo:hi,:) + tmp(1:(hi-lo+1),:);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
96 endfor
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
97 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
98
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
99 y = y(1:r_x, :);
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
100
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
101 ## Final cleanups:
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
102
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
103 ## - If both b and x are real, y should be real.
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
104 ## - If b is real and x is imaginary, y should be imaginary.
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
105 ## - If b is imaginary and x is real, y should be imaginary.
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
106 ## - If both b and x are imaginary, y should be real.
16436
39847dcd2568 * fftfilt.m: simplify computation of xisreal and xisimag
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16429
diff changeset
107 xisreal = all (imag (x) == 0);
39847dcd2568 * fftfilt.m: simplify computation of xisreal and xisimag
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16429
diff changeset
108 xisimag = all (real (x) == 0);
39847dcd2568 * fftfilt.m: simplify computation of xisreal and xisimag
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16429
diff changeset
109
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
110 if (all (imag (b) == 0))
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
111 y (:,xisreal) = real (y (:,xisreal));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
112 y (:,xisimag) = complex (real (y (:,xisimag)) * 0, imag (y (:,xisimag)));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
113 elseif (all (real (b) == 0))
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
114 y (:,xisreal) = complex (real (y (:,xisreal)) * 0, imag (y (:,xisreal)));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
115 y (:,xisimag) = real (y (:,xisimag));
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
116 endif
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
117
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
118 ## - If both x and b are integer in both real and imaginary
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
119 ## components, y should be integer.
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
120 if (! any (b - fix (b)))
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
121 idx = find (! any (x - fix (x)));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
122 y (:, idx) = round (y (:, idx));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
123 endif
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
124
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
125 ## Transpose after cleanup, otherwise rounding fails.
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
126 if (transpose)
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
127 y = y.';
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
128 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
129
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
130 endfunction
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
131
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
132
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
133 %!shared b, x, r
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
134
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
135 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
136 %! b = [1 1];
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
137 %! x = [1, zeros(1,9)];
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
138 %! assert (fftfilt (b, x ), [1 1 0 0 0 0 0 0 0 0] );
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
139 %! assert (fftfilt (b, x.'), [1 1 0 0 0 0 0 0 0 0].');
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
140 %! assert (fftfilt (b.',x ), [1 1 0 0 0 0 0 0 0 0] );
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
141 %! assert (fftfilt (b.',x.'), [1 1 0 0 0 0 0 0 0 0].');
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
142 %! assert (fftfilt (b, [x.' x.']), [1 1 0 0 0 0 0 0 0 0].'*[1 1]);
17140
b9ffacf34c2d fftfilt.m: Increase %!test tolerance to 2*eps (bug #39647)
Rik <rik@octave.org>
parents: 17091
diff changeset
143 %! assert (fftfilt (b, [x.'+2*eps x.']) == [1 1 0 0 0 0 0 0 0 0].'*[1 1], [false(10, 1) true(10, 1)]);
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
144
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
145 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
146 %! r = sqrt (1/2) * (1+i);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
147 %! b = b*r;
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
148 %! assert (fftfilt (b, x ), r*[1 1 0 0 0 0 0 0 0 0] , eps );
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
149 %! assert (fftfilt (b, r*x), r*r*[1 1 0 0 0 0 0 0 0 0], 2*eps);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
150 %! assert (fftfilt (b, x.'), r*[1 1 0 0 0 0 0 0 0 0].', eps );
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
151
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
152 %!test
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
153 %! b = [1 1];
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
154 %! x = zeros (10,3); x(1,1)=-1; x(1,2)=1;
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
155 %! y0 = zeros (10,3); y0(1:2,1)=-1; y0(1:2,2)=1;
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
156 %! y = fftfilt (b, x);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
157 %! assert (y0, y);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
158 %! y = fftfilt (b*i, x);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
159 %! assert (y0*i, y);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
160 %! y = fftfilt (b, x*i);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
161 %! assert (y0*i, y);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
162 %! y = fftfilt (b*i, x*i);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
163 %! assert (-y0, y);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
164 %! x = rand (10, 1);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
165 %! y = fftfilt (b, [x x*i]);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
166 %! assert (true, isreal (y(:,1)));
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
167 %! assert (false, any (real (y(:,2))));
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
168
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
169 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
170 %! b = rand (10, 1);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
171 %! x = rand (10, 1);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
172 %! y0 = filter (b, 1, x);
16429
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
173 %! y = fftfilt (b, x);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
174 %! assert (y0, y, 16*eps);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
175 %! y0 = filter (b*i, 1, x*i);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
176 %! y = fftfilt (b*i, x*i);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
177 %! assert (y0, y, 16*eps);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
178
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
179 %!test
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
180 %! b = rand (10, 1) + i*rand (10, 1);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
181 %! x = rand (10, 1) + i*rand (10, 1);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
182 %! y0 = filter (b, 1, x);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
183 %! y = fftfilt (b, x);
586972e3ea7a Correct errors in the fftfilt rounding (bug #37297), add more robust tests.
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 14363
diff changeset
184 %! assert (y0, y, 55*eps);
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
185
19867
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
186 ## Test input validation
13092
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
187 %!error fftfilt (1)
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
188 %!error fftfilt (1, 2, 3, 4)
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
189 %!error fftfilt (ones (2), 1)
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
190 %!error fftfilt (2, ones (3,3,3))
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
191 %!error fftfilt (2, 1, ones (2))
186c3b80ba54 codesprint: Tests for fftfilt()
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
192