annotate scripts/linear-algebra/isdefinite.m @ 9869:ecd750d1eabd

move issymmetric & isdefinite to linear-algebra, create ishermitian
author Jaroslav Hajek <highegg@gmail.com>
date Tue, 24 Nov 2009 15:02:04 +0100
parents scripts/general/isdefinite.m@eb63fbe60fab
children 5b733adba096
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7795
diff changeset
1 ## Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Gabriele Pannocchia
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
2 ##
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
4 ##
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
9 ##
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
14 ##
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
18
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
4855
d62c421f448b [project @ 2004-04-07 02:41:22 by jwe]
jwe
parents: 4610
diff changeset
20 ## @deftypefn {Function File} {} isdefinite (@var{x}, @var{tol})
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
21 ## Return 1 if @var{x} is symmetric positive definite within the
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
22 ## tolerance specified by @var{tol} or 0 if @var{x} is symmetric
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
23 ## positive semidefinite. Otherwise, return -1. If @var{tol}
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
24 ## is omitted, use a tolerance equal to 100 times the machine precision.
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
25 ## @seealso{issymmetric}
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
26 ## @end deftypefn
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
27
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
28 ## Author: Gabriele Pannocchia <g.pannocchia@ing.unipi.it>
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
29 ## Created: November 2003
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
30 ## Adapted-By: jwe
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
31
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
32 function retval = isdefinite (x, tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
33
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
34 if (nargin == 1 || nargin == 2)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
35 if (nargin == 1)
7795
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7151
diff changeset
36 if (isa (x, "single"))
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7151
diff changeset
37 tol = 100 * eps("single");
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7151
diff changeset
38 else
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7151
diff changeset
39 tol = 100*eps;
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7151
diff changeset
40 endif
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
41 endif
9869
ecd750d1eabd move issymmetric & isdefinite to linear-algebra, create ishermitian
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
42 sym = ishermitian (x);
ecd750d1eabd move issymmetric & isdefinite to linear-algebra, create ishermitian
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
43 if (sym)
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
44 ## Matrix is symmetric, check eigenvalues.
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
45 mineig = min (eig (x));
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
46 if (mineig > tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
47 retval = 1;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
48 elseif (mineig > -tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
49 retval = 0;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
50 else
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
51 retval = -1;
7151
aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe]
jwe
parents: 7017
diff changeset
52 endif
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
53 else
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
54 error ("isdefinite: matrix x must be symmetric");
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
55 endif
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
56 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
57 print_usage ();
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
58 endif
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
59
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
60 endfunction