1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1994-2025 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_fMatrix_h)
#define octave_fMatrix_h 1
#include "octave-config.h"
#include "DET.h"
#include "MArray.h"
#include "MDiagArray2.h"
#include "MatrixType.h"
#include "fNDArray.h"
#include "mx-defs.h"
#include "mx-op-decl.h"
class OCTAVE_API FloatMatrix : public FloatNDArray
{
public:
typedef FloatColumnVector column_vector_type;
typedef FloatRowVector row_vector_type;
typedef FloatColumnVector real_column_vector_type;
typedef FloatRowVector real_row_vector_type;
typedef FloatMatrix real_matrix_type;
typedef FloatComplexMatrix complex_matrix_type;
typedef FloatDiagMatrix real_diag_matrix_type;
typedef FloatComplexDiagMatrix complex_diag_matrix_type;
typedef float real_elt_type;
typedef FloatComplex complex_elt_type;
typedef void (*solve_singularity_handler) (float rcon);
FloatMatrix () = default;
FloatMatrix (const FloatMatrix& a) = default;
FloatMatrix& operator = (const FloatMatrix& a) = default;
~FloatMatrix () = default;
FloatMatrix (octave_idx_type r, octave_idx_type c)
: FloatNDArray (dim_vector (r, c)) { }
FloatMatrix (octave_idx_type r, octave_idx_type c, float val)
: FloatNDArray (dim_vector (r, c), val) { }
FloatMatrix (const dim_vector& dv) : FloatNDArray (dv.redim (2)) { }
FloatMatrix (const dim_vector& dv, float val)
: FloatNDArray (dv.redim (2), val) { }
template <typename U>
FloatMatrix (const MArray<U>& a) : FloatNDArray (a.as_matrix ()) { }
template <typename U>
FloatMatrix (const Array<U>& a) : FloatNDArray (a.as_matrix ()) { }
explicit OCTAVE_API FloatMatrix (const FloatRowVector& rv);
explicit OCTAVE_API FloatMatrix (const FloatColumnVector& cv);
explicit OCTAVE_API FloatMatrix (const FloatDiagMatrix& a);
explicit OCTAVE_API FloatMatrix (const MDiagArray2<float>& a);
explicit OCTAVE_API FloatMatrix (const DiagArray2<float>& a);
explicit OCTAVE_API FloatMatrix (const PermMatrix& a);
explicit OCTAVE_API FloatMatrix (const boolMatrix& a);
explicit OCTAVE_API FloatMatrix (const charMatrix& a);
OCTAVE_API bool operator == (const FloatMatrix& a) const;
OCTAVE_API bool operator != (const FloatMatrix& a) const;
OCTAVE_API bool issymmetric () const;
// destructive insert/delete/reorder operations
OCTAVE_API FloatMatrix&
insert (const FloatMatrix& a, octave_idx_type r, octave_idx_type c);
OCTAVE_API FloatMatrix&
insert (const FloatRowVector& a, octave_idx_type r, octave_idx_type c);
OCTAVE_API FloatMatrix&
insert (const FloatColumnVector& a, octave_idx_type r, octave_idx_type c);
OCTAVE_API FloatMatrix&
insert (const FloatDiagMatrix& a, octave_idx_type r, octave_idx_type c);
OCTAVE_API FloatMatrix& fill (float val);
OCTAVE_API FloatMatrix&
fill (float val, octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2);
OCTAVE_API FloatMatrix append (const FloatMatrix& a) const;
OCTAVE_API FloatMatrix append (const FloatRowVector& a) const;
OCTAVE_API FloatMatrix append (const FloatColumnVector& a) const;
OCTAVE_API FloatMatrix append (const FloatDiagMatrix& a) const;
OCTAVE_API FloatMatrix stack (const FloatMatrix& a) const;
OCTAVE_API FloatMatrix stack (const FloatRowVector& a) const;
OCTAVE_API FloatMatrix stack (const FloatColumnVector& a) const;
OCTAVE_API FloatMatrix stack (const FloatDiagMatrix& a) const;
friend OCTAVE_API FloatMatrix real (const FloatComplexMatrix& a);
friend OCTAVE_API FloatMatrix imag (const FloatComplexMatrix& a);
friend class FloatComplexMatrix;
FloatMatrix hermitian () const { return MArray<float>::transpose (); }
FloatMatrix transpose () const { return MArray<float>::transpose (); }
// resize is the destructive equivalent for this one
OCTAVE_API FloatMatrix
extract (octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2) const;
OCTAVE_API FloatMatrix
extract_n (octave_idx_type r1, octave_idx_type c1,
octave_idx_type nr, octave_idx_type nc) const;
// extract row or column i.
OCTAVE_API FloatRowVector row (octave_idx_type i) const;
OCTAVE_API FloatColumnVector column (octave_idx_type i) const;
void resize (octave_idx_type nr, octave_idx_type nc, float rfv = 0)
{
MArray<float>::resize (dim_vector (nr, nc), rfv);
}
private:
FloatMatrix tinverse (MatrixType& mattype, octave_idx_type& info,
float& rcon, bool force, bool calc_cond) const;
FloatMatrix finverse (MatrixType& mattype, octave_idx_type& info,
float& rcon, bool force, bool calc_cond) const;
public:
OCTAVE_API FloatMatrix inverse () const;
OCTAVE_API FloatMatrix inverse (octave_idx_type& info) const;
OCTAVE_API FloatMatrix
inverse (octave_idx_type& info, float& rcon,
bool force = false, bool calc_cond = true) const;
OCTAVE_API FloatMatrix inverse (MatrixType& mattype) const;
OCTAVE_API FloatMatrix
inverse (MatrixType& mattype, octave_idx_type& info) const;
OCTAVE_API FloatMatrix
inverse (MatrixType& mattype, octave_idx_type& info, float& rcon,
bool force = false, bool calc_cond = true) const;
OCTAVE_API FloatMatrix pseudo_inverse (float tol = 0.0) const;
OCTAVE_API FloatComplexMatrix fourier () const;
OCTAVE_API FloatComplexMatrix ifourier () const;
OCTAVE_API FloatComplexMatrix fourier2d () const;
OCTAVE_API FloatComplexMatrix ifourier2d () const;
OCTAVE_API FloatDET determinant () const;
OCTAVE_API FloatDET determinant (octave_idx_type& info) const;
OCTAVE_API FloatDET
determinant (octave_idx_type& info, float& rcon,
bool calc_cond = true) const;
OCTAVE_API FloatDET
determinant (MatrixType& mattype, octave_idx_type& info, float& rcon,
bool calc_cond = true) const;
OCTAVE_API float rcond () const;
OCTAVE_API float rcond (MatrixType& mattype) const;
private:
// Upper triangular matrix solvers
FloatMatrix utsolve (MatrixType& mattype, const FloatMatrix& b,
octave_idx_type& info,
float& rcon, solve_singularity_handler sing_handler,
bool calc_cond = false,
blas_trans_type transt = blas_no_trans) const;
// Lower triangular matrix solvers
FloatMatrix ltsolve (MatrixType& mattype, const FloatMatrix& b,
octave_idx_type& info,
float& rcon, solve_singularity_handler sing_handler,
bool calc_cond = false,
blas_trans_type transt = blas_no_trans) const;
// Full matrix solvers (lu/cholesky)
FloatMatrix fsolve (MatrixType& mattype, const FloatMatrix& b,
octave_idx_type& info,
float& rcon, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
public:
// Generic interface to solver with no probing of type
OCTAVE_API FloatMatrix
solve (MatrixType& mattype, const FloatMatrix& b) const;
OCTAVE_API FloatMatrix
solve (MatrixType& mattype, const FloatMatrix& b,
octave_idx_type& info) const;
OCTAVE_API FloatMatrix
solve (MatrixType& mattype, const FloatMatrix& b, octave_idx_type& info,
float& rcon) const;
OCTAVE_API FloatMatrix
solve (MatrixType& mattype, const FloatMatrix& b, octave_idx_type& info,
float& rcon, solve_singularity_handler sing_handler,
bool singular_fallback = true,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatComplexMatrix
solve (MatrixType& mattype, const FloatComplexMatrix& b) const;
OCTAVE_API FloatComplexMatrix
solve (MatrixType& mattype, const FloatComplexMatrix& b,
octave_idx_type& info) const;
OCTAVE_API FloatComplexMatrix
solve (MatrixType& mattype, const FloatComplexMatrix& b,
octave_idx_type& info, float& rcon) const;
OCTAVE_API FloatComplexMatrix
solve (MatrixType& mattype, const FloatComplexMatrix& b,
octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler, bool singular_fallback = true,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatColumnVector
solve (MatrixType& mattype, const FloatColumnVector& b) const;
OCTAVE_API FloatColumnVector
solve (MatrixType& mattype, const FloatColumnVector& b,
octave_idx_type& info) const;
OCTAVE_API FloatColumnVector
solve (MatrixType& mattype, const FloatColumnVector& b,
octave_idx_type& info, float& rcon) const;
OCTAVE_API FloatColumnVector
solve (MatrixType& mattype, const FloatColumnVector& b,
octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatComplexColumnVector
solve (MatrixType& mattype, const FloatComplexColumnVector& b) const;
OCTAVE_API FloatComplexColumnVector
solve (MatrixType& mattype, const FloatComplexColumnVector& b,
octave_idx_type& info) const;
OCTAVE_API FloatComplexColumnVector
solve (MatrixType& mattype, const FloatComplexColumnVector& b,
octave_idx_type& info, float& rcon) const;
OCTAVE_API FloatComplexColumnVector
solve (MatrixType& mattype, const FloatComplexColumnVector& b,
octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
// Generic interface to solver with probing of type
OCTAVE_API FloatMatrix solve (const FloatMatrix& b) const;
OCTAVE_API FloatMatrix
solve (const FloatMatrix& b, octave_idx_type& info) const;
OCTAVE_API FloatMatrix
solve (const FloatMatrix& b, octave_idx_type& info, float& rcon) const;
OCTAVE_API FloatMatrix
solve (const FloatMatrix& b, octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatComplexMatrix solve (const FloatComplexMatrix& b) const;
OCTAVE_API FloatComplexMatrix
solve (const FloatComplexMatrix& b, octave_idx_type& info) const;
OCTAVE_API FloatComplexMatrix
solve (const FloatComplexMatrix& b, octave_idx_type& info,
float& rcon) const;
OCTAVE_API FloatComplexMatrix
solve (const FloatComplexMatrix& b, octave_idx_type& info,
float& rcon, solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatColumnVector solve (const FloatColumnVector& b) const;
OCTAVE_API FloatColumnVector
solve (const FloatColumnVector& b, octave_idx_type& info) const;
OCTAVE_API FloatColumnVector
solve (const FloatColumnVector& b, octave_idx_type& info, float& rcon) const;
OCTAVE_API FloatColumnVector
solve (const FloatColumnVector& b, octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
OCTAVE_API FloatComplexColumnVector
solve (const FloatComplexColumnVector& b) const;
OCTAVE_API FloatComplexColumnVector
solve (const FloatComplexColumnVector& b, octave_idx_type& info) const;
OCTAVE_API FloatComplexColumnVector
solve (const FloatComplexColumnVector& b, octave_idx_type& info,
float& rcon) const;
OCTAVE_API FloatComplexColumnVector
solve (const FloatComplexColumnVector& b, octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
// Singular solvers
OCTAVE_API FloatMatrix lssolve (const FloatMatrix& b) const;
OCTAVE_API FloatMatrix
lssolve (const FloatMatrix& b, octave_idx_type& info) const;
OCTAVE_API FloatMatrix
lssolve (const FloatMatrix& b, octave_idx_type& info,
octave_idx_type& rank) const;
OCTAVE_API FloatMatrix
lssolve (const FloatMatrix& b, octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
OCTAVE_API FloatComplexMatrix lssolve (const FloatComplexMatrix& b) const;
OCTAVE_API FloatComplexMatrix
lssolve (const FloatComplexMatrix& b, octave_idx_type& info) const;
OCTAVE_API FloatComplexMatrix
lssolve (const FloatComplexMatrix& b, octave_idx_type& info,
octave_idx_type& rank) const;
OCTAVE_API FloatComplexMatrix
lssolve (const FloatComplexMatrix& b, octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
OCTAVE_API FloatColumnVector lssolve (const FloatColumnVector& b) const;
OCTAVE_API FloatColumnVector
lssolve (const FloatColumnVector& b, octave_idx_type& info) const;
OCTAVE_API FloatColumnVector
lssolve (const FloatColumnVector& b, octave_idx_type& info,
octave_idx_type& rank) const;
OCTAVE_API FloatColumnVector
lssolve (const FloatColumnVector& b, octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
OCTAVE_API FloatComplexColumnVector
lssolve (const FloatComplexColumnVector& b) const;
OCTAVE_API FloatComplexColumnVector
lssolve (const FloatComplexColumnVector& b, octave_idx_type& info) const;
OCTAVE_API FloatComplexColumnVector
lssolve (const FloatComplexColumnVector& b, octave_idx_type& info,
octave_idx_type& rank) const;
OCTAVE_API FloatComplexColumnVector
lssolve (const FloatComplexColumnVector& b, octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
OCTAVE_API FloatMatrix& operator += (const FloatDiagMatrix& a);
OCTAVE_API FloatMatrix& operator -= (const FloatDiagMatrix& a);
OCTAVE_API FloatMatrix cumprod (int dim = -1) const;
OCTAVE_API FloatMatrix cumsum (int dim = -1) const;
OCTAVE_API FloatMatrix prod (int dim = -1) const;
OCTAVE_API FloatMatrix sum (int dim = -1) const;
OCTAVE_API FloatMatrix sumsq (int dim = -1) const;
OCTAVE_API FloatMatrix abs () const;
OCTAVE_API FloatMatrix diag (octave_idx_type k = 0) const;
OCTAVE_API FloatDiagMatrix diag (octave_idx_type m, octave_idx_type n) const;
OCTAVE_API FloatColumnVector row_min () const;
OCTAVE_API FloatColumnVector row_max () const;
OCTAVE_API FloatColumnVector row_min (Array<octave_idx_type>& index) const;
OCTAVE_API FloatColumnVector row_max (Array<octave_idx_type>& index) const;
OCTAVE_API FloatRowVector column_min () const;
OCTAVE_API FloatRowVector column_max () const;
OCTAVE_API FloatRowVector column_min (Array<octave_idx_type>& index) const;
OCTAVE_API FloatRowVector column_max (Array<octave_idx_type>& index) const;
// i/o
friend OCTAVE_API std::ostream&
operator << (std::ostream& os, const FloatMatrix& a);
friend OCTAVE_API std::istream&
operator >> (std::istream& is, FloatMatrix& a);
};
// Publish externally used friend functions.
extern OCTAVE_API FloatMatrix real (const FloatComplexMatrix& a);
extern OCTAVE_API FloatMatrix imag (const FloatComplexMatrix& a);
// column vector by row vector -> matrix operations
extern OCTAVE_API FloatMatrix operator * (const FloatColumnVector& a,
const FloatRowVector& b);
// Other functions.
extern OCTAVE_API FloatMatrix Givens (float, float);
extern OCTAVE_API FloatMatrix Sylvester (const FloatMatrix&, const FloatMatrix&,
const FloatMatrix&);
extern OCTAVE_API FloatMatrix xgemm (const FloatMatrix& a, const FloatMatrix& b,
blas_trans_type transa = blas_no_trans,
blas_trans_type transb = blas_no_trans);
extern OCTAVE_API FloatMatrix operator * (const FloatMatrix& a,
const FloatMatrix& b);
extern OCTAVE_API FloatMatrix min (float d, const FloatMatrix& m);
extern OCTAVE_API FloatMatrix min (const FloatMatrix& m, float d);
extern OCTAVE_API FloatMatrix min (const FloatMatrix& a, const FloatMatrix& b);
extern OCTAVE_API FloatMatrix max (float d, const FloatMatrix& m);
extern OCTAVE_API FloatMatrix max (const FloatMatrix& m, float d);
extern OCTAVE_API FloatMatrix max (const FloatMatrix& a, const FloatMatrix& b);
extern OCTAVE_API FloatMatrix linspace (const FloatColumnVector& x1,
const FloatColumnVector& x2,
octave_idx_type n);
MS_CMP_OP_DECLS (FloatMatrix, float, OCTAVE_API)
MS_BOOL_OP_DECLS (FloatMatrix, float, OCTAVE_API)
SM_CMP_OP_DECLS (float, FloatMatrix, OCTAVE_API)
SM_BOOL_OP_DECLS (float, FloatMatrix, OCTAVE_API)
MM_CMP_OP_DECLS (FloatMatrix, FloatMatrix, OCTAVE_API)
MM_BOOL_OP_DECLS (FloatMatrix, FloatMatrix, OCTAVE_API)
MARRAY_FORWARD_DEFS (MArray, FloatMatrix, float)
template <typename T>
void read_int (std::istream& is, bool swap_bytes, T& val);
#endif
|
