octave-nkf: scripts/polynomial/conv.m annotate

annotate scripts/polynomial/conv.m @ 10224:f6e0404421f4

point to polyint in @seealso, not polyinteg

author	John W. Eaton <jwe@octave.org>
date	Fri, 29 Jan 2010 12:52:32 -0500
parents	38a0f9dc0ab4
children	4558aad4c41d

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	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 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ## 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	7 ## 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	8 ## 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	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## 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	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## 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	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	16 ## 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	17 ## 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	18 ## <http://www.gnu.org/licenses/>.
1025 f558749713f1 [project @ 1995-01-11 20:52:10 by jwe] jwe parents: 904 diff changeset	19
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	20 ## -- texinfo --
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	21 ## @deftypefn {Function File} {} conv (@var{a}, @var{b})
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	22 ## Convolve two vectors.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3368 diff changeset	23 ##
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	24 ## @code{y = conv (a, b)} returns a vector of length equal to
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	25 ## @code{length (a) + length (b) - 1}.
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	26 ## If @var{a} and @var{b} are polynomial coefficient vectors, @code{conv}
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	27 ## returns the coefficients of the product polynomial.
10224 f6e0404421f4 point to polyint in @seealso, not polyinteg John W. Eaton <jwe@octave.org> parents: 9433 diff changeset	28 ## @seealso{deconv, poly, roots, residue, polyval, polyderiv, polyint}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3202 diff changeset	29 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	30
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 2847 diff changeset	31 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	32 ## Created: June 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	33 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	34
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	35 function y = conv (a, b)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2313 diff changeset	36
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	37 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	38 print_usage ();
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	39 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	40
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3457 diff changeset	41 if (! (isvector (a) && isvector (b)))
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	42 error ("conv: both arguments must be vectors");
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	43 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	44
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	45 la = length (a);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	46 lb = length (b);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	47
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	48 ly = la + lb - 1;
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	49
2303 5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe] jwe parents: 1887 diff changeset	50 ## Use the shortest vector as the coefficent vector to filter.
8158 15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	51 ## Preserve the row/column orientation of the longer input.
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	52 if (la <= lb)
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	53 if (ly > lb)
8158 15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	54 if (size (b, 1) <= size (b, 2))
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	55 x = [b, (zeros (1, ly - lb))];
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	56 else
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	57 x = [b; (zeros (ly - lb, 1))];
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	58 endif
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	59 else
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	60 x = b;
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	61 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	62 y = filter (a, 1, x);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	63 else
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	64 if (ly > la)
8158 15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	65 if (size (a, 1) <= size (a, 2))
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	66 x = [a, (zeros (1, ly - la))];
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	67 else
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	68 x = [a; (zeros (ly - la, 1))];
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	69 endif
787 c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	70 else
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	71 x = a;
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	72 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	73 y = filter (b, 1, x);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	74 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	75
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe] jwe parents: diff changeset	76 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	77
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	78 %!test
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	79 %! x = ones(3,1);
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	80 %! y = ones(1,3);
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	81 %! b = 2;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	82 %! c = 3;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	83 %! 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	84 %! 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	85 %! 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	86 %! 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	87 %! 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	88 %! 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	89 %! 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	90 %! 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	91 %! assert (conv (b, c), 6);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	92 %!error conv ([1, 2; 3, 4], 3);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	93 %!error conv (2, []);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	94
8158 15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	95 %!test
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	96 %! a = 1:10;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	97 %! b = 1:3;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	98 %! 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	99 %! 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	100
15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	101 %!test
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	102 %! a = (1:10).';
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	103 %! b = 1:3;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	104 %! 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	105 %! 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	106
8158 15e4a450bf84 conv.m: Correct row/col orientation of output Ben Abbott <bpabbott@mac.com> parents: 7411 diff changeset	107 %!test
9433 38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	108 %! a = 1:10;
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	109 %! b = (1:3).';
38a0f9dc0ab4 conv.m: fix Matlab incompatibility; new tests Robert T. Short <octave@phaselockedsystems.com> parents: 8920 diff changeset	110 %! 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	111 %! assert (size(conv(b,a)), [1, numel(a)+numel(b)-1])

Mercurial > octave-nkf

annotate scripts/polynomial/conv.m @ 10224:f6e0404421f4