annotate scripts/general/isdefinite.m @ 4855:d62c421f448b

[project @ 2004-04-07 02:41:22 by jwe]
author jwe
date Wed, 07 Apr 2004 02:41:22 +0000
parents 02d2fcf835fc
children c08cb1098afc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2003 Gabriele Pannocchia
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
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
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
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
18 ## 02111-1307, USA.
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
19
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
4855
d62c421f448b [project @ 2004-04-07 02:41:22 by jwe]
jwe
parents: 4610
diff changeset
21 ## @deftypefn {Function File} {} isdefinite (@var{x}, @var{tol})
4610
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
22 ## 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
23 ## 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
24 ## positive semidefinite. Otherwise, return -1. If @var{tol}
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
25 ## is omitted, use a tolerance equal to 100 times the machine precision.
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 ## @seealso{issymmetric}
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
28
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
29 ## Author: Gabriele Pannocchia <g.pannocchia@ing.unipi.it>
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
30 ## Created: November 2003
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
31 ## Adapted-By: jwe
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
32
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
33 function retval = isdefinite (x, tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
34
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
35 if (nargin == 1 || nargin == 2)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
36 if (nargin == 1)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
37 tol = 100*eps;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
38 endif
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
39 sym = issymmetric (x, tol);
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
40 if (sym > 0)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
41 ## Matrix is symmetric, check eigenvalues.
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
42 mineig = min (eig (x));
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
43 if (mineig > tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
44 retval = 1;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
45 elseif (mineig > -tol)
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
46 retval = 0;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
47 else
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
48 retval = -1;
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
49 end
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 error ("isdefinite: matrix x must be symmetric");
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
52 endif
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 usage ("isdefinite (x,tol)");
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
02d2fcf835fc [project @ 2003-11-14 17:08:59 by jwe]
jwe
parents:
diff changeset
57 endfunction