Mercurial > octave
annotate libinterp/corefcn/hess.cc @ 17744:d63878346099
maint: Update copyright notices for release.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 23 Oct 2013 22:09:27 -0400 |
parents | 53eaa83e4181 |
children | 175b392e91fe |
rev | line source |
---|---|
2928 | 1 /* |
2 | |
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
16920
diff
changeset
|
3 Copyright (C) 1996-2013 John W. Eaton |
2928 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
2928 | 11 |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
2928 | 20 |
21 */ | |
22 | |
23 #ifdef HAVE_CONFIG_H | |
24 #include <config.h> | |
25 #endif | |
26 | |
27 #include "CmplxHESS.h" | |
28 #include "dbleHESS.h" | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
29 #include "fCmplxHESS.h" |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
30 #include "floatHESS.h" |
2928 | 31 |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14501
diff
changeset
|
32 #include "defun.h" |
2928 | 33 #include "error.h" |
34 #include "gripes.h" | |
35 #include "oct-obj.h" | |
36 #include "utils.h" | |
37 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14501
diff
changeset
|
38 DEFUN (hess, args, nargout, |
3548 | 39 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14501
diff
changeset
|
40 @deftypefn {Built-in Function} {@var{H} =} hess (@var{A})\n\ |
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14501
diff
changeset
|
41 @deftypefnx {Built-in Function} {[@var{P}, @var{H}] =} hess (@var{A})\n\ |
3372 | 42 @cindex Hessenberg decomposition\n\ |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
43 Compute the Hessenberg decomposition of the matrix @var{A}.\n\ |
3372 | 44 \n\ |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
45 The Hessenberg decomposition is\n\ |
3372 | 46 @tex\n\ |
47 $$\n\ | |
48 A = PHP^T\n\ | |
49 $$\n\ | |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
50 where $P$ is a square unitary matrix ($P^TP = I$), and $H$\n\ |
3372 | 51 is upper Hessenberg ($H_{i,j} = 0, \\forall i \\ge j+1$).\n\ |
52 @end tex\n\ | |
8517
81d6ab3ac93c
Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents:
7814
diff
changeset
|
53 @ifnottex\n\ |
12584
7ef7e20057fa
Improve documentation strings in Linear Algebra chapter.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
54 @code{@var{P} * @var{H} * @var{P}' = @var{A}} where @var{P} is a square\n\ |
7ef7e20057fa
Improve documentation strings in Linear Algebra chapter.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
55 unitary matrix (@code{@var{P}' * @var{P} = I}, using complex-conjugate\n\ |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
56 transposition) and @var{H} is upper Hessenberg\n\ |
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 (@code{@var{H}(i, j) = 0 forall i >= j+1)}.\n\ |
8517
81d6ab3ac93c
Allow documentation tobe built for other formats than tex and info
sh@sh-laptop
parents:
7814
diff
changeset
|
58 @end ifnottex\n\ |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
59 \n\ |
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
60 The Hessenberg decomposition is usually used as the first step in an\n\ |
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
61 eigenvalue computation, but has other applications as well (see Golub,\n\ |
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
62 Nash, and Van Loan, IEEE Transactions on Automatic Control, 1979).\n\ |
16920
53eaa83e4181
doc: Add seealso links between various factorization forms.
Rik <rik@octave.org>
parents:
15195
diff
changeset
|
63 @seealso{eig, chol, lu, qr, qz, schur, svd}\n\ |
3372 | 64 @end deftypefn") |
2928 | 65 { |
66 octave_value_list retval; | |
67 | |
68 int nargin = args.length (); | |
69 | |
70 if (nargin != 1 || nargout > 2) | |
71 { | |
5823 | 72 print_usage (); |
2928 | 73 return retval; |
74 } | |
75 | |
76 octave_value arg = args(0); | |
77 | |
5275 | 78 octave_idx_type nr = arg.rows (); |
79 octave_idx_type nc = arg.columns (); | |
2928 | 80 |
81 int arg_is_empty = empty_arg ("hess", nr, nc); | |
82 | |
83 if (arg_is_empty < 0) | |
84 return retval; | |
85 else if (arg_is_empty > 0) | |
86 return octave_value_list (2, Matrix ()); | |
87 | |
88 if (nr != nc) | |
89 { | |
90 gripe_square_matrix_required ("hess"); | |
91 return retval; | |
92 } | |
93 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
94 if (arg.is_single_type ()) |
2928 | 95 { |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
96 if (arg.is_real_type ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
97 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
98 FloatMatrix tmp = arg.float_matrix_value (); |
2928 | 99 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
100 if (! error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
101 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
102 FloatHESS result (tmp); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
103 |
10539
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
104 if (nargout <= 1) |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
105 retval(0) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
106 else |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
107 { |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
108 retval(1) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
109 retval(0) = result.unitary_hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
110 } |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
111 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
112 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
113 else if (arg.is_complex_type ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
114 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
115 FloatComplexMatrix ctmp = arg.float_complex_matrix_value (); |
2928 | 116 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
117 if (! error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
118 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
119 FloatComplexHESS result (ctmp); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
120 |
10539
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
121 if (nargout <= 1) |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
122 retval(0) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
123 else |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
124 { |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
125 retval(1) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
126 retval(0) = result.unitary_hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
127 } |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
128 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
129 } |
2928 | 130 } |
131 else | |
132 { | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
133 if (arg.is_real_type ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
134 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
135 Matrix tmp = arg.matrix_value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
136 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
137 if (! error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
138 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
139 HESS result (tmp); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
140 |
10539
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
141 if (nargout <= 1) |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
142 retval(0) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
143 else |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
144 { |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
145 retval(1) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
146 retval(0) = result.unitary_hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
147 } |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
148 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
149 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
150 else if (arg.is_complex_type ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
151 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
152 ComplexMatrix ctmp = arg.complex_matrix_value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
153 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
154 if (! error_state) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
155 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
156 ComplexHESS result (ctmp); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
157 |
10539
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
158 if (nargout <= 1) |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
159 retval(0) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
160 else |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
161 { |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
162 retval(1) = result.hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
163 retval(0) = result.unitary_hess_matrix (); |
8db807a0eb78
Return correct Hessenberg matrix when called with 0 or 1 output arguments
Rik <code@nomad.inbox5.com>
parents:
10155
diff
changeset
|
164 } |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
165 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
166 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
167 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
168 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
169 gripe_wrong_type_arg ("hess", arg); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9758
diff
changeset
|
170 } |
2928 | 171 } |
172 | |
173 return retval; | |
174 } | |
175 | |
176 /* | |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
177 %!test |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
178 %! a = [1, 2, 3; 5, 4, 6; 8, 7, 9]; |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
179 %! [p, h] = hess (a); |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
180 %! assert (p * h * p', a, sqrt (eps)); |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
181 |
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
182 %!test |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
183 %! a = single ([1, 2, 3; 5, 4, 6; 8, 7, 9]); |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
184 %! [p, h] = hess (a); |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
185 %! assert (p * h * p', a, sqrt (eps ("single"))); |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
186 |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
187 %!error hess () |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
188 %!error hess ([1, 2; 3, 4], 2) |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
189 %!error <argument must be a square matrix> hess ([1, 2; 3, 4; 5, 6]) |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
190 */ |