Mercurial > octave
view scripts/linear-algebra/isdiag.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 source
######################################################################## ## ## Copyright (C) 2014-2024 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{tf} =} isdiag (@var{A}) ## Return true if @var{A} is a diagonal numeric matrix which is defined as a ## 2-D array where all elements above and below the main diagonal are zero. ## @seealso{isbanded, istril, istriu, diag, bandwidth} ## @end deftypefn function tf = isdiag (A) if (nargin < 1) print_usage (); endif if (strfind (typeinfo (A), "diagonal matrix")) tf = true; elseif ((isnumeric (A) || islogical (A)) && ndims (A) == 2) [i, j] = find (A); tf = all (i == j); else tf = false; endif endfunction %!assert (isdiag ("string"), false) %!assert (isdiag (zeros (2,2,2)), false) %!assert (isdiag (zeros (2))) %!assert (isdiag ([])) %!assert (isdiag (1)) %!assert (isdiag ([1, 1]), false) %!assert (isdiag ([1; 1]), false) %!assert (isdiag (eye (10))) %!assert (isdiag (single (eye (10)))) %!assert (isdiag (logical (eye (10)))) %!assert (isdiag (speye (1e2))) %!assert (isdiag (diag (1:10))) ## Test input validation %!error <Invalid call> isdiag ()