Mercurial > octave-antonio

annotate scripts/linear-algebra/bandwidth.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
20160
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
25 ## 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
26 ## 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
27 ##
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
28 ## 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
29 ## subdiagonals/superdiagonals with nonzero entries.
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18904
diff changeset
30 ##
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
31 ## @seealso{isbanded, isdiag, istril, istriu}
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
32 ## @end deftypefn
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
33
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
34 ## Author: Massimiliano Fasi
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
35
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
36 function [lower, upper] = bandwidth (A, type)
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 if (! ((nargin == 1 && nargout == 2) || (nargin == 2 && nargout <= 1)))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
39 print_usage ();
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
40 endif
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 (! isnumeric (A) && ! islogical (A) || ndims (A) != 2)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
43 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
44 elseif (nargin == 2 && ! (strcmp (type, "lower") || strcmp (type, "upper")))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
45 error ('bandwidth: TYPE must be "lower" or "upper"');
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
46 endif
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
47
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
48 if (nargin == 1)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
49 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
50 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
51 lower = upper = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
52 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
53 lower = max (i - j);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
54 upper = max (j - i);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
55 endif
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 [i, j] = find (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
58 if (isempty (i))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
59 lower = 0;
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
60 elseif (strcmp (type, "lower"))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
61 lower = max (i - j);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
62 else
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
63 lower = max (j - i);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
64 endif
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
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
67 endfunction
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
68
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 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
71 %! [a,b] = bandwidth (speye (100));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
72 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
73 %! assert (bandwidth (speye (100), "upper"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
74 %! assert (bandwidth (speye (100), "lower"), 0);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
75
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
76 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
77 %! 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
78 %! [a,b] = bandwidth (A);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
79 %! assert ([a,b] == [1,1]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
80 %! assert (bandwidth (A, "lower"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
81 %! assert (bandwidth (A, "upper"), 1);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
82
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
83 %!assert (bandwidth ([], "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
84 %!assert (bandwidth ([], "upper"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
85 %!assert (bandwidth (zeros (3,3), "lower"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
86 %!assert (bandwidth (zeros (3,3), "upper"), 0)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
87 %!assert (bandwidth (ones (5,5), "lower"), 4)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
88 %!assert (bandwidth (ones (5,5), "upper"), 4)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
89
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
90 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
91 %! [a,b] = bandwidth ([]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
92 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
93 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
94 %! [a,b] = bandwidth (zeros (3,3));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
95 %! assert ([a,b] == [0,0]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
96 %!test
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
97 %! [a,b] = bandwidth (ones (5,5));
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
98 %! assert ([a,b] == [4,4]);
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
99
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
100 ## Test input validation
18904
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
101 %!error bandwidth ()
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
102 %!error bandwidth (1,2,3)
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
103 %!error [a,b,c] = bandwidth (ones (2))
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
104 %!error [a,b] = bandwidth (ones (2), "upper")
9addb5ad9426 bandwidth.m: Add new function.
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff changeset
105 %!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
106 %!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
107 %!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
108 %!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
109