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

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} =} istril (@var{A}) 27 ## @deftypefn {} {@var{tf} =} istril (@var{A})
28 ## Return true if @var{A} is a lower triangular matrix. 28 ## Return true if @var{A} is a lower triangular numeric matrix.
29 ## 29 ##
30 ## A lower triangular matrix has nonzero entries only on the main diagonal and 30 ## A lower triangular matrix has nonzero entries only on the main diagonal and
31 ## below. 31 ## below.
32 ## @seealso{istriu, isbanded, isdiag, tril, bandwidth} 32 ## @seealso{istriu, isbanded, isdiag, tril, bandwidth}
33 ## @end deftypefn 33 ## @end deftypefn