octave: scripts/linear-algebra/isdiag.m annotate

annotate scripts/linear-algebra/isdiag.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	42dc5cf93f83
children	83f9f8bda883

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29771 diff changeset	3 ## Copyright (C) 2014-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	7 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	8 ## This file is part of Octave.
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	14 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	19 ##
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	25
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20661 diff changeset	27 ## @deftypefn {} {} isdiag (@var{A})
18921 d0d0858cfab1 doc: Match docstring variable names to function variable names for linear-algebra m-files. Rik <rik@octave.org> parents: 18904 diff changeset	28 ## Return true if @var{A} is a diagonal matrix.
18904 9addb5ad9426 bandwidth.m: Add new function. Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: 18900 diff changeset	29 ## @seealso{isbanded, istril, istriu, diag, bandwidth}
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	30 ## @end deftypefn
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	31
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	32 function retval = isdiag (A)
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	33
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 28886 diff changeset	34 if (nargin < 1)
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	35 print_usage ();
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	36 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	37
25619 b3f6443f6b20 isdiag.m: Add fast path for detecting complex diagonal matrices. Rik <rik@octave.org> parents: 25054 diff changeset	38 if (strfind (typeinfo (A), "diagonal matrix"))
20661 014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	39 retval = true;
014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	40 elseif ((isnumeric (A) \|\| islogical (A)) && ndims (A) == 2)
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	41 [i, j] = find (A);
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	42 retval = all (i == j);
20661 014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	43 else
014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	44 retval = false;
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	45 endif
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	46
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	47 endfunction
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	48
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	49
20661 014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	50 %!assert (isdiag ("string"), false)
014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	51 %!assert (isdiag (zeros (2,2,2)), false)
29770 4778b21b1386 expm.m, logm.m: Use function "isdiag" to detect if input is a diagonal matrix (bug #60738). Markus Mützel <markus.muetzel@gmx.de> parents: 29358 diff changeset	52 %!assert (isdiag (zeros (2)))
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	53 %!assert (isdiag ([]))
49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	54 %!assert (isdiag (1))
20661 014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	55 %!assert (isdiag ([1, 1]), false)
014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	56 %!assert (isdiag ([1; 1]), false)
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	57 %!assert (isdiag (eye (10)))
25619 b3f6443f6b20 isdiag.m: Add fast path for detecting complex diagonal matrices. Rik <rik@octave.org> parents: 25054 diff changeset	58 %!assert (isdiag (single (eye (10))))
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	59 %!assert (isdiag (logical (eye (10))))
25619 b3f6443f6b20 isdiag.m: Add fast path for detecting complex diagonal matrices. Rik <rik@octave.org> parents: 25054 diff changeset	60 %!assert (isdiag (speye (1e2)))
20661 014003273737 isdiag.m: Add shortcut code for inputs which are diagonal matrices already. Rik <rik@octave.org> parents: 19833 diff changeset	61 %!assert (isdiag (diag (1:10)))
18900 49961d67e4b9 Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688). Massimiliano Fasi <massimiliano.fasi@gmail.com> parents: diff changeset	62
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	63 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27978 diff changeset	64 %!error <Invalid call> isdiag ()

Mercurial > octave

annotate scripts/linear-algebra/isdiag.m @ 30564:796f54d4ddbf stable