/usr/include/octave-4.2.2/octave/fCMatrix.h is in liboctave-dev 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 | /*
Copyright (C) 1994-2017 John W. Eaton
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
<http://www.gnu.org/licenses/>.
*/
#if ! defined (octave_fCMatrix_h)
#define octave_fCMatrix_h 1
#include "octave-config.h"
#include "fCNDArray.h"
#include "MArray.h"
#include "MDiagArray2.h"
#include "MatrixType.h"
#include "mx-defs.h"
#include "mx-op-decl.h"
#include "oct-cmplx.h"
#include "DET.h"
class
OCTAVE_API
FloatComplexMatrix : public FloatComplexNDArray
{
public:
typedef FloatComplexColumnVector column_vector_type;
typedef FloatComplexRowVector 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);
FloatComplexMatrix (void) : FloatComplexNDArray () { }
FloatComplexMatrix (octave_idx_type r, octave_idx_type c)
: FloatComplexNDArray (dim_vector (r, c)) { }
FloatComplexMatrix (octave_idx_type r, octave_idx_type c,
const FloatComplex& val)
: FloatComplexNDArray (dim_vector (r, c), val) { }
FloatComplexMatrix (const dim_vector& dv)
: FloatComplexNDArray (dv.redim (2)) { }
FloatComplexMatrix (const dim_vector& dv, const FloatComplex& val)
: FloatComplexNDArray (dv.redim (2), val) { }
FloatComplexMatrix (const FloatComplexMatrix& a)
: FloatComplexNDArray (a) { }
template <typename U>
FloatComplexMatrix (const MArray<U>& a)
: FloatComplexNDArray (a.as_matrix ()) { }
template <typename U>
FloatComplexMatrix (const Array<U>& a)
: FloatComplexNDArray (a.as_matrix ()) { }
explicit FloatComplexMatrix (const FloatMatrix& a);
explicit FloatComplexMatrix (const FloatRowVector& rv);
explicit FloatComplexMatrix (const FloatColumnVector& cv);
explicit FloatComplexMatrix (const FloatDiagMatrix& a);
explicit FloatComplexMatrix (const MDiagArray2<float>& a);
explicit FloatComplexMatrix (const DiagArray2<float>& a);
explicit FloatComplexMatrix (const FloatComplexRowVector& rv);
explicit FloatComplexMatrix (const FloatComplexColumnVector& cv);
explicit FloatComplexMatrix (const FloatComplexDiagMatrix& a);
explicit FloatComplexMatrix (const MDiagArray2<FloatComplex>& a);
explicit FloatComplexMatrix (const DiagArray2<FloatComplex>& a);
explicit FloatComplexMatrix (const boolMatrix& a);
explicit FloatComplexMatrix (const charMatrix& a);
FloatComplexMatrix (const FloatMatrix& re, const FloatMatrix& im);
bool operator == (const FloatComplexMatrix& a) const;
bool operator != (const FloatComplexMatrix& a) const;
bool is_hermitian (void) const;
// destructive insert/delete/reorder operations
FloatComplexMatrix& insert (const FloatMatrix& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatRowVector& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatColumnVector& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatDiagMatrix& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatComplexMatrix& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatComplexRowVector& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatComplexColumnVector& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& insert (const FloatComplexDiagMatrix& a,
octave_idx_type r, octave_idx_type c);
FloatComplexMatrix& fill (float val);
FloatComplexMatrix& fill (const FloatComplex& val);
FloatComplexMatrix& fill (float val, octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2);
FloatComplexMatrix& fill (const FloatComplex& val,
octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2);
FloatComplexMatrix append (const FloatMatrix& a) const;
FloatComplexMatrix append (const FloatRowVector& a) const;
FloatComplexMatrix append (const FloatColumnVector& a) const;
FloatComplexMatrix append (const FloatDiagMatrix& a) const;
FloatComplexMatrix append (const FloatComplexMatrix& a) const;
FloatComplexMatrix append (const FloatComplexRowVector& a) const;
FloatComplexMatrix append (const FloatComplexColumnVector& a) const;
FloatComplexMatrix append (const FloatComplexDiagMatrix& a) const;
FloatComplexMatrix stack (const FloatMatrix& a) const;
FloatComplexMatrix stack (const FloatRowVector& a) const;
FloatComplexMatrix stack (const FloatColumnVector& a) const;
FloatComplexMatrix stack (const FloatDiagMatrix& a) const;
FloatComplexMatrix stack (const FloatComplexMatrix& a) const;
FloatComplexMatrix stack (const FloatComplexRowVector& a) const;
FloatComplexMatrix stack (const FloatComplexColumnVector& a) const;
FloatComplexMatrix stack (const FloatComplexDiagMatrix& a) const;
FloatComplexMatrix hermitian (void) const
{ return MArray<FloatComplex>::hermitian (std::conj); }
FloatComplexMatrix transpose (void) const
{ return MArray<FloatComplex>::transpose (); }
friend OCTAVE_API FloatComplexMatrix conj (const FloatComplexMatrix& a);
// resize is the destructive equivalent for this one
FloatComplexMatrix extract (octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2) const;
FloatComplexMatrix extract_n (octave_idx_type r1, octave_idx_type c1,
octave_idx_type nr, octave_idx_type nc) const;
// extract row or column i.
FloatComplexRowVector row (octave_idx_type i) const;
FloatComplexColumnVector column (octave_idx_type i) const;
void resize (octave_idx_type nr, octave_idx_type nc,
const FloatComplex& rfv = FloatComplex (0))
{
MArray<FloatComplex>::resize (dim_vector (nr, nc), rfv);
}
private:
FloatComplexMatrix tinverse (MatrixType &mattype, octave_idx_type& info,
float& rcon, bool force, bool calc_cond) const;
FloatComplexMatrix finverse (MatrixType &mattype, octave_idx_type& info,
float& rcon, bool force, bool calc_cond) const;
public:
FloatComplexMatrix inverse (void) const;
FloatComplexMatrix inverse (octave_idx_type& info) const;
FloatComplexMatrix inverse (octave_idx_type& info, float& rcon,
bool force = false, bool calc_cond = true) const;
FloatComplexMatrix inverse (MatrixType &mattype) const;
FloatComplexMatrix inverse (MatrixType &mattype, octave_idx_type& info) const;
FloatComplexMatrix inverse (MatrixType &mattype, octave_idx_type& info,
float& rcon, bool force = false,
bool calc_cond = true) const;
FloatComplexMatrix pseudo_inverse (float tol = 0.0) const;
FloatComplexMatrix fourier (void) const;
FloatComplexMatrix ifourier (void) const;
FloatComplexMatrix fourier2d (void) const;
FloatComplexMatrix ifourier2d (void) const;
FloatComplexDET determinant (void) const;
FloatComplexDET determinant (octave_idx_type& info) const;
FloatComplexDET determinant (octave_idx_type& info, float& rcon,
bool calc_cond = true) const;
FloatComplexDET determinant (MatrixType &mattype, octave_idx_type& info,
float& rcon, bool calc_cond = true) const;
float rcond (void) const;
float rcond (MatrixType &mattype) const;
private:
// Upper triangular matrix solvers
FloatComplexMatrix utsolve (MatrixType &typ, const FloatComplexMatrix& 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
FloatComplexMatrix ltsolve (MatrixType &typ, const FloatComplexMatrix& 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 (umfpack/cholesky)
FloatComplexMatrix fsolve (MatrixType &typ, const FloatComplexMatrix& 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
FloatComplexMatrix solve (MatrixType &typ, const FloatMatrix& b) const;
FloatComplexMatrix solve (MatrixType &typ, const FloatMatrix& b,
octave_idx_type& info) const;
FloatComplexMatrix solve (MatrixType &typ, const FloatMatrix& b,
octave_idx_type& info, float& rcon) const;
FloatComplexMatrix solve (MatrixType &typ, 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;
FloatComplexMatrix solve (MatrixType &typ, const FloatComplexMatrix& b) const;
FloatComplexMatrix solve (MatrixType &typ, const FloatComplexMatrix& b,
octave_idx_type& info) const;
FloatComplexMatrix solve (MatrixType &typ, const FloatComplexMatrix& b,
octave_idx_type& info, float& rcon) const;
FloatComplexMatrix solve (MatrixType &typ, 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;
FloatComplexColumnVector solve (MatrixType &typ,
const FloatColumnVector& b) const;
FloatComplexColumnVector solve (MatrixType &typ, const FloatColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector solve (MatrixType &typ, const FloatColumnVector& b,
octave_idx_type& info, float& rcon) const;
FloatComplexColumnVector solve (MatrixType &typ, const FloatColumnVector& b,
octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
FloatComplexColumnVector solve (MatrixType &typ,
const FloatComplexColumnVector& b) const;
FloatComplexColumnVector solve (MatrixType &typ,
const FloatComplexColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector solve (MatrixType &typ,
const FloatComplexColumnVector& b,
octave_idx_type& info, float& rcon) const;
FloatComplexColumnVector solve (MatrixType &typ,
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
FloatComplexMatrix solve (const FloatMatrix& b) const;
FloatComplexMatrix solve (const FloatMatrix& b, octave_idx_type& info) const;
FloatComplexMatrix solve (const FloatMatrix& b, octave_idx_type& info,
float& rcon) const;
FloatComplexMatrix solve (const FloatMatrix& b, octave_idx_type& info,
float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
FloatComplexMatrix solve (const FloatComplexMatrix& b) const;
FloatComplexMatrix solve (const FloatComplexMatrix& b,
octave_idx_type& info) const;
FloatComplexMatrix solve (const FloatComplexMatrix& b, octave_idx_type& info,
float& rcon) const;
FloatComplexMatrix solve (const FloatComplexMatrix& b, octave_idx_type& info,
float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
FloatComplexColumnVector solve (const FloatColumnVector& b) const;
FloatComplexColumnVector solve (const FloatColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector solve (const FloatColumnVector& b,
octave_idx_type& info,
float& rcon) const;
FloatComplexColumnVector solve (const FloatColumnVector& b,
octave_idx_type& info, float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
FloatComplexColumnVector solve (const FloatComplexColumnVector& b) const;
FloatComplexColumnVector solve (const FloatComplexColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector solve (const FloatComplexColumnVector& b,
octave_idx_type& info,
float& rcon) const;
FloatComplexColumnVector solve (const FloatComplexColumnVector& b,
octave_idx_type& info,
float& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
FloatComplexMatrix lssolve (const FloatMatrix& b) const;
FloatComplexMatrix lssolve (const FloatMatrix& b,
octave_idx_type& info) const;
FloatComplexMatrix lssolve (const FloatMatrix& b, octave_idx_type& info,
octave_idx_type& rank) const;
FloatComplexMatrix lssolve (const FloatMatrix& b, octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
FloatComplexMatrix lssolve (const FloatComplexMatrix& b) const;
FloatComplexMatrix lssolve (const FloatComplexMatrix& b,
octave_idx_type& info) const;
FloatComplexMatrix lssolve (const FloatComplexMatrix& b,
octave_idx_type& info, octave_idx_type& rank) const;
FloatComplexMatrix lssolve (const FloatComplexMatrix& b,
octave_idx_type& info, octave_idx_type& rank, float& rcon) const;
FloatComplexColumnVector lssolve (const FloatColumnVector& b) const;
FloatComplexColumnVector lssolve (const FloatColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector lssolve (const FloatColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank) const;
FloatComplexColumnVector lssolve (const FloatColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
FloatComplexColumnVector lssolve (const FloatComplexColumnVector& b) const;
FloatComplexColumnVector lssolve (const FloatComplexColumnVector& b,
octave_idx_type& info) const;
FloatComplexColumnVector lssolve (const FloatComplexColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank) const;
FloatComplexColumnVector lssolve (const FloatComplexColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank, float& rcon) const;
// matrix by diagonal matrix -> matrix operations
FloatComplexMatrix& operator += (const FloatDiagMatrix& a);
FloatComplexMatrix& operator -= (const FloatDiagMatrix& a);
FloatComplexMatrix& operator += (const FloatComplexDiagMatrix& a);
FloatComplexMatrix& operator -= (const FloatComplexDiagMatrix& a);
// matrix by matrix -> matrix operations
FloatComplexMatrix& operator += (const FloatMatrix& a);
FloatComplexMatrix& operator -= (const FloatMatrix& a);
// unary operations
boolMatrix operator ! (void) const;
// other operations
boolMatrix all (int dim = -1) const;
boolMatrix any (int dim = -1) const;
FloatComplexMatrix cumprod (int dim = -1) const;
FloatComplexMatrix cumsum (int dim = -1) const;
FloatComplexMatrix prod (int dim = -1) const;
FloatComplexMatrix sum (int dim = -1) const;
FloatComplexMatrix sumsq (int dim = -1) const;
FloatMatrix abs (void) const;
FloatComplexMatrix diag (octave_idx_type k = 0) const;
FloatComplexDiagMatrix diag (octave_idx_type m, octave_idx_type n) const;
bool row_is_real_only (octave_idx_type) const;
bool column_is_real_only (octave_idx_type) const;
FloatComplexColumnVector row_min (void) const;
FloatComplexColumnVector row_max (void) const;
FloatComplexColumnVector row_min (Array<octave_idx_type>& index) const;
FloatComplexColumnVector row_max (Array<octave_idx_type>& index) const;
FloatComplexRowVector column_min (void) const;
FloatComplexRowVector column_max (void) const;
FloatComplexRowVector column_min (Array<octave_idx_type>& index) const;
FloatComplexRowVector column_max (Array<octave_idx_type>& index) const;
// i/o
friend OCTAVE_API std::ostream& operator << (std::ostream& os,
const FloatComplexMatrix& a);
friend OCTAVE_API std::istream& operator >> (std::istream& is,
FloatComplexMatrix& a);
};
extern OCTAVE_API FloatComplexMatrix conj (const FloatComplexMatrix& a);
// column vector by row vector -> matrix operations
extern OCTAVE_API FloatComplexMatrix
operator * (const FloatColumnVector& a, const FloatComplexRowVector& b);
extern OCTAVE_API FloatComplexMatrix
operator * (const FloatComplexColumnVector& a, const FloatRowVector& b);
extern OCTAVE_API FloatComplexMatrix
operator * (const FloatComplexColumnVector& a, const FloatComplexRowVector& b);
extern OCTAVE_API FloatComplexMatrix
Givens (const FloatComplex&, const FloatComplex&);
extern OCTAVE_API FloatComplexMatrix
Sylvester (const FloatComplexMatrix&, const FloatComplexMatrix&,
const FloatComplexMatrix&);
extern OCTAVE_API FloatComplexMatrix
xgemm (const FloatComplexMatrix& a, const FloatComplexMatrix& b,
blas_trans_type transa = blas_no_trans,
blas_trans_type transb = blas_no_trans);
extern OCTAVE_API FloatComplexMatrix operator * (const FloatMatrix&,
const FloatComplexMatrix&);
extern OCTAVE_API FloatComplexMatrix operator * (const FloatComplexMatrix&,
const FloatMatrix&);
extern OCTAVE_API FloatComplexMatrix operator * (const FloatComplexMatrix&,
const FloatComplexMatrix&);
extern OCTAVE_API FloatComplexMatrix min (const FloatComplex& c,
const FloatComplexMatrix& m);
extern OCTAVE_API FloatComplexMatrix min (const FloatComplexMatrix& m,
const FloatComplex& c);
extern OCTAVE_API FloatComplexMatrix min (const FloatComplexMatrix& a,
const FloatComplexMatrix& b);
extern OCTAVE_API FloatComplexMatrix max (const FloatComplex& c,
const FloatComplexMatrix& m);
extern OCTAVE_API FloatComplexMatrix max (const FloatComplexMatrix& m,
const FloatComplex& c);
extern OCTAVE_API FloatComplexMatrix max (const FloatComplexMatrix& a,
const FloatComplexMatrix& b);
extern OCTAVE_API FloatComplexMatrix
linspace (const FloatComplexColumnVector& x1,
const FloatComplexColumnVector& x2,
octave_idx_type n);
MS_CMP_OP_DECLS (FloatComplexMatrix, FloatComplex, OCTAVE_API)
MS_BOOL_OP_DECLS (FloatComplexMatrix, FloatComplex, OCTAVE_API)
SM_CMP_OP_DECLS (FloatComplex, FloatComplexMatrix, OCTAVE_API)
SM_BOOL_OP_DECLS (FloatComplex, FloatComplexMatrix, OCTAVE_API)
MM_CMP_OP_DECLS (FloatComplexMatrix, FloatComplexMatrix, OCTAVE_API)
MM_BOOL_OP_DECLS (FloatComplexMatrix, FloatComplexMatrix, OCTAVE_API)
MARRAY_FORWARD_DEFS (MArray, FloatComplexMatrix, FloatComplex)
#endif
|