annotate scripts/linear-algebra/null.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 df9519e9990c
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) 1994, 1995, 1996, 1997, 1999, 2000, 2003, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 2312
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: 6431
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: 6431
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 2312
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 2312
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6431
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: 6431
diff changeset
18 ## <http://www.gnu.org/licenses/>.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
19
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} null (@var{a}, @var{tol})
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
22 ## Return an orthonormal basis of the null space of @var{a}.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3372
diff changeset
23 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
24 ## The dimension of the null space is taken as the number of singular
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
25 ## values of @var{a} not greater than @var{tol}. If the argument @var{tol}
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
26 ## is missing, it is computed as
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3372
diff changeset
27 ##
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
28 ## @example
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
29 ## max (size (@var{a})) * max (svd (@var{a})) * eps
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
30 ## @end example
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 2847
diff changeset
31 ## @end deftypefn
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
32
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
33 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
34 ## Created: 24 December 1993.
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
35 ## Adapted-By: jwe
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
36
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
37 function retval = null (A, tol)
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
38
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
39 if (isempty (A))
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
40 retval = [];
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
41 else
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
42 [U, S, V] = svd (A);
1065
5eeb61cac52e [project @ 1995-01-25 14:04:13 by jwe]
jwe
parents: 1026
diff changeset
43
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
44 [rows, cols] = size (A);
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
45
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
46 [S_nr, S_nc] = size (S);
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
47
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
48 if (S_nr == 1 || S_nc == 1)
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
49 s = S(1);
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
50 else
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
51 s = diag (S);
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
52 endif
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
53
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
54 if (nargin == 1)
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
55 tol = max (size (A)) * s (1) * eps;
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
56 elseif (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
57 print_usage ();
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
58 endif
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
59
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
60 rank = sum (s > tol);
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
61
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
62 if (rank < cols)
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
63 retval = V (:, rank+1:cols);
6431
ff87ad14403f [project @ 2007-03-22 18:20:31 by jwe]
jwe
parents: 6046
diff changeset
64 retval(abs (retval) < eps) = 0;
4371
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
65 else
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
66 retval = zeros (cols, 0);
c14ec945fabb [project @ 2003-03-26 16:05:59 by jwe]
jwe
parents: 3456
diff changeset
67 endif
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
68 endif
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
69
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
70 endfunction