annotate src/qr.cc @ 572:94fd73d1a0bc

[project @ 1994-07-28 05:35:47 by jwe]
author jwe
date Thu, 28 Jul 1994 05:35:47 +0000
parents 20fbad23ae51
children 8e4e7e5f307e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
d68036bcad4c [project @ 1993-08-08 03:53:43 by jwe]
jwe
parents: 1
diff changeset
1 // f-qr.cc -*- C++ -*-
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
3
453
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
4 Copyright (C) 1993, 1994 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
11 later version.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, write to the Free
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
23
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 162
diff changeset
24 #ifdef HAVE_CONFIG_H
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 162
diff changeset
25 #include "config.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
26 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
27
453
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
28 #include "dbleQR.h"
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
29 #include "CmplxQR.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
30
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
31 #include "dbleQRP.h"
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
32 #include "CmplxQRP.h"
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
33
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
34 #include "tree-const.h"
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
35 #include "user-prefs.h"
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
36 #include "gripes.h"
544
20fbad23ae51 [project @ 1994-07-22 05:04:44 by jwe]
jwe
parents: 539
diff changeset
37 #include "help.h"
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
38 #include "defun-dld.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
39
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
40 DEFUN_DLD ("qr", Fqr, Sqr, 2, 2,
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
41 "[Q, R] = qr (X): form Q unitary and R upper triangular such\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
42 that Q * R = X\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
43 \n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
44 [Q, R] = qr (X, 0): form the economy decomposition such that if X is\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
45 if X is m by n then only the first n columns of Q\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
46 are computed.\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
47 \n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
48 [Q, R, P] = qr (X): form QRP factorization of X where\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
49 P is a permutation matrix such that\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
50 A * P = Q * R\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
51 \n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
52 [Q, R, P] = qr (X, 0): form the economy decomposition with \n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
53 permutation vector P such that Q * R = X (:, P)\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
54 \n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
55 qr (X) alone returns the output of the LAPACK routine dgeqrf, such\n\
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
56 that R = triu (qr (X))")
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
57 {
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
58 Octave_object retval;
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
59
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
60 int nargin = args.length ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
61
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
62 if (nargin != 2 && nargin != 3 || nargout > 3)
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
63 {
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
64 print_usage ("qr");
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
65 return retval;
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
66 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
67
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
68 tree_constant tmp = args(1).make_numeric ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
69
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
70 if (tmp.rows () == 0 || tmp.columns () == 0)
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
71 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
72 int flag = user_pref.propagate_empty_matrices;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
73 if (flag != 0)
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
74 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
75 if (flag < 0)
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
76 gripe_empty_arg ("qr", 0);
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
77 Matrix m;
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
78 retval(2) = m;
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
79 retval(1) = m;
516
309fc59f66ee [project @ 1994-07-13 02:31:31 by jwe]
jwe
parents: 506
diff changeset
80 retval(0) = m;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
81 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
82 else
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
83 gripe_empty_arg ("qr", 1);
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
84
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
85 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
86 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
87
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
88 QR::type type = nargout == 1 ? QR::raw
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
89 : (nargin == 3 ? QR::economy : QR::std);
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
90
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
91 switch (tmp.const_type ())
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
92 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
93 case tree_constant_rep::matrix_constant:
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
94 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
95 Matrix m = tmp.matrix_value ();
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
96 if (nargout < 3)
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
97 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
98 QR fact (m, type);
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
99 retval(1) = fact.R ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
100 retval(0) = fact.Q ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
101 }
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
102 else
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
103 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
104 QRP fact (m, type);
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
105 retval(2) = fact.P ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
106 retval(1) = fact.R ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
107 retval(0) = fact.Q ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
108 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
109 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
110 break;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
111 case tree_constant_rep::complex_matrix_constant:
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
112 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
113 ComplexMatrix m = tmp.complex_matrix_value ();
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
114 if (nargout < 3)
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
115 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
116 ComplexQR fact (m, type);
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
117 retval(1) = fact.R ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
118 retval(0) = fact.Q ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
119 }
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
120 else
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
121 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
122 ComplexQRP fact (m, type);
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
123 retval(2) = fact.P ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
124 retval(1) = fact.R ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
125 retval(0) = fact.Q ();
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
126 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
127 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
128 break;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
129 case tree_constant_rep::scalar_constant:
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
130 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
131 double d = tmp.double_value ();
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
132 if (nargout == 1)
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
133 retval(0) = d;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
134 else
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
135 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
136 retval(2) = 1.0;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
137 retval(1) = d;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
138 retval(0) = 1.0;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
139 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
140 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
141 break;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
142 case tree_constant_rep::complex_scalar_constant:
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
143 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
144 Complex c = tmp.complex_value ();
539
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
145 if (nargout == 1)
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
146 retval(0) = c;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
147 else
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
148 {
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
149 retval(2) = 1.0;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
150 retval(1) = c;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
151 retval(0) = 1.0;
5ec10a984241 [project @ 1994-07-21 22:40:04 by jwe]
jwe
parents: 519
diff changeset
152 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
153 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
154 break;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
155 default:
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
156 break;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
157 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
158 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
159 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
160
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
161 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
162 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
163 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
164 ;;; page-delimiter: "^/\\*" ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
165 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
166 */