Mercurial > octave
diff scripts/linear-algebra/isbanded.m @ 30558:83aeaba707d8
doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
* isplaying.m, isrecording.m, isequal.m, isequaln.m, iscolormap.m,
is_valid_file_id.m, isdir.m, isstr.m, isbanded.m, isdefinite.m, isdiag.m,
ishermitian.m, issymmetric.m, istril.m, istriu.m, isdeployed.m, isfolder.m,
ismac.m, ismethod.m, ispc.m, isunix.m, isaxes.m, isfigure.m, isgraphics.m,
ishandle.m, ishold.m, ispref.m, isprime.m, isletter.m, isstring.m, isstrprop.m,
is_leap_year.m:
Use TF for output variable in documentation for isXXX functions.
Change variable name in code function prototype to match documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 27 Dec 2021 16:07:08 -0800 |
| parents | 7854d5752dd2 |
| children | 83f9f8bda883 |
line wrap: on
line diff
--- a/scripts/linear-algebra/isbanded.m Mon Dec 27 15:51:12 2021 -0800 +++ b/scripts/linear-algebra/isbanded.m Mon Dec 27 16:07:08 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {} isbanded (@var{A}, @var{lower}, @var{upper}) +## @deftypefn {} {@var{tf} =} isbanded (@var{A}, @var{lower}, @var{upper}) ## Return true if @var{A} is a matrix with entries confined between ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals ## above the main diagonal. @@ -33,7 +33,7 @@ ## @seealso{isdiag, istril, istriu, bandwidth} ## @end deftypefn -function retval = isbanded (A, lower, upper) +function tf = isbanded (A, lower, upper) if (nargin != 3) print_usage (); @@ -44,16 +44,16 @@ endif if (isempty (A)) - retval = []; + tf = []; else - retval = (isnumeric (A) || islogical (A)) && ndims (A) == 2; - if (retval) + tf = (isnumeric (A) || islogical (A)) && ndims (A) == 2; + if (tf) [i, j] = find (A); pupp = j >= i; - retval = all (j(pupp) - i(pupp) <= upper); - if (retval) + tf = all (j(pupp) - i(pupp) <= upper); + if (tf) plow = i >= j; - retval = all (i(plow) - j(plow) <= lower); + tf = all (i(plow) - j(plow) <= lower); endif endif endif