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

annotate scripts/special-matrix/hankel.m @ 27898:4d6d21839dfd

remove Author: jwe and Adapted-by: jwe lines from source files These lines have little meaning now in the age of modern version control systems. Files affected: url-transfer.cc, url-transfer.h, acot.m, acoth.m, acsc.m, acsch.m, asec.m, asech.m, cot.m, coth.m, csc.m, csch.m, sec.m, sech.m, cart2pol.m, cart2sph.m, deal.m, fliplr.m, flipud.m, int2str.m, logspace.m, num2str.m, pol2cart.m, rot90.m, sortrows.m, sph2cart.m, waitbar.m, doc.m, hsv2rgb.m, rgb2hsv.m, beep.m, isstr.m, setstr.m, strmatch.m, cond.m, rank.m, trace.m, bug_report.m, cast.m, delete.m, dir.m, list_primes.m, ls.m, ls_command.m, menu.m, pack.m, recycle.m, substruct.m, version.m, glpk.m, axis.m, box.m, grid.m, __axis_label__.m, text.m, title.m, view.m, xlabel.m, ylabel.m, zlabel.m, bar.m, barh.m, comet3.m, hist.m, line.m, loglog.m, mesh.m, patch.m, plot.m, polar.m, __bar__.m, __line__.m, __plt__.m, __stem__.m, semilogx.m, semilogy.m, sombrero.m, stairs.m, stem.m, surface.m, __default_plot_options__.m, __gnuplot_drawnow__.m, __next_line_color__.m, __plt_get_axis_arg__.m, __pltopt__.m, clf.m, closereq.m, gca.m, gnuplot_binary.in.m, isfigure.m, meshgrid.m, __gnuplot_draw_axes__.m, __gnuplot_draw_figure__.m, shg.m, addpref.m, getpref.m, ispref.m, loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, ismember.m, setdiff.m, union.m, hankel.m, hilb.m, vander.m, median.m, std.m, cstrcat.m, isletter.m, str2num.m, strcat.m, oruntests.m, rundemos.m, asctime.m, clock.m, ctime.m, date.m, etime.m, is_leap_year.m.

author	John W. Eaton <jwe@octave.org>
date	Thu, 02 Jan 2020 15:43:01 -0500
parents	00f796120a6d
children	b442ec6dda5c

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

Mercurial > octave

annotate scripts/special-matrix/hankel.m @ 27898:4d6d21839dfd