Mercurial > hg > octave-lyh
annotate scripts/polynomial/conv.m @ 11084:0f6c5efce96e
conv.m: docstring fix
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 07 Oct 2010 03:18:44 -0400 |
parents | 4558aad4c41d |
children | 2beacd515e09 |
rev | line source |
---|---|
7017 | 1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2004, |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
2 ## 2005, 2006, 2007, 2008, 2009 John W. Eaton |
2313 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
2313 | 10 ## |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
1025 | 19 |
3368 | 20 ## -*- texinfo -*- |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
21 ## @deftypefn {Function File} {} conv (@var{a}, @var{b}, @var{shape}) |
2311 | 22 ## Convolve two vectors. |
3426 | 23 ## |
3368 | 24 ## @code{y = conv (a, b)} returns a vector of length equal to |
25 ## @code{length (a) + length (b) - 1}. | |
26 ## If @var{a} and @var{b} are polynomial coefficient vectors, @code{conv} | |
27 ## returns the coefficients of the product polynomial. | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
28 ## |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
29 ## The optional @var{shape} parameter may be |
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" |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
33 ## Return the full convolution. |
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" |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
36 ## Return central part of the convolution with the same size as @var{a}. |
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 ## |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
39 ## @noindent |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
40 ## By default, @var{shape} is @samp{"full"}. |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
41 ## |
10224
f6e0404421f4
point to polyint in @seealso, not polyinteg
John W. Eaton <jwe@octave.org>
parents:
9433
diff
changeset
|
42 ## @seealso{deconv, poly, roots, residue, polyval, polyderiv, polyint} |
3368 | 43 ## @end deftypefn |
2311 | 44 |
3202 | 45 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
2312 | 46 ## Created: June 1994 |
47 ## Adapted-By: jwe | |
48 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
49 function y = conv (a, b, shape = "full") |
2325 | 50 |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
51 if (nargin < 2 || nargin > 3) |
6046 | 52 print_usage (); |
787 | 53 endif |
54 | |
4030 | 55 if (! (isvector (a) && isvector (b))) |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
56 error ("conv: both arguments must be vectors"); |
787 | 57 endif |
58 | |
59 la = length (a); | |
60 lb = length (b); | |
61 | |
62 ly = la + lb - 1; | |
63 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
64 if (ly == 0) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
65 y = zeros (1, 0); |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
66 else |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
67 ## Use the shortest vector as the coefficent vector to filter. |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
68 ## Preserve the row/column orientation of the longer input. |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
69 if (la <= lb) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
70 if (ly > lb) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
71 if (size (b, 1) <= size (b, 2)) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
72 x = [b, (zeros (1, ly - lb))]; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
73 else |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
74 x = [b; (zeros (ly - lb, 1))]; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
75 endif |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
76 else |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
77 x = b; |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
78 endif |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
79 y = filter (a, 1, x); |
787 | 80 else |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
81 if (ly > la) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
82 if (size (a, 1) <= size (a, 2)) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
83 x = [a, (zeros (1, ly - la))]; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
84 else |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
85 x = [a; (zeros (ly - la, 1))]; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
86 endif |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
87 else |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
88 x = a; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
89 endif |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
90 y = filter (b, 1, x); |
787 | 91 endif |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
92 if (strcmp (shape, "same")) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
93 idx = ceil ((ly - la) / 2); |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
94 y = y(idx+1:idx+la); |
787 | 95 endif |
96 endif | |
97 | |
98 endfunction | |
7411 | 99 |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
100 %!test |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
101 %! x = ones(3,1); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
102 %! y = ones(1,3); |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
103 %! b = 2; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
104 %! c = 3; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
105 %! 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
|
106 %! 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
|
107 %! 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
|
108 %! 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
|
109 %! 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
|
110 %! 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
|
111 %! 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
|
112 %! 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
|
113 %! assert (conv (b, c), 6); |
7411 | 114 %!error conv ([1, 2; 3, 4], 3); |
115 %!error conv (2, []); | |
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; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
119 %! b = 1:3; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
120 %! assert (size(conv(a,b)), [1, numel(a)+numel(b)-1]) |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
121 %! assert (size(conv(b,a)), [1, numel(a)+numel(b)-1]) |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
122 |
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
123 %!test |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
124 %! a = 1:10; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
125 %! b = 1:3; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
126 %! assert (size(conv(a,b)), [1, numel(a)+numel(b)-1]) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
127 %! assert (size(conv(b,a)), [1, numel(a)+numel(b)-1]) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
128 |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
129 %! a = (1:10).'; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
130 %! b = 1:3; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
131 %! assert (size(conv(a,b)), [numel(a)+numel(b)-1, 1]) |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
132 %! assert (size(conv(b,a)), [numel(a)+numel(b)-1, 1]) |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
133 |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
134 %!test |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
135 %! a = 1:10; |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
136 %! b = 1:3; |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
137 %! assert (conv(a,b,'same'), [4, 10, 16, 22, 28, 34, 40, 46, 52, 47]) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
138 %! assert (conv(b,a,'same'), [28, 34, 40]) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
139 |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
140 %!test |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
141 %! a = 1:10; |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
142 %! b = (1:3).'; |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
143 %! assert (size(conv(a,b)), [1, numel(a)+numel(b)-1]) |
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
144 %! assert (size(conv(b,a)), [1, numel(a)+numel(b)-1]) |