octave: scripts/special-matrix/hankel.m annotate

annotate scripts/special-matrix/hankel.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 1993-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27898 diff changeset	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27898 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27898 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27898 diff changeset	5 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	7 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	11 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## (at your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	18 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	19 ## 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	20 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	21 ## <https://www.gnu.org/licenses/>.
245 16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe] jwe parents: 4 diff changeset	22
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20162 diff changeset	24 ## @deftypefn {} {} hankel (@var{c})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20162 diff changeset	25 ## @deftypefnx {} {} hankel (@var{c}, @var{r})
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	26 ## Return the Hankel matrix constructed from the first column @var{c}, and
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## (optionally) the last row @var{r}.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3408 diff changeset	28 ##
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	29 ## If the last element of @var{c} is not the same as the first element of
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	30 ## @var{r}, the last element of @var{c} is used. If the second argument is
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21443 diff changeset	31 ## omitted, it is assumed to be a vector of zeros with the same size as
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 21443 diff changeset	32 ## @var{c}.
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	33 ##
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	34 ## A Hankel matrix formed from an m-vector @var{c}, and an n-vector @var{r},
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	35 ## has the elements
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	36 ## @tex
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	37 ## $$
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38 ## H(i, j) = \cases{c_{i+j-1},&$i+j-1\le m$;\cr r_{i+j-m},&otherwise.\cr}
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	39 ## $$
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	40 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7411 diff changeset	41 ## @ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3408 diff changeset	42 ##
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	43 ## @example
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	44 ## @group
4922 cee8d88cf619 [project @ 2004-07-30 19:10:16 by jwe] jwe parents: 3426 diff changeset	45 ## H(i,j) = c(i+j-1), i+j-1 <= m;
cee8d88cf619 [project @ 2004-07-30 19:10:16 by jwe] jwe parents: 3426 diff changeset	46 ## H(i,j) = r(i+j-m), otherwise
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	47 ## @end group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	48 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	49 ##
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7411 diff changeset	50 ## @end ifnottex
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 ## @seealso{hadamard, toeplitz}
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3140 diff changeset	52 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	53
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	54 function retval = hankel (c, r)
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	55
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	56 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5731 diff changeset	57 print_usage ();
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	58 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	59
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	60 if (nargin == 1)
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	61
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	62 if (! isvector (c))
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	63 error ("hankel: C must be a vector");
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	64 endif
1396 1ff9a86e2ad5 [project @ 1995-09-14 19:46:14 by jwe] jwe parents: 1315 diff changeset	65
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	66 nr = length (c);
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	67 nc = nr;
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	68 data = [c(:) ; zeros(nr, 1)];
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	69
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	70 else
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	71
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	72 if (! (isvector (c) && isvector (r)))
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	73 error ("hankel: C and R must be vectors");
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	74 elseif (r(1) != c(end))
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	75 warning ("hankel: column wins anti-diagonal conflict");
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	76 endif
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	77
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	78 nr = length (c);
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	79 nc = length (r);
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	80 data = [c(:) ; r(2:end)(:)];
1396 1ff9a86e2ad5 [project @ 1995-09-14 19:46:14 by jwe] jwe parents: 1315 diff changeset	81
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	82 endif
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	83
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	84 slices = cellslices (data, 1:nc, nr:1:nc+nr-1);
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	85 retval = horzcat (slices{:});
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	86
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	87 endfunction
5731 c7d5a534afa5 [project @ 2006-04-03 19:33:26 by jwe] jwe parents: 5642 diff changeset	88
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	89
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	90 %!assert (hankel (1), [1])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	91 %!assert (hankel ([1, 2]), [1, 2; 2, 0])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	92 %!assert (hankel ([1, 2], [2; -1; -3]), [1, 2, -1; 2, -1, -3])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	93 %!assert (hankel (1:3), [1,2,3;2,3,0;3,0,0])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	94 %!assert (hankel (1:3,3:6), [1,2,3,4;2,3,4,5;3,4,5,6])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	95 %!assert (hankel (1:3,3:4), [1,2;2,3;3,4])
21443 acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation. Rik <rik@octave.org> parents: 20852 diff changeset	96 %!warning <column wins anti-diagonal conflict>
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation. Rik <rik@octave.org> parents: 20852 diff changeset	97 %! assert (hankel (1:3,4:6), [1,2,3;2,3,5;3,5,6]);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	98
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	99 %!error hankel ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	100 %!error hankel (1, 2, 3)
13888 c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	101 %!error <C must be a vector> hankel ([1, 2; 3, 4])
c78ac846fcbc hankel.m: Recode for 3.5X speedup Rik <octave@nomad.inbox5.com> parents: 12639 diff changeset	102 %!error <C and R must be vectors> hankel (1:4, [1, 2; 3, 4])

Mercurial > octave

annotate scripts/special-matrix/hankel.m @ 27919:1891570abac8