annotate scripts/linear-algebra/cond.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 83a8781b529d 196a759fc7e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2003, 2004,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2005, 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## 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
8 ## 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
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
20 ## -*- texinfo -*-
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
21 ## @deftypefn {Function File} {} cond (@var{a})
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
22 ## Compute the (two-norm) condition number of a matrix. @code{cond (a)} is
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
23 ## defined as @code{norm (a) * norm (inv (a))}, and is computed via a
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
24 ## singular value decomposition.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
25 ## @seealso{norm, svd, rank}
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3265
diff changeset
26 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
27
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
28 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
29
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
30 function retval = cond (a)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
31
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
32 if (nargin == 1)
4891
aa7573ddf60f [project @ 2004-05-06 20:44:15 by jwe]
jwe
parents: 4890
diff changeset
33 if (ndims (a) > 2)
4890
e7da90a1cc11 [project @ 2004-05-06 20:36:29 by jwe]
jwe
parents: 4478
diff changeset
34 error ("cond: Only valid on 2-D objects")
e7da90a1cc11 [project @ 2004-05-06 20:36:29 by jwe]
jwe
parents: 4478
diff changeset
35 endif
e7da90a1cc11 [project @ 2004-05-06 20:36:29 by jwe]
jwe
parents: 4478
diff changeset
36
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
37 [nr, nc] = size (a);
4478
7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe]
jwe
parents: 3426
diff changeset
38 if (nr == 0 || nc == 0)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
39 retval = 0.0;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
40 endif
3250
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
41 if (any (any (isinf (a) | isnan (a))))
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
42 error ("cond: argument must not contain Inf or NaN values");
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
43 else
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
44 sigma = svd (a);
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
45 sigma_1 = sigma(1);
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
46 sigma_n = sigma(length (sigma));
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
47 if (sigma_1 == 0 || sigma_n == 0)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
48 retval = Inf;
3250
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
49 else
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
50 retval = sigma_1 / sigma_n;
3250
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
51 endif
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
52 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
53 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
54 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
55 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
56
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
57 endfunction