Mercurial > octave-dspies
annotate scripts/linear-algebra/istriu.m @ 18900:49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
* NEWS: Announce new functions.
* scripts/linear-algebra/module.mk: Add new functions to build system.
* scripts/linear-algebra/isdiag.m: New function.
* scripts/linear-algebra/isbanded.m: New function.
* scripts/linear-algebra/istril.m: New function.
* scripts/linear-algebra/istriu.m: New function.
* numbers.txi: Add new functions to manual.
author | Massimiliano Fasi <massimiliano.fasi@gmail.com> |
---|---|
date | Sat, 05 Jul 2014 10:09:56 +0200 |
parents | |
children | 9addb5ad9426 |
rev | line source |
---|---|
18900
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
1 ## Copyright (C) 2014 Massimiliano Fasi |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
2 ## |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
3 ## 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
|
4 ## |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
9 ## |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
10 ## 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
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
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 ## 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
|
16 ## along with Octave; see the file COPYING. If not, see |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
18 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
20 ## @deftypefn {Function File} {} istriu (@var{x}) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
21 ## Return true if @var{x} is an upper triangular matrix. |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
22 ## |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
23 ## An upper triangular matrix has nonzero entries only on the main diagonal |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
24 ## and above. |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
25 ## @seealso{isdiag, isbanded, istril, triu} |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
26 ## @end deftypefn |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
27 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
28 ## Author: Massimiliano Fasi |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
29 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
30 function retval = istriu (A) |
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 if (nargin != 1) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
33 print_usage (); |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
34 endif |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
35 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
36 retval = (isnumeric (A) || islogical (A)) && ndims (A) == 2; |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
37 if (retval) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
38 [i, j] = find (A); |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
39 retval = all (i <= j); |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
40 endif |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
41 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
42 endfunction |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
43 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
44 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
45 %!assert (! istriu ("string")) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
46 %!assert (istriu ([])) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
47 %!assert (! istriu (zeros (2,2,2))) |
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 %!assert (istriu (1)) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
50 %!assert (istriu ([1, 1])) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
51 %!assert (! istriu ([1; 1])) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
52 %!assert (istriu (eye (10))) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
53 %!assert (istriu (speye (100))) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
54 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
55 %!assert (istriu (triu (randn (10)))) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
56 %!assert (! istriu (randn (10))) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
57 |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
58 %% Test input validation |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
59 %!error istriu () |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
60 %!error istriu (1,2) |
49961d67e4b9
Add new matrix functions (isdiag, isbanded, istril, istriu) (bug #42688).
Massimiliano Fasi <massimiliano.fasi@gmail.com>
parents:
diff
changeset
|
61 |