Mercurial > hg > octave-lyh
annotate liboctave/dMatrix.h @ 8650:a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
author | Jaroslav Hajek <highegg@gmail.com> |
---|---|
date | Mon, 02 Feb 2009 15:35:32 +0100 |
parents | c187f0e3a7ee |
children | b756ce0002db |
rev | line source |
---|---|
458 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003, |
4 2004, 2005, 2006, 2007 John W. Eaton | |
458 | 5 |
6 This file is part of Octave. | |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
9 under the terms of the GNU General Public License as published by the | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
458 | 12 |
13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
458 | 21 |
22 */ | |
23 | |
24 #if !defined (octave_Matrix_int_h) | |
25 #define octave_Matrix_int_h 1 | |
26 | |
1989 | 27 #include "MArray2.h" |
28 #include "MDiagArray2.h" | |
5785 | 29 #include "MatrixType.h" |
458 | 30 |
31 #include "mx-defs.h" | |
2870 | 32 #include "mx-op-defs.h" |
8335 | 33 #include "DET.h" |
458 | 34 |
3585 | 35 class |
6108 | 36 OCTAVE_API |
3585 | 37 Matrix : public MArray2<double> |
458 | 38 { |
39 public: | |
40 | |
7788 | 41 typedef void (*solve_singularity_handler) (double rcon); |
3480 | 42 |
1214 | 43 Matrix (void) : MArray2<double> () { } |
3585 | 44 |
5275 | 45 Matrix (octave_idx_type r, octave_idx_type c) : MArray2<double> (r, c) { } |
3585 | 46 |
5275 | 47 Matrix (octave_idx_type r, octave_idx_type c, double val) : MArray2<double> (r, c, val) { } |
3585 | 48 |
6979 | 49 Matrix (const dim_vector& dv) : MArray2<double> (dv) { } |
50 | |
51 Matrix (const dim_vector& dv, double val) : MArray2<double> (dv, val) { } | |
52 | |
1214 | 53 Matrix (const Matrix& a) : MArray2<double> (a) { } |
3585 | 54 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7788
diff
changeset
|
55 template <class U> |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7788
diff
changeset
|
56 Matrix (const MArray2<U>& a) : MArray2<double> (a) { } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7788
diff
changeset
|
57 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7788
diff
changeset
|
58 template <class U> |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7788
diff
changeset
|
59 Matrix (const Array2<U>& a) : MArray2<double> (a) { } |
3585 | 60 |
61 explicit Matrix (const RowVector& rv); | |
458 | 62 |
3585 | 63 explicit Matrix (const ColumnVector& cv); |
64 | |
65 explicit Matrix (const DiagMatrix& a); | |
66 | |
8367
445d27d79f4e
support permutation matrix objects
Jaroslav Hajek <highegg@gmail.com>
parents:
8336
diff
changeset
|
67 explicit Matrix (const PermMatrix& a); |
445d27d79f4e
support permutation matrix objects
Jaroslav Hajek <highegg@gmail.com>
parents:
8336
diff
changeset
|
68 |
3585 | 69 explicit Matrix (const boolMatrix& a); |
70 | |
71 explicit Matrix (const charMatrix& a); | |
1574 | 72 |
458 | 73 Matrix& operator = (const Matrix& a) |
74 { | |
1214 | 75 MArray2<double>::operator = (a); |
458 | 76 return *this; |
77 } | |
78 | |
2385 | 79 bool operator == (const Matrix& a) const; |
80 bool operator != (const Matrix& a) const; | |
458 | 81 |
3354 | 82 bool is_symmetric (void) const; |
83 | |
1359 | 84 // destructive insert/delete/reorder operations |
458 | 85 |
5275 | 86 Matrix& insert (const Matrix& a, octave_idx_type r, octave_idx_type c); |
87 Matrix& insert (const RowVector& a, octave_idx_type r, octave_idx_type c); | |
88 Matrix& insert (const ColumnVector& a, octave_idx_type r, octave_idx_type c); | |
89 Matrix& insert (const DiagMatrix& a, octave_idx_type r, octave_idx_type c); | |
458 | 90 |
91 Matrix& fill (double val); | |
5275 | 92 Matrix& fill (double val, octave_idx_type r1, octave_idx_type c1, octave_idx_type r2, octave_idx_type c2); |
458 | 93 |
94 Matrix append (const Matrix& a) const; | |
95 Matrix append (const RowVector& a) const; | |
96 Matrix append (const ColumnVector& a) const; | |
97 Matrix append (const DiagMatrix& a) const; | |
98 | |
99 Matrix stack (const Matrix& a) const; | |
100 Matrix stack (const RowVector& a) const; | |
101 Matrix stack (const ColumnVector& a) const; | |
102 Matrix stack (const DiagMatrix& a) const; | |
103 | |
6108 | 104 friend OCTAVE_API Matrix real (const ComplexMatrix& a); |
105 friend OCTAVE_API Matrix imag (const ComplexMatrix& a); | |
1205 | 106 |
8650
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
8392
diff
changeset
|
107 friend class ComplexMatrix; |
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
8392
diff
changeset
|
108 |
3225 | 109 Matrix transpose (void) const { return MArray2<double>::transpose (); } |
110 | |
1359 | 111 // resize is the destructive equivalent for this one |
458 | 112 |
5275 | 113 Matrix extract (octave_idx_type r1, octave_idx_type c1, octave_idx_type r2, octave_idx_type c2) const; |
458 | 114 |
5275 | 115 Matrix extract_n (octave_idx_type r1, octave_idx_type c1, octave_idx_type nr, octave_idx_type nc) const; |
4316 | 116 |
1359 | 117 // extract row or column i. |
458 | 118 |
5275 | 119 RowVector row (octave_idx_type i) const; |
458 | 120 |
5275 | 121 ColumnVector column (octave_idx_type i) const; |
458 | 122 |
6207 | 123 private: |
7788 | 124 Matrix tinverse (MatrixType &mattype, octave_idx_type& info, double& rcon, |
6207 | 125 int force, int calc_cond) const; |
126 | |
7788 | 127 Matrix finverse (MatrixType &mattype, octave_idx_type& info, double& rcon, |
6207 | 128 int force, int calc_cond) const; |
129 | |
130 public: | |
458 | 131 Matrix inverse (void) const; |
6479 | 132 Matrix inverse (octave_idx_type& info) const; |
7788 | 133 Matrix inverse (octave_idx_type& info, double& rcon, int force = 0, |
6479 | 134 int calc_cond = 1) const; |
135 | |
6207 | 136 Matrix inverse (MatrixType &mattype) const; |
137 Matrix inverse (MatrixType &mattype, octave_idx_type& info) const; | |
7788 | 138 Matrix inverse (MatrixType &mattype, octave_idx_type& info, double& rcon, |
6207 | 139 int force = 0, int calc_cond = 1) const; |
458 | 140 |
4384 | 141 Matrix pseudo_inverse (double tol = 0.0) const; |
740 | 142 |
458 | 143 ComplexMatrix fourier (void) const; |
144 ComplexMatrix ifourier (void) const; | |
145 | |
677 | 146 ComplexMatrix fourier2d (void) const; |
147 ComplexMatrix ifourier2d (void) const; | |
148 | |
458 | 149 DET determinant (void) const; |
5275 | 150 DET determinant (octave_idx_type& info) const; |
7788 | 151 DET determinant (octave_idx_type& info, double& rcon, int calc_cond = 1) const; |
8336
9813c07ca946
make det take advantage of matrix type
Jaroslav Hajek <highegg@gmail.com>
parents:
8335
diff
changeset
|
152 DET determinant (MatrixType &mattype, octave_idx_type& info, |
9813c07ca946
make det take advantage of matrix type
Jaroslav Hajek <highegg@gmail.com>
parents:
8335
diff
changeset
|
153 double& rcon, int calc_cond = 1) const; |
7788 | 154 |
155 double rcond (void) const; | |
156 double rcond (MatrixType &mattype) const; | |
458 | 157 |
5785 | 158 private: |
159 // Upper triangular matrix solvers | |
160 Matrix utsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info, | |
7788 | 161 double& rcon, solve_singularity_handler sing_handler, |
5785 | 162 bool calc_cond = false) const; |
163 | |
164 // Lower triangular matrix solvers | |
165 Matrix ltsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info, | |
7788 | 166 double& rcon, solve_singularity_handler sing_handler, |
5785 | 167 bool calc_cond = false) const; |
168 | |
169 // Full matrix solvers (lu/cholesky) | |
170 Matrix fsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info, | |
7788 | 171 double& rcon, solve_singularity_handler sing_handler, |
5785 | 172 bool calc_cond = false) const; |
173 | |
174 public: | |
175 // Generic interface to solver with no probing of type | |
176 Matrix solve (MatrixType &typ, const Matrix& b) const; | |
177 Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info) const; | |
178 Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info, | |
7788 | 179 double& rcon) const; |
5785 | 180 Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info, |
7788 | 181 double& rcon, solve_singularity_handler sing_handler, |
5785 | 182 bool singular_fallback = true) const; |
183 | |
184 ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b) const; | |
185 ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b, | |
186 octave_idx_type& info) const; | |
187 ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b, | |
7788 | 188 octave_idx_type& info, double& rcon) const; |
5785 | 189 ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b, |
7788 | 190 octave_idx_type& info, double& rcon, |
5785 | 191 solve_singularity_handler sing_handler, |
192 bool singular_fallback = true) const; | |
193 | |
194 ColumnVector solve (MatrixType &typ, const ColumnVector& b) const; | |
195 ColumnVector solve (MatrixType &typ, const ColumnVector& b, | |
196 octave_idx_type& info) const; | |
197 ColumnVector solve (MatrixType &typ, const ColumnVector& b, | |
7788 | 198 octave_idx_type& info, double& rcon) const; |
5785 | 199 ColumnVector solve (MatrixType &typ, const ColumnVector& b, |
7788 | 200 octave_idx_type& info, double& rcon, |
5785 | 201 solve_singularity_handler sing_handler) const; |
202 | |
203 ComplexColumnVector solve (MatrixType &typ, | |
204 const ComplexColumnVector& b) const; | |
205 ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b, | |
206 octave_idx_type& info) const; | |
207 ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b, | |
7788 | 208 octave_idx_type& info, double& rcon) const; |
5785 | 209 ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b, |
7788 | 210 octave_idx_type& info, double& rcon, |
5785 | 211 solve_singularity_handler sing_handler) const; |
212 | |
213 // Generic interface to solver with probing of type | |
458 | 214 Matrix solve (const Matrix& b) const; |
5275 | 215 Matrix solve (const Matrix& b, octave_idx_type& info) const; |
7788 | 216 Matrix solve (const Matrix& b, octave_idx_type& info, double& rcon) const; |
217 Matrix solve (const Matrix& b, octave_idx_type& info, double& rcon, | |
3480 | 218 solve_singularity_handler sing_handler) const; |
458 | 219 |
220 ComplexMatrix solve (const ComplexMatrix& b) const; | |
5275 | 221 ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info) const; |
7788 | 222 ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info, double& rcon) const; |
223 ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info, double& rcon, | |
3480 | 224 solve_singularity_handler sing_handler) const; |
458 | 225 |
226 ColumnVector solve (const ColumnVector& b) const; | |
5275 | 227 ColumnVector solve (const ColumnVector& b, octave_idx_type& info) const; |
7788 | 228 ColumnVector solve (const ColumnVector& b, octave_idx_type& info, double& rcon) const; |
229 ColumnVector solve (const ColumnVector& b, octave_idx_type& info, double& rcon, | |
3480 | 230 solve_singularity_handler sing_handler) const; |
458 | 231 |
232 ComplexColumnVector solve (const ComplexColumnVector& b) const; | |
5275 | 233 ComplexColumnVector solve (const ComplexColumnVector& b, octave_idx_type& info) const; |
234 ComplexColumnVector solve (const ComplexColumnVector& b, octave_idx_type& info, | |
7788 | 235 double& rcon) const; |
5275 | 236 ComplexColumnVector solve (const ComplexColumnVector& b, octave_idx_type& info, |
7788 | 237 double& rcon, |
3480 | 238 solve_singularity_handler sing_handler) const; |
458 | 239 |
5785 | 240 // Singular solvers |
458 | 241 Matrix lssolve (const Matrix& b) const; |
5275 | 242 Matrix lssolve (const Matrix& b, octave_idx_type& info) const; |
7076 | 243 Matrix lssolve (const Matrix& b, octave_idx_type& info, |
244 octave_idx_type& rank) const; | |
245 Matrix lssolve (const Matrix& b, octave_idx_type& info, | |
7788 | 246 octave_idx_type& rank, double& rcon) const; |
458 | 247 |
248 ComplexMatrix lssolve (const ComplexMatrix& b) const; | |
5275 | 249 ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info) const; |
250 ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info, | |
251 octave_idx_type& rank) const; | |
7076 | 252 ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info, |
7788 | 253 octave_idx_type& rank, double &rcon) const; |
458 | 254 |
255 ColumnVector lssolve (const ColumnVector& b) const; | |
5275 | 256 ColumnVector lssolve (const ColumnVector& b, octave_idx_type& info) const; |
7076 | 257 ColumnVector lssolve (const ColumnVector& b, octave_idx_type& info, |
258 octave_idx_type& rank) const; | |
259 ColumnVector lssolve (const ColumnVector& b, octave_idx_type& info, | |
7788 | 260 octave_idx_type& rank, double& rcon) const; |
458 | 261 |
262 ComplexColumnVector lssolve (const ComplexColumnVector& b) const; | |
7076 | 263 ComplexColumnVector lssolve (const ComplexColumnVector& b, |
264 octave_idx_type& info) const; | |
265 ComplexColumnVector lssolve (const ComplexColumnVector& b, | |
266 octave_idx_type& info, | |
5275 | 267 octave_idx_type& rank) const; |
7076 | 268 ComplexColumnVector lssolve (const ComplexColumnVector& b, |
269 octave_idx_type& info, | |
7788 | 270 octave_idx_type& rank, double& rcon) const; |
458 | 271 |
272 Matrix& operator += (const DiagMatrix& a); | |
273 Matrix& operator -= (const DiagMatrix& a); | |
274 | |
1359 | 275 // unary operations |
458 | 276 |
2964 | 277 boolMatrix operator ! (void) const; |
458 | 278 |
1359 | 279 // other operations |
458 | 280 |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
281 typedef double (*dmapper) (double); |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
282 typedef Complex (*cmapper) (const Complex&); |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
283 typedef bool (*bmapper) (double); |
2676 | 284 |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
285 Matrix map (dmapper fcn) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
286 ComplexMatrix map (cmapper fcn) const; |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7076
diff
changeset
|
287 boolMatrix map (bmapper fcn) const; |
458 | 288 |
4431 | 289 bool any_element_is_negative (bool = false) const; |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7800
diff
changeset
|
290 bool any_element_is_nan (void) const; |
2385 | 291 bool any_element_is_inf_or_nan (void) const; |
5943 | 292 bool any_element_not_one_or_zero (void) const; |
2385 | 293 bool all_elements_are_int_or_inf_or_nan (void) const; |
294 bool all_integers (double& max_val, double& min_val) const; | |
295 bool too_large_for_float (void) const; | |
1963 | 296 |
4017 | 297 boolMatrix all (int dim = -1) const; |
298 boolMatrix any (int dim = -1) const; | |
458 | 299 |
4017 | 300 Matrix cumprod (int dim = -1) const; |
301 Matrix cumsum (int dim = -1) const; | |
302 Matrix prod (int dim = -1) const; | |
303 Matrix sum (int dim = -1) const; | |
304 Matrix sumsq (int dim = -1) const; | |
2385 | 305 Matrix abs (void) const; |
458 | 306 |
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
307 Matrix diag (octave_idx_type k = 0) const; |
458 | 308 |
309 ColumnVector row_min (void) const; | |
2354 | 310 ColumnVector row_max (void) const; |
458 | 311 |
5275 | 312 ColumnVector row_min (Array<octave_idx_type>& index) const; |
313 ColumnVector row_max (Array<octave_idx_type>& index) const; | |
458 | 314 |
315 RowVector column_min (void) const; | |
2354 | 316 RowVector column_max (void) const; |
458 | 317 |
5275 | 318 RowVector column_min (Array<octave_idx_type>& index) const; |
319 RowVector column_max (Array<octave_idx_type>& index) const; | |
458 | 320 |
1359 | 321 // i/o |
458 | 322 |
6108 | 323 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const Matrix& a); |
324 friend OCTAVE_API std::istream& operator >> (std::istream& is, Matrix& a); | |
458 | 325 |
3933 | 326 static double resize_fill_value (void) { return 0; } |
327 | |
458 | 328 private: |
329 | |
5275 | 330 Matrix (double *d, octave_idx_type r, octave_idx_type c) : MArray2<double> (d, r, c) { } |
458 | 331 }; |
332 | |
5508 | 333 // Publish externally used friend functions. |
334 | |
6108 | 335 extern OCTAVE_API Matrix real (const ComplexMatrix& a); |
336 extern OCTAVE_API Matrix imag (const ComplexMatrix& a); | |
5508 | 337 |
338 // column vector by row vector -> matrix operations | |
339 | |
6108 | 340 extern OCTAVE_API Matrix operator * (const ColumnVector& a, const RowVector& b); |
5508 | 341 |
342 // Other functions. | |
343 | |
6108 | 344 extern OCTAVE_API Matrix Givens (double, double); |
1819 | 345 |
6108 | 346 extern OCTAVE_API Matrix Sylvester (const Matrix&, const Matrix&, const Matrix&); |
1959 | 347 |
7800
5861b95e9879
support for compound operators, implement trans_mul, mul_trans, herm_mul and mul_herm
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
348 extern OCTAVE_API Matrix xgemm (bool transa, const Matrix& a, bool transb, const Matrix& b); |
5861b95e9879
support for compound operators, implement trans_mul, mul_trans, herm_mul and mul_herm
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
349 |
6108 | 350 extern OCTAVE_API Matrix operator * (const Matrix& a, const Matrix& b); |
2828 | 351 |
6108 | 352 extern OCTAVE_API Matrix min (double d, const Matrix& m); |
353 extern OCTAVE_API Matrix min (const Matrix& m, double d); | |
354 extern OCTAVE_API Matrix min (const Matrix& a, const Matrix& b); | |
4309 | 355 |
6108 | 356 extern OCTAVE_API Matrix max (double d, const Matrix& m); |
357 extern OCTAVE_API Matrix max (const Matrix& m, double d); | |
358 extern OCTAVE_API Matrix max (const Matrix& a, const Matrix& b); | |
4309 | 359 |
6708 | 360 MS_CMP_OP_DECLS (Matrix, double, OCTAVE_API) |
361 MS_BOOL_OP_DECLS (Matrix, double, OCTAVE_API) | |
2870 | 362 |
6708 | 363 SM_CMP_OP_DECLS (double, Matrix, OCTAVE_API) |
364 SM_BOOL_OP_DECLS (double, Matrix, OCTAVE_API) | |
2870 | 365 |
6708 | 366 MM_CMP_OP_DECLS (Matrix, Matrix, OCTAVE_API) |
367 MM_BOOL_OP_DECLS (Matrix, Matrix, OCTAVE_API) | |
2870 | 368 |
3573 | 369 MARRAY_FORWARD_DEFS (MArray2, Matrix, double) |
370 | |
3689 | 371 template <class T> |
372 void read_int (std::istream& is, bool swap_bytes, T& val); | |
373 | |
458 | 374 #endif |
375 | |
376 /* | |
377 ;;; Local Variables: *** | |
378 ;;; mode: C++ *** | |
379 ;;; End: *** | |
380 */ |