Mercurial > octave

comparison scripts/linear-algebra/isbanded.m @ 33029:0b8f3470d1fb stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Clarify object types for isX functions (bug #48088) * libinterp/corefcn/data.cc (isscalar, isvector, isrow, iscolumn, ismatrix, issquare): Change docstring to indicate the functions apply to arrays of any type. * libinterp/octave-value/ov-null-mat.cc (isnull): Replace matrix with array in docstring. * scripts/linear-algebra/isbanded.m, isdefinite.m, ishermitian.m, issymmetric.m, istril, istriu: Note in docstrings that functions return true for numeric matrices. * scripts/linear-algebra/isdiag.m: Note in docstring that function returns true for numeric matrices. Define meaning of diagonal.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Thu, 15 Feb 2024 21:42:27 -0500
parents 2e484f9f1f18
children
comparison
equal deleted inserted replaced
33025:9cb993582499 33029:0b8f3470d1fb
23 ## 23 ##
24 ######################################################################## 24 ########################################################################
25 25
26 ## -*- texinfo -*- 26 ## -*- texinfo -*-
27 ## @deftypefn {} {@var{tf} =} isbanded (@var{A}, @var{lower}, @var{upper}) 27 ## @deftypefn {} {@var{tf} =} isbanded (@var{A}, @var{lower}, @var{upper})
28 ## Return true if @var{A} is a matrix with entries confined between 28 ## Return true if @var{A} is a numeric matrix with entries confined between
29 ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals 29 ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals
30 ## above the main diagonal. 30 ## above the main diagonal.
31 ## 31 ##
32 ## @var{lower} and @var{upper} must be non-negative integers. 32 ## @var{lower} and @var{upper} must be non-negative integers.
33 ## @seealso{isdiag, istril, istriu, bandwidth} 33 ## @seealso{isdiag, istril, istriu, bandwidth}