Mercurial > octave

annotate scripts/linear-algebra/bandwidth.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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) 2014-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
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: 26376
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: 26376
diff changeset
5 ##
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
6 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
7 ## This file is part of Octave.
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
13 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
18 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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/>.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
22
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20160
diff changeset
24 ## @deftypefn {} {@var{bw} =} bandwidth (@var{A}, @var{type})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20160
diff changeset
25 ## @deftypefnx {} {[@var{lower}, @var{upper}] =} bandwidth (@var{A})
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
26 ## Compute the bandwidth of @var{A}.
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
27 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
28 ## The @var{type} argument is the string @qcode{"lower"} for the lower
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
29 ## bandwidth and @qcode{"upper"} for the upper bandwidth. If no @var{type} is
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
30 ## specified return both the lower and upper bandwidth of @var{A}.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
31 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
32 ## The lower/upper bandwidth of a matrix is the number of
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
33 ## subdiagonals/superdiagonals with nonzero entries.
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18904
diff changeset
34 ##
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
35 ## @seealso{isbanded, isdiag, istril, istriu}
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
36 ## @end deftypefn
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
37
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
38 ## Author: Massimiliano Fasi
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
39
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
40 function [lower, upper] = bandwidth (A, type)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
41
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
42 if (! ((nargin == 1 && nargout == 2) || (nargin == 2 && nargout <= 1)))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
43 print_usage ();
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
44 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
45
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
46 if (! isnumeric (A) && ! islogical (A) || ndims (A) != 2)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
47 error ("bandwidth: A must be a 2-D numeric or logical matrix");
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
48 elseif (nargin == 2 && ! (strcmp (type, "lower") || strcmp (type, "upper")))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
49 error ('bandwidth: TYPE must be "lower" or "upper"');
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
50 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
51
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
52 if (nargin == 1)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
53 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
54 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
55 lower = upper = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
56 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
57 lower = max (i - j);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
58 upper = max (j - i);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
59 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
60 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
61 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
62 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
63 lower = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
64 elseif (strcmp (type, "lower"))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
65 lower = max (i - j);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
66 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
67 lower = max (j - i);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
68 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
69 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
70
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
71 endfunction
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
72
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
73
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
74 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
75 %! [a,b] = bandwidth (speye (100));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
76 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
77 %! assert (bandwidth (speye (100), "upper"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
78 %! assert (bandwidth (speye (100), "lower"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
79
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
80 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
81 %! A = [2 3 0 0 0; 1 2 3 0 0; 0 1 2 3 0; 0 0 1 2 3; 0 0 0 1 2];
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
82 %! [a,b] = bandwidth (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
83 %! assert ([a,b] == [1,1]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
84 %! assert (bandwidth (A, "lower"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
85 %! assert (bandwidth (A, "upper"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
86
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
87 %!assert (bandwidth ([], "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
88 %!assert (bandwidth ([], "upper"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
89 %!assert (bandwidth (zeros (3,3), "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
90 %!assert (bandwidth (zeros (3,3), "upper"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
91 %!assert (bandwidth (ones (5,5), "lower"), 4)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
92 %!assert (bandwidth (ones (5,5), "upper"), 4)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
93
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
94 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
95 %! [a,b] = bandwidth ([]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
96 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
97 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
98 %! [a,b] = bandwidth (zeros (3,3));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
99 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
100 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
101 %! [a,b] = bandwidth (ones (5,5));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
102 %! assert ([a,b] == [4,4]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
103
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
104 ## Test input validation
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
105 %!error bandwidth ()
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
106 %!error bandwidth (1,2,3)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
107 %!error [a,b,c] = bandwidth (ones (2))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
108 %!error [a,b] = bandwidth (ones (2), "upper")
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
109 %!error <A must be a 2-D numeric or logical> bandwidth ("string", "lower")
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
110 %!error <A must be a 2-D numeric or logical> bandwidth (ones (3,3,3), "lower")
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
111 %!error <TYPE must be "lower" or "upper"> bandwidth (ones (2), "uper")
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
112 %!error <TYPE must be "lower" or "upper"> bandwidth (ones (2), "uppper")