Mercurial > octave-antonio
annotate scripts/linear-algebra/bandwidth.m @ 19833:9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Try to trim long lines to < 80 chars.
Use '##' for single line comments.
Use '(...)' around tests for if/elseif/switch/while.
Abut cell indexing operator '{' next to variable.
Abut array indexing operator '(' next to variable.
Use space between negation operator '!' and following expression.
Use two newlines between endfunction and start of %!test or %!demo code.
Remove unnecessary parens grouping between short-circuit operators.
Remove stray extra spaces (typos) between variables and assignment operators.
Remove stray extra spaces from ends of lines.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 23 Feb 2015 14:54:39 -0800 |
parents | 4197fc428c7d |
children | 03b9d17a2d95 |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19597
diff
changeset
|
1 ## Copyright (C) 2014-2015 Massimiliano Fasi |
18904
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
2 ## |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
4 ## |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
9 ## |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
10 ## 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
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
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 ## 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
|
16 ## along with Octave; see the file COPYING. If not, see |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
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 ## -*- texinfo -*- |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
20 ## @deftypefn {Function File} {@var{bw} =} bandwidth (@var{A}, @var{type}) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
21 ## @deftypefnx {Function File} {[@var{lower}, @var{upper}] =} bandwidth (@var{A}) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
22 ## Compute the bandwidth of @var{A}. |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
23 ## |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
24 ## The @var{type} argument is the string @qcode{"lower"} for the lower |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
25 ## bandwidth and @qcode{"upper"} for the upper bandwidth. |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
26 ## If no @var{type} is specified return both the lower and upper bandwidth |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18904
diff
changeset
|
27 ## of @var{A}. |
18904
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
28 ## |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
29 ## 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
|
30 ## subdiagonals/superdiagonals with nonzero entries. |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18904
diff
changeset
|
31 ## |
18904
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
32 ## @seealso{isbanded, isdiag, istril, istriu} |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
33 ## @end deftypefn |
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 ## Author: Massimiliano Fasi |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
36 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
37 function [lower, upper] = bandwidth (A, type) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
38 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
39 if (! ((nargin == 1 && nargout == 2) || (nargin == 2 && nargout <= 1))) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
40 print_usage (); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
41 endif |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
42 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
43 if (! isnumeric (A) && ! islogical (A) || ndims (A) != 2) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
44 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
|
45 elseif (nargin == 2 && ! (strcmp (type, "lower") || strcmp (type, "upper"))) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
46 error ('bandwidth: TYPE must be "lower" or "upper"'); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
47 endif |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
48 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
49 if (nargin == 1) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
50 [i, j] = find (A); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
51 if (isempty (i)) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
52 lower = upper = 0; |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
53 else |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
54 lower = max (i - j); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
55 upper = max (j - i); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
56 endif |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
57 else |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
58 [i, j] = find (A); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
59 if (isempty (i)) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
60 lower = 0; |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
61 elseif (strcmp (type, "lower")) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
62 lower = max (i - j); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
63 else |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
64 lower = max (j - i); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
65 endif |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
66 endif |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
67 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
68 endfunction |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
69 |
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 %!test |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
72 %! [a,b] = bandwidth (speye (100)); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
73 %! assert ([a,b] == [0,0]); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
74 %! assert (bandwidth (speye (100), "upper"), 0); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
75 %! assert (bandwidth (speye (100), "lower"), 0); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
76 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
77 %!test |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
78 %! 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
|
79 %! [a,b] = bandwidth (A); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
80 %! assert ([a,b] == [1,1]); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
81 %! assert (bandwidth (A, "lower"), 1); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
82 %! assert (bandwidth (A, "upper"), 1); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
83 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
84 %!assert (bandwidth ([], "lower"), 0) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
85 %!assert (bandwidth ([], "upper"), 0) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
86 %!assert (bandwidth (zeros (3,3), "lower"), 0) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
87 %!assert (bandwidth (zeros (3,3), "upper"), 0) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
88 %!assert (bandwidth (ones (5,5), "lower"), 4) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
89 %!assert (bandwidth (ones (5,5), "upper"), 4) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
90 |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
91 %!test |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
92 %! [a,b] = bandwidth ([]); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
93 %! assert ([a,b] == [0,0]); |
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 (zeros (3,3)); |
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 (ones (5,5)); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
99 %! assert ([a,b] == [4,4]); |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
100 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
101 ## Test input validation |
18904
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
102 %!error bandwidth () |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
103 %!error bandwidth (1,2,3) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
104 %!error [a,b,c] = bandwidth (ones (2)) |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
105 %!error [a,b] = bandwidth (ones (2), "upper") |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
106 %!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
|
107 %!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
|
108 %!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
|
109 %!error <TYPE must be "lower" or "upper"> bandwidth (ones (2), "uppper") |
9addb5ad9426
bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
110 |