annotate scripts/linear-algebra/orth.m @ 10549:95c3e38098bf

Untabify .m scripts
author Rik <code@nomad.inbox5.com>
date Fri, 23 Apr 2010 11:28:50 -0700
parents eb63fbe60fab
children a8ce6bdecce5
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, 1998, 1999, 2000, 2005, 2006,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7795
diff changeset
2 ## 2007, 2008 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: 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: 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: 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/>.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 1022
diff changeset
19
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
20 ## -*- texinfo -*-
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
21 ## @deftypefn {Function File} {} orth (@var{a}, @var{tol})
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
22 ## Return an orthonormal basis of the range 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 range space is taken as the number of singular
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
25 ## values of @var{a} greater than @var{tol}. If the argument @var{tol} is
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
26 ## 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: 3141
diff changeset
28 ## @example
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
29 ## max (size (@var{a})) * max (svd (@var{a})) * eps
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
diff changeset
30 ## @end example
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3141
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 = orth (A, tol)
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
38
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
39 if (nargin == 1 || nargin == 2)
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
40
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
41 [U, S, V] = svd (A);
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
42
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
43 [rows, cols] = size (A);
1065
5eeb61cac52e [project @ 1995-01-25 14:04:13 by jwe]
jwe
parents: 1026
diff changeset
44
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
45 [S_nr, S_nc] = size (S);
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
46
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
47 if (S_nr == 1 || S_nc == 1)
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
48 s = S(1);
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
49 else
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
50 s = diag (S);
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
51 endif
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
52
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
53 if (nargin == 1)
7795
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
54 if (isa (A, "single"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
55 tol = max (size (A)) * s (1) * eps ("single");
7795
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
56 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
57 tol = max (size (A)) * s (1) * eps;
7795
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
58 endif
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
59 endif
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
60
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
61 rank = sum (s > tol);
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
62
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
63 if (rank > 0)
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
64 retval = -U (:, 1:rank);
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
65 else
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
66 retval = zeros (rows, 0);
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
67 endif
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
68
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
69 else
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
70
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
71 print_usage ();
3141
292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe]
jwe
parents: 2847
diff changeset
72
557
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
73 endif
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
74
e6ae50d8d4eb [project @ 1994-07-25 20:23:22 by jwe]
jwe
parents:
diff changeset
75 endfunction