Mercurial > octave

annotate scripts/linear-algebra/bandwidth.m @ 28073:a3b40e48c069 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bandwidth: allow nargout == 1 when TYPE is not specified * bandwidth: Don't check nargout when validating argument list, just require 1 or two arguments. Update tests.
author John W. Eaton <jwe@octave.org>
date Mon, 17 Feb 2020 14:16:58 -0500
parents a4268efb7334
children 28de41192f3c 0a5b15007766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## 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
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/>.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
7 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
8 ## This file is part of Octave.
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
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.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
14 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
15 ## 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
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.
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
19 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
20 ## 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
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 ########################################################################
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
25
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20160
diff changeset
27 ## @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
28 ## @deftypefnx {} {[@var{lower}, @var{upper}] =} bandwidth (@var{A})
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
29 ## Compute the bandwidth of @var{A}.
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
30 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
31 ## 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
32 ## 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
33 ## 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
34 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
35 ## 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
36 ## subdiagonals/superdiagonals with nonzero entries.
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18904
diff changeset
37 ##
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
38 ## @seealso{isbanded, isdiag, istril, istriu}
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
39 ## @end deftypefn
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
40
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
41 function [lower, upper] = bandwidth (A, type)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
42
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
43 if (nargin < 1 || nargin > 2)
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
44 print_usage ();
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
45 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
46
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
47 if (! isnumeric (A) && ! islogical (A) || ndims (A) != 2)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
48 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
49 elseif (nargin == 2 && ! (strcmp (type, "lower") || strcmp (type, "upper")))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
50 error ('bandwidth: TYPE must be "lower" or "upper"');
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
51 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
52
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
53 if (nargin == 1)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
54 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
55 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
56 lower = upper = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
57 else
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
58 lower = max (0, max (i - j));
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
59 upper = max (0, max (j - i));
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
60 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
61 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
62 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
63 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
64 lower = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
65 elseif (strcmp (type, "lower"))
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
66 lower = max (0, max (i - j));
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
67 else
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
68 lower = max (0, max (j - i));
18904
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 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
71
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
72 endfunction
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
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
75 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
76 %! [a,b] = bandwidth (speye (100));
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
77 %! assert ([a,b], [0,0]);
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
78 %! assert (bandwidth (speye (100), "upper"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
79 %! assert (bandwidth (speye (100), "lower"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
80
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
81 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
82 %! 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
83 %! [a,b] = bandwidth (A);
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
84 %! assert ([a,b], [1,1]);
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
85 %! assert (bandwidth (A, "lower"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
86 %! assert (bandwidth (A, "upper"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
87
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
88 %!assert (bandwidth ([], "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
89 %!assert (bandwidth ([], "upper"), 0)
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
90 %!assert (bandwidth ([]), 0)
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
91 %!assert (bandwidth (zeros (3,3), "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
92 %!assert (bandwidth (zeros (3,3), "upper"), 0)
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
93 %!assert (bandwidth (zeros (3,3)), 0)
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
94 %!assert (bandwidth (ones (5,5), "lower"), 4)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
95 %!assert (bandwidth (ones (5,5), "upper"), 4)
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
96 %!assert (bandwidth (ones (5,5)), 4)
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
97
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
98 %!assert (bandwidth ([0,1,2,0]), 0)
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
99
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 ([]);
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
102 %! assert ([a,b], [0,0]);
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
103 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
104 %! [a,b] = bandwidth (zeros (3,3));
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
105 %! assert ([a,b], [0,0]);
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
106 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
107 %! [a,b] = bandwidth (ones (5,5));
28073
a3b40e48c069 bandwidth: allow nargout == 1 when TYPE is not specified
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
108 %! assert ([a,b], [4,4]);
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
109
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
110 ## Test input validation
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
111 %!error bandwidth ()
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
112 %!error bandwidth (1,2,3)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
113 %!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
114 %!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
115 %!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
116 %!error <TYPE must be "lower" or "upper"> bandwidth (ones (2), "uppper")