octave-nkf: scripts/linear-algebra/isbanded.m annotate

annotate scripts/linear-algebra/isbanded.m @ 19631:db92e7e28e1f

strip trailing whitespace from most source files * NEWS, doc/interpreter/contributors.in, doc/interpreter/func.txi, doc/interpreter/genpropdoc.m, doc/interpreter/octave_logo.eps, doc/interpreter/plot.txi, doc/interpreter/stmt.txi, examples/data/Makefile.am, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/gl-render.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h, libinterp/corefcn/load-path.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/toplev.h, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/variables.cc, libinterp/octave-value/ov-classdef.cc, libinterp/octave-value/ov-classdef.h, libinterp/octave.cc, libinterp/parse-tree/lex.h, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-classdef.h, liboctave/system/file-ops.cc, liboctave/system/oct-env.cc, m4/acinclude.m4, scripts/deprecated/finite.m, scripts/deprecated/fmod.m, scripts/deprecated/fnmatch.m, scripts/deprecated/luinc.m, scripts/deprecated/octave_tmp_file_name.m, scripts/deprecated/syl.m, scripts/deprecated/usage.m, scripts/general/inputParser.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/isequal.m, scripts/general/private/__isequal__.m, scripts/geometry/voronoi.m, scripts/image/image.m, scripts/image/imshow.m, scripts/image/ind2rgb.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/isbanded.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/delete.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/getappdata.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isappdata.m, scripts/miscellaneous/ls.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/orderfields.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/symvar.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/ver.m, scripts/miscellaneous/what.m, scripts/miscellaneous/xor.m, scripts/miscellaneous/zip.m, scripts/optimization/fminbnd.m, scripts/optimization/sqp.m, scripts/path/private/getsavepath.m, scripts/path/savepath.m, scripts/pkg/pkg.m, scripts/pkg/private/installed_packages.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfnorm.m, scripts/plot/util/copyobj.m, scripts/plot/util/hgload.m, scripts/plot/util/hgsave.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/signal/periodogram.m, scripts/sparse/eigs.m, scripts/sparse/ilu.m, scripts/sparse/qmr.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/specfun/beta.m, scripts/specfun/ellipke.m, scripts/specfun/isprime.m, scripts/statistics/base/lscov.m, scripts/testfun/__run_test_suite__.m, scripts/testfun/test.m: Strip trailing whitespace.

author	John W. Eaton <jwe@octave.org>
date	Tue, 20 Jan 2015 10:29:54 -0500
parents	d0d0858cfab1
children	4197fc428c7d

rev	line source
18934 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	1 ## Copyright (C) 2014 Massimiliano Fasi
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	2 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	3 ## This file is part of Octave.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	4 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	8 ## your option) any later version.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	9 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	13 ## General Public License for more details.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	14 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	18
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	19 ## -- texinfo --
18955 d0d0858cfab1 doc: Match docstring variable names to function variable names for linear-algebra m-files. Rik <rik@octave.org> parents: 18938 diff changeset	20 ## @deftypefn {Function File} {} isbanded (@var{A}, @var{lower}, @var{upper})
d0d0858cfab1 doc: Match docstring variable names to function variable names for linear-algebra m-files. Rik <rik@octave.org> parents: 18938 diff changeset	21 ## Return true if @var{A} is a matrix with entries confined between
18934 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	22 ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	23 ## above the main diagonal.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	24 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	25 ## @var{lower} and @var{upper} must be non-negative integers.
18938 9addb5ad9426 bandwidth.m: Add new function. Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: 18934 diff changeset	26 ## @seealso{isdiag, istril, istriu, bandwidth}
18934 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	27 ## @end deftypefn
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	28
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	29 ## Author: Massimiliano Fasi
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	30
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	31 function retval = isbanded (A, lower, upper)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	32
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	33 if (nargin != 3)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	34 print_usage ();
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	35 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	36
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	37 if (! isreal (lower) \|\| ! isreal (upper) \|\| lower < 0 \|\| upper < 0)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	38 error ("isbanded: LOWER and UPPER must be non-negative integers");
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	39 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	40
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	41 if (isempty (A))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	42 retval = [];
19631 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 18955 diff changeset	43 else
18934 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	44 retval = (isnumeric (A) \|\| islogical (A)) && ndims (A) == 2;
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	45 if (retval)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	46 [i, j] = find (A);
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	47 pupp = j >= i;
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	48 retval = all (j(pupp) - i(pupp) <= upper);
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	49 if (retval)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	50 plow = i >= j;
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	51 retval = all (i(plow) - j(plow) <= lower);
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	52 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	53 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	54 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	55
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	56 endfunction
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	57
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	58
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	59 %!assert (! isbanded ("string", 0, 0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	60 %!assert (! isbanded (zeros (2,2,2), 0, 0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	61 %!assert (isbanded ([], 0, 0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	62 %!assert (isbanded (1,0,0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	63 %!assert (isbanded (1,10,10))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	64
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	65 %!assert (isbanded ([1, 1],1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	66 %!assert (isbanded ([1; 1],1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	67 %!assert (isbanded (eye(10),0,0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	68 %!assert (isbanded (eye(10),1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	69 %!assert (isbanded (i*eye(10),1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	70 %!assert (isbanded (logical (eye (10)),1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	71
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	72 %! 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];
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	73 %! assert (isbanded (A,1,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	74 %! assert (! isbanded (A,0,1))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	75 %! assert (! isbanded (A,1,0))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	76
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	77 %% Test input validation
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	78 %!error isbanded ()
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	79 %!error isbanded (1)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	80 %!error isbanded (1,2)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	81 %!error isbanded (1,2,3,4)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	82 %!error <LOWER and UPPER must be non-negative> isbanded (1, -1, 1)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	83 %!error <LOWER and UPPER must be non-negative> isbanded (1, 1, -1)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	84 %!error <LOWER and UPPER must be non-negative> isbanded (1, {1}, 1)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	85 %!error <LOWER and UPPER must be non-negative> isbanded (1, 1, {1})
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	86

Mercurial > octave-nkf

annotate scripts/linear-algebra/isbanded.m @ 19631:db92e7e28e1f