annotate liboctave/fEIG.h @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents fd0a3ac60b0e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 /*
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
2
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
3 Copyright (C) 1994-2012 John W. Eaton
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
4
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 This file is part of Octave.
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
6
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 option) any later version.
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
11
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 for more details.
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
16
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
20
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 */
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
22
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 #if !defined (octave_float_EIG_h)
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 #define octave_float_EIG_h 1
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
25
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
26 #include <iosfwd>
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
27
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 #include "fMatrix.h"
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 #include "fCMatrix.h"
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 #include "fCColVector.h"
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
31
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 class
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 OCTAVE_API
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 FloatEIG
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 {
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 friend class FloatMatrix;
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 friend class FloatComplexMatrix;
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
38
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 public:
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
40
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 FloatEIG (void)
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 : lambda (), v () { }
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
43
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 FloatEIG (const FloatMatrix& a, bool calc_eigenvectors = true)
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
45 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
46 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
47 init (a, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
48 }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
49
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
50 FloatEIG (const FloatMatrix& a, octave_idx_type& info,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
51 bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
52 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
53 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
54 info = init (a, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
55 }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
56
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
57 FloatEIG (const FloatMatrix& a, const FloatMatrix& b,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
58 bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
59 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
60 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
61 init (a, b, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
62 }
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
63
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
64 FloatEIG (const FloatMatrix& a, const FloatMatrix& b, octave_idx_type& info,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
65 bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
66 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
67 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
68 info = init (a, b, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
69 }
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
70
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
71 FloatEIG (const FloatComplexMatrix& a, bool calc_eigenvectors = true)
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
72 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
73 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
74 init (a, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
75 }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
76
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
77 FloatEIG (const FloatComplexMatrix& a, octave_idx_type& info,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
78 bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
79 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
80 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
81 info = init (a, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
82 }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
83
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
84 FloatEIG (const FloatComplexMatrix& a, const FloatComplexMatrix& b,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
85 bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
86 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
87 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
88 init (a, b, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
89 }
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
90
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
91 FloatEIG (const FloatComplexMatrix& a, const FloatComplexMatrix& b,
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
92 octave_idx_type& info, bool calc_eigenvectors = true)
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
93 : lambda (), v ()
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
94 {
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
95 info = init (a, b, calc_eigenvectors);
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
96 }
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
97
11498
367bfee35ba0 data member initialization fixes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
98 FloatEIG (const FloatEIG& a) : lambda (a.lambda), v (a.v) { }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
99
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
100 FloatEIG& operator = (const FloatEIG& a)
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
101 {
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 if (this != &a)
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
103 {
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
104 lambda = a.lambda;
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
105 v = a.v;
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
106 }
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 return *this;
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 }
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
109
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 ~FloatEIG (void) { }
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
111
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
112 FloatComplexColumnVector eigenvalues (void) const { return lambda; }
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
113
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
114 FloatComplexMatrix eigenvectors (void) const { return v; }
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
115
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 friend std::ostream& operator << (std::ostream& os, const FloatEIG& a);
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
117
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
118 private:
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
119
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
120 FloatComplexColumnVector lambda;
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
121 FloatComplexMatrix v;
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
122
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 octave_idx_type init (const FloatMatrix& a, bool calc_eigenvectors);
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
124 octave_idx_type init (const FloatMatrix& a, const FloatMatrix& b, bool calc_eigenvectors);
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
125 octave_idx_type init (const FloatComplexMatrix& a, bool calc_eigenvectors);
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
126 octave_idx_type init (const FloatComplexMatrix& a, const FloatComplexMatrix& b, bool calc_eigenvectors);
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
127
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
128 octave_idx_type symmetric_init (const FloatMatrix& a, bool calc_eigenvectors);
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
129 octave_idx_type symmetric_init (const FloatMatrix& a, const FloatMatrix& b, bool calc_eigenvectors);
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
130 octave_idx_type hermitian_init (const FloatComplexMatrix& a, bool calc_eigenvectors);
8339
18c4ded8612a Add generalized eigenvalue functions
Jarkko Kaleva <d3roga@gmail.com>
parents: 7789
diff changeset
131 octave_idx_type hermitian_init (const FloatComplexMatrix& a, const FloatComplexMatrix& b, bool calc_eigenvectors);
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
132 };
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
133
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 #endif