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

annotate scripts/special-matrix/hankel.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	7854d5752dd2
children	5d3faba0342e

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

Mercurial > octave

annotate scripts/special-matrix/hankel.m @ 30564:796f54d4ddbf stable