annotate scripts/linear-algebra/cond.m @ 3265:a2b3a1413d28

[project @ 1999-09-03 02:53:03 by jwe]
author jwe
date Fri, 03 Sep 1999 02:53:10 +0000
parents ae3bdfd82f91
children f16c2ce14886
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2360
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
18 ## 02111-1307, USA.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3265
a2b3a1413d28 [project @ 1999-09-03 02:53:03 by jwe]
jwe
parents: 3250
diff changeset
20 ## usage: cond (A)
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
21 ##
3265
a2b3a1413d28 [project @ 1999-09-03 02:53:03 by jwe]
jwe
parents: 3250
diff changeset
22 ## Return the condition number of A, computed using the singular values
a2b3a1413d28 [project @ 1999-09-03 02:53:03 by jwe]
jwe
parents: 3250
diff changeset
23 ## of A. If the maximum and minimum singular values of A are both zero,
a2b3a1413d28 [project @ 1999-09-03 02:53:03 by jwe]
jwe
parents: 3250
diff changeset
24 ## cond returns Inf rather than NaN.
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
25 ##
3265
a2b3a1413d28 [project @ 1999-09-03 02:53:03 by jwe]
jwe
parents: 3250
diff changeset
26 ## See also: norm, svd, rank
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)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
33 [nr, nc] = size (a);
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
34 if (nr == 0 && nc == 0)
2360
8fc0fa7ae9ca [project @ 1996-10-10 22:36:46 by jwe]
jwe
parents: 2314
diff changeset
35 if (! propagate_empty_matrices)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
36 error ("cond: empty matrix is invalid as argument");
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
37 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
38 if (strcmp (propagate_empty_matrices, "warn"))
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 245
diff changeset
39 warning ("cond: argument is empty matrix\n");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
40 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
41 retval = 0.0;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
42 endif
3250
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
43 if (any (any (isinf (a) | isnan (a))))
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
44 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
45 else
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
46 sigma = svd (a);
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
47 sigma_1 = sigma(1);
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
48 sigma_n = sigma(length (sigma));
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
49 if (sigma_1 == 0 || sigma_n == 0)
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
50 retval = Inf;
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
51 else
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
52 retval = sigma_1 / sigma_n;
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
53 endif
ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe]
jwe
parents: 2847
diff changeset
54 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
55 else
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 245
diff changeset
56 usage ("cond (a)");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
57 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
58
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
59 endfunction