Mercurial > hg > octave-lyh
annotate scripts/polynomial/conv.m @ 14200:64d9f33313cc stable rc-3-6-0-1
3.6.0-rc1 release candidate
* configure.ac (AC_INIT): Version is now 3.6.0-rc1.
(OCTAVE_RELEASE_DATE): Now 2012-01-12.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 12 Jan 2012 14:31:50 -0500 |
parents | 72c96de7a403 |
children | 12c70d00c04e |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14104
diff
changeset
|
1 ## Copyright (C) 1994-2012 John W. Eaton |
2313 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
1025 | 18 |
3368 | 19 ## -*- texinfo -*- |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
20 ## @deftypefn {Function File} {} conv (@var{a}, @var{b}) |
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
21 ## @deftypefnx {Function File} {} conv (@var{a}, @var{b}, @var{shape}) |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
22 ## Convolve two vectors @var{a} and @var{b}. |
3426 | 23 ## |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
24 ## The output convolution is a vector with length equal to |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
25 ## @code{length (@var{a}) + length (@var{b}) - 1}. |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
26 ## When @var{a} and @var{b} are the coefficient vectors of two polynomials, the |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
27 ## convolution represents the coefficient vector of the product polynomial. |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
28 ## |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
29 ## The optional @var{shape} argument may be |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
30 ## |
11084 | 31 ## @table @asis |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
32 ## @item @var{shape} = "full" |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
33 ## Return the full convolution. (default) |
11084 | 34 ## |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
35 ## @item @var{shape} = "same" |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
36 ## Return the central part of the convolution with the same size as @var{a}. |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
37 ## @end table |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
38 ## |
14104
614505385171
doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents:
13295
diff
changeset
|
39 ## @seealso{deconv, conv2, convn, fftconv} |
3368 | 40 ## @end deftypefn |
2311 | 41 |
3202 | 42 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
2312 | 43 ## Created: June 1994 |
44 ## Adapted-By: jwe | |
45 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
46 function y = conv (a, b, shape = "full") |
2325 | 47 |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
48 if (nargin < 2 || nargin > 3) |
6046 | 49 print_usage (); |
787 | 50 endif |
51 | |
4030 | 52 if (! (isvector (a) && isvector (b))) |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
53 error ("conv: both arguments A and B must be vectors"); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 elseif (nargin == 3 && ! any (strcmpi (shape, {"full", "same"}))) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
55 error ('conv: SHAPE argument must be "full" or "same"'); |
787 | 56 endif |
57 | |
58 la = length (a); | |
59 lb = length (b); | |
60 | |
61 ly = la + lb - 1; | |
62 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
63 if (ly == 0) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
64 y = zeros (1, 0); |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
65 return; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
66 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
67 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
68 ## Use shortest vector as the coefficent vector to filter. |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
69 if (la > lb) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
70 [a, b] = deal (b, a); # Swap vectors |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
71 lb = la; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
72 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
73 x = b; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
74 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
75 ## Pad longer vector to convolution length. |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
76 if (ly > lb) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
77 x(end+1:end+ly-lb) = 0; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
78 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
79 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
80 y = filter (a, 1, x); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
81 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
82 if (strcmp (shape, "same")) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
83 idx = ceil ((ly - la) / 2); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
84 y = y(idx+1:idx+la); |
787 | 85 endif |
86 | |
87 endfunction | |
7411 | 88 |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
89 |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
90 %!test |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
91 %! x = ones(3,1); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
92 %! y = ones(1,3); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
93 %! b = 2; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
94 %! c = 3; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
95 %! assert (conv (x, x), [1; 2; 3; 2; 1]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
96 %! assert (conv (y, y), [1, 2, 3, 2, 1]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
97 %! assert (conv (x, y), [1, 2, 3, 2, 1]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
98 %! assert (conv (y, x), [1; 2; 3; 2; 1]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
99 %! assert (conv (c, x), [3; 3; 3]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
100 %! assert (conv (c, y), [3, 3, 3]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
101 %! assert (conv (x, c), [3; 3; 3]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
102 %! assert (conv (y, c), [3, 3, 3]); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
103 %! assert (conv (b, c), 6); |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
104 |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
105 %!test |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
106 %! a = 1:10; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
107 %! b = 1:3; |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
108 %! assert (size (conv(a,b)), [1, numel(a)+numel(b)-1]); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
109 %! assert (size (conv(b,a)), [1, numel(a)+numel(b)-1]); |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
110 |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
111 %!test |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
112 %! a = (1:10).'; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
113 %! b = 1:3; |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
114 %! assert (size (conv(a,b)), [numel(a)+numel(b)-1, 1]); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
115 %! assert (size (conv(b,a)), [numel(a)+numel(b)-1, 1]); |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
116 |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
117 %!test |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
118 %! a = 1:10; |
11124 | 119 %! b = (1:3).'; |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
120 %! assert (size (conv(a,b)), [1, numel(a)+numel(b)-1]); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
121 %! assert (size (conv(b,a)), [1, numel(a)+numel(b)-1]); |
11124 | 122 |
123 %!test | |
124 %! a = 1:10; | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
125 %! b = 1:3; |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
126 %! assert (conv (a,b,"full"), conv (a,b)); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
127 %! assert (conv (b,a,"full"), conv (b,a)); |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
128 |
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
129 %!test |
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
130 %! a = 1:10; |
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
131 %! b = 1:3; |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
132 %! assert (conv (a,b,"same"), [4, 10, 16, 22, 28, 34, 40, 46, 52, 47]); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
133 %! assert (conv (b,a,"same"), [28, 34, 40]); |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
134 |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
135 %% Test input validation |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
136 %!error conv (1) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
137 %!error conv (1,2,3,4) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
138 %!error conv ([1, 2; 3, 4], 3) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
139 %!error conv (3, [1, 2; 3, 4]) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
140 %!error conv (2, 3, "XXXX") |
11124 | 141 |