annotate liboctave/numeric/eigs-base.h @ 22323:bac0d6f07a3e

maint: Update copyright notices for 2016.
author John W. Eaton <jwe@octave.org>
date Wed, 17 Aug 2016 01:05:19 -0400
parents 1473547f50f5
children 4caa7b28d183
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21190
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
22323
bac0d6f07a3e maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
3 Copyright (C) 2005-2016 David Bateman
21190
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 This file is part of Octave.
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 option) any later version.
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 for more details.
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 */
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
21213
f7d1050b9b53 maint: Clean up various usages of #ifdef.
Rik <rik@octave.org>
parents: 21190
diff changeset
23 #if ! defined (octave_eigs_base_h)
21190
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 #define octave_eigs_base_h 1
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21213
diff changeset
26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21213
diff changeset
27
21190
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 #include <iosfwd>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 class ColumnVector;
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 class ComplexColumnVector;
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 class Matrix;
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 class ComplexMatrix;
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 typedef ColumnVector (*EigsFunc) (const ColumnVector& x, int& eigs_error);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 typedef ComplexColumnVector (*EigsComplexFunc) (const ComplexColumnVector& x, int& eigs_error);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 EigsRealSymmetricMatrix (const M& m, const std::string typ,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 octave_idx_type& info, Matrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 ColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 ColumnVector& permB, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 EigsRealSymmetricMatrixShift (const M& m, double sigma,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 octave_idx_type& info, Matrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 ColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 ColumnVector& permB, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 extern OCTAVE_API octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 EigsRealSymmetricFunc (EigsFunc fun, octave_idx_type n,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 const std::string& _typ, double sigma,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 octave_idx_type& info, Matrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 ColumnVector& eig_val, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 bool /* cholB */, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 EigsRealNonSymmetricMatrix (const M& m, const std::string typ,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 octave_idx_type& info, ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 ComplexColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 ColumnVector& permB, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 EigsRealNonSymmetricMatrixShift (const M& m, double sigmar,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 octave_idx_type& info,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83 ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84 ComplexColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
85 ColumnVector& permB, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89 extern OCTAVE_API octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90 EigsRealNonSymmetricFunc (EigsFunc fun, octave_idx_type n,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91 const std::string& _typ, double sigmar,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
93 octave_idx_type& info, ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94 ComplexColumnVector& eig_val, ColumnVector& resid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96 bool /* cholB */, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
98 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
99 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
100 EigsComplexNonSymmetricMatrix (const M& m, const std::string typ,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102 octave_idx_type& info, ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 ComplexColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104 ColumnVector& permB,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105 ComplexColumnVector& cresid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
106 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
109 template <typename M>
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
110 octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
111 EigsComplexNonSymmetricMatrixShift (const M& m, Complex sigma,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
112 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113 octave_idx_type& info,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114 ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115 ComplexColumnVector& eig_val, const M& _b,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116 ColumnVector& permB,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117 ComplexColumnVector& cresid,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
118 std::ostream& os, double tol, bool rvec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
119 bool cholB, int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
120
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
121 extern OCTAVE_API octave_idx_type
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
122 EigsComplexNonSymmetricFunc (EigsComplexFunc fun, octave_idx_type n,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
123 const std::string& _typ, Complex sigma,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
124 octave_idx_type k, octave_idx_type p,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
125 octave_idx_type& info, ComplexMatrix& eig_vec,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
126 ComplexColumnVector& eig_val,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
127 ComplexColumnVector& cresid, std::ostream& os,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
128 double tol, bool rvec, bool /* cholB */,
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
129 int disp, int maxit);
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
130
342764537e5a don't install eigs-base.cc
John W. Eaton <jwe@octave.org>
parents:
diff changeset
131 #endif