Mercurial > octave
diff scripts/linear-algebra/ishermitian.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 |
line wrap: on
line diff
--- a/scripts/linear-algebra/ishermitian.m Thu Feb 15 10:09:45 2024 -0800 +++ b/scripts/linear-algebra/ishermitian.m Thu Feb 15 21:42:27 2024 -0500 @@ -28,8 +28,8 @@ ## @deftypefnx {} {@var{tf} =} ishermitian (@var{A}, @var{tol}) ## @deftypefnx {} {@var{tf} =} ishermitian (@var{A}, @qcode{"skew"}) ## @deftypefnx {} {@var{tf} =} ishermitian (@var{A}, @qcode{"skew"}, @var{tol}) -## Return true if @var{A} is a Hermitian or skew-Hermitian matrix within the -## tolerance specified by @var{tol}. +## Return true if @var{A} is a Hermitian or skew-Hermitian numeric matrix +## within the tolerance specified by @var{tol}. ## ## The default tolerance is zero (uses faster code). ##