/usr/include/octave-3.8.1/octave/CMatrix.h is in liboctave-dev 3.8.1-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 | /*
Copyright (C) 1994-2013 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_CMatrix_h)
#define octave_CMatrix_h 1
#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
ComplexMatrix : public MArray<Complex>
{
public:
typedef ComplexColumnVector column_vector_type;
typedef ComplexRowVector row_vector_type;
typedef void (*solve_singularity_handler) (double rcon);
ComplexMatrix (void) : MArray<Complex> () { }
ComplexMatrix (octave_idx_type r, octave_idx_type c)
: MArray<Complex> (dim_vector (r, c)) { }
ComplexMatrix (octave_idx_type r, octave_idx_type c, const Complex& val)
: MArray<Complex> (dim_vector (r, c), val) { }
ComplexMatrix (const dim_vector& dv) : MArray<Complex> (dv.redim (2)) { }
ComplexMatrix (const dim_vector& dv, const Complex& val)
: MArray<Complex> (dv.redim (2), val) { }
ComplexMatrix (const ComplexMatrix& a) : MArray<Complex> (a) { }
template <class U>
ComplexMatrix (const MArray<U>& a) : MArray<Complex> (a.as_matrix ()) { }
template <class U>
ComplexMatrix (const Array<U>& a) : MArray<Complex> (a.as_matrix ()) { }
ComplexMatrix (const Matrix& re, const Matrix& im);
explicit ComplexMatrix (const Matrix& a);
explicit ComplexMatrix (const RowVector& rv);
explicit ComplexMatrix (const ColumnVector& cv);
explicit ComplexMatrix (const DiagMatrix& a);
explicit ComplexMatrix (const ComplexRowVector& rv);
explicit ComplexMatrix (const ComplexColumnVector& cv);
explicit ComplexMatrix (const ComplexDiagMatrix& a);
explicit ComplexMatrix (const boolMatrix& a);
explicit ComplexMatrix (const charMatrix& a);
ComplexMatrix& operator = (const ComplexMatrix& a)
{
MArray<Complex>::operator = (a);
return *this;
}
bool operator == (const ComplexMatrix& a) const;
bool operator != (const ComplexMatrix& a) const;
bool is_hermitian (void) const;
// destructive insert/delete/reorder operations
ComplexMatrix& insert (const Matrix& a, octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const RowVector& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const ColumnVector& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const DiagMatrix& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const ComplexMatrix& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const ComplexRowVector& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const ComplexColumnVector& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& insert (const ComplexDiagMatrix& a,
octave_idx_type r, octave_idx_type c);
ComplexMatrix& fill (double val);
ComplexMatrix& fill (const Complex& val);
ComplexMatrix& fill (double val,
octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2);
ComplexMatrix& fill (const Complex& val,
octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2);
ComplexMatrix append (const Matrix& a) const;
ComplexMatrix append (const RowVector& a) const;
ComplexMatrix append (const ColumnVector& a) const;
ComplexMatrix append (const DiagMatrix& a) const;
ComplexMatrix append (const ComplexMatrix& a) const;
ComplexMatrix append (const ComplexRowVector& a) const;
ComplexMatrix append (const ComplexColumnVector& a) const;
ComplexMatrix append (const ComplexDiagMatrix& a) const;
ComplexMatrix stack (const Matrix& a) const;
ComplexMatrix stack (const RowVector& a) const;
ComplexMatrix stack (const ColumnVector& a) const;
ComplexMatrix stack (const DiagMatrix& a) const;
ComplexMatrix stack (const ComplexMatrix& a) const;
ComplexMatrix stack (const ComplexRowVector& a) const;
ComplexMatrix stack (const ComplexColumnVector& a) const;
ComplexMatrix stack (const ComplexDiagMatrix& a) const;
ComplexMatrix hermitian (void) const
{ return MArray<Complex>::hermitian (std::conj); }
ComplexMatrix transpose (void) const
{ return MArray<Complex>::transpose (); }
friend OCTAVE_API ComplexMatrix conj (const ComplexMatrix& a);
// resize is the destructive equivalent for this one
ComplexMatrix extract (octave_idx_type r1, octave_idx_type c1,
octave_idx_type r2, octave_idx_type c2) const;
ComplexMatrix extract_n (octave_idx_type r1, octave_idx_type c1,
octave_idx_type nr, octave_idx_type nc) const;
// extract row or column i.
ComplexRowVector row (octave_idx_type i) const;
ComplexColumnVector column (octave_idx_type i) const;
void resize (octave_idx_type nr, octave_idx_type nc,
const Complex& rfv = Complex (0))
{
MArray<Complex>::resize (dim_vector (nr, nc), rfv);
}
private:
ComplexMatrix tinverse (MatrixType &mattype, octave_idx_type& info,
double& rcon, int force, int calc_cond) const;
ComplexMatrix finverse (MatrixType &mattype, octave_idx_type& info,
double& rcon, int force, int calc_cond) const;
public:
ComplexMatrix inverse (void) const;
ComplexMatrix inverse (octave_idx_type& info) const;
ComplexMatrix inverse (octave_idx_type& info, double& rcon, int force = 0,
int calc_cond = 1) const;
ComplexMatrix inverse (MatrixType &mattype) const;
ComplexMatrix inverse (MatrixType &mattype, octave_idx_type& info) const;
ComplexMatrix inverse (MatrixType &mattype, octave_idx_type& info,
double& rcon, int force = 0,
int calc_cond = 1) const;
ComplexMatrix pseudo_inverse (double tol = 0.0) const;
ComplexMatrix fourier (void) const;
ComplexMatrix ifourier (void) const;
ComplexMatrix fourier2d (void) const;
ComplexMatrix ifourier2d (void) const;
ComplexDET determinant (void) const;
ComplexDET determinant (octave_idx_type& info) const;
ComplexDET determinant (octave_idx_type& info, double& rcon,
int calc_cond = 1) const;
ComplexDET determinant (MatrixType &mattype, octave_idx_type& info,
double& rcon, int calc_cond = 1) const;
double rcond (void) const;
double rcond (MatrixType &mattype) const;
private:
// Upper triangular matrix solvers
ComplexMatrix utsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
bool calc_cond = false,
blas_trans_type transt = blas_no_trans) const;
// Lower triangular matrix solvers
ComplexMatrix ltsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
bool calc_cond = false,
blas_trans_type transt = blas_no_trans) const;
// Full matrix solvers (umfpack/cholesky)
ComplexMatrix fsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
public:
// Generic interface to solver with no probing of type
ComplexMatrix solve (MatrixType &typ, const Matrix& b) const;
ComplexMatrix solve (MatrixType &typ, const Matrix& b,
octave_idx_type& info) const;
ComplexMatrix solve (MatrixType &typ, const Matrix& b,
octave_idx_type& info, double& rcon) const;
ComplexMatrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcon, solve_singularity_handler sing_handler,
bool singular_fallback = true,
blas_trans_type transt = blas_no_trans) const;
ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b) const;
ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info) const;
ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcon) const;
ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
bool singular_fallback = true,
blas_trans_type transt = blas_no_trans) const;
ComplexColumnVector solve (MatrixType &typ, const ColumnVector& b) const;
ComplexColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info) const;
ComplexColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info, double& rcon) const;
ComplexColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
ComplexColumnVector solve (MatrixType &typ,
const ComplexColumnVector& b) const;
ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b,
octave_idx_type& info) const;
ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b,
octave_idx_type& info, double& rcon) const;
ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b,
octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
// Generic interface to solver with probing of type
ComplexMatrix solve (const Matrix& b) const;
ComplexMatrix solve (const Matrix& b, octave_idx_type& info) const;
ComplexMatrix solve (const Matrix& b, octave_idx_type& info,
double& rcon) const;
ComplexMatrix solve (const Matrix& b, octave_idx_type& info, double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
ComplexMatrix solve (const ComplexMatrix& b) const;
ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info) const;
ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info,
double& rcon) const;
ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info,
double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
ComplexColumnVector solve (const ColumnVector& b) const;
ComplexColumnVector solve (const ColumnVector& b, octave_idx_type& info) const;
ComplexColumnVector solve (const ColumnVector& b, octave_idx_type& info,
double& rcon) const;
ComplexColumnVector solve (const ColumnVector& b, octave_idx_type& info,
double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
ComplexColumnVector solve (const ComplexColumnVector& b) const;
ComplexColumnVector solve (const ComplexColumnVector& b,
octave_idx_type& info) const;
ComplexColumnVector solve (const ComplexColumnVector& b,
octave_idx_type& info,
double& rcon) const;
ComplexColumnVector solve (const ComplexColumnVector& b,
octave_idx_type& info,
double& rcon,
solve_singularity_handler sing_handler,
blas_trans_type transt = blas_no_trans) const;
ComplexMatrix lssolve (const Matrix& b) const;
ComplexMatrix lssolve (const Matrix& b, octave_idx_type& info) const;
ComplexMatrix lssolve (const Matrix& b, octave_idx_type& info,
octave_idx_type& rank) const;
ComplexMatrix lssolve (const Matrix& b, octave_idx_type& info,
octave_idx_type& rank, double& rcon) const;
ComplexMatrix lssolve (const ComplexMatrix& b) const;
ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info) const;
ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info,
octave_idx_type& rank) const;
ComplexMatrix lssolve (const ComplexMatrix& b, octave_idx_type& info,
octave_idx_type& rank, double& rcon) const;
ComplexColumnVector lssolve (const ColumnVector& b) const;
ComplexColumnVector lssolve (const ColumnVector& b,
octave_idx_type& info) const;
ComplexColumnVector lssolve (const ColumnVector& b, octave_idx_type& info,
octave_idx_type& rank) const;
ComplexColumnVector lssolve (const ColumnVector& b, octave_idx_type& info,
octave_idx_type& rank, double& rcon) const;
ComplexColumnVector lssolve (const ComplexColumnVector& b) const;
ComplexColumnVector lssolve (const ComplexColumnVector& b,
octave_idx_type& info) const;
ComplexColumnVector lssolve (const ComplexColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank) const;
ComplexColumnVector lssolve (const ComplexColumnVector& b,
octave_idx_type& info,
octave_idx_type& rank, double& rcon) const;
// matrix by diagonal matrix -> matrix operations
ComplexMatrix& operator += (const DiagMatrix& a);
ComplexMatrix& operator -= (const DiagMatrix& a);
ComplexMatrix& operator += (const ComplexDiagMatrix& a);
ComplexMatrix& operator -= (const ComplexDiagMatrix& a);
// matrix by matrix -> matrix operations
ComplexMatrix& operator += (const Matrix& a);
ComplexMatrix& operator -= (const Matrix& a);
// unary operations
boolMatrix operator ! (void) const;
// other operations
bool any_element_is_nan (void) const;
bool any_element_is_inf_or_nan (void) const;
bool all_elements_are_real (void) const;
bool all_integers (double& max_val, double& min_val) const;
bool too_large_for_float (void) const;
boolMatrix all (int dim = -1) const;
boolMatrix any (int dim = -1) const;
ComplexMatrix cumprod (int dim = -1) const;
ComplexMatrix cumsum (int dim = -1) const;
ComplexMatrix prod (int dim = -1) const;
ComplexMatrix sum (int dim = -1) const;
ComplexMatrix sumsq (int dim = -1) const;
Matrix abs (void) const;
ComplexMatrix diag (octave_idx_type k = 0) const;
ComplexDiagMatrix 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;
ComplexColumnVector row_min (void) const;
ComplexColumnVector row_max (void) const;
ComplexColumnVector row_min (Array<octave_idx_type>& index) const;
ComplexColumnVector row_max (Array<octave_idx_type>& index) const;
ComplexRowVector column_min (void) const;
ComplexRowVector column_max (void) const;
ComplexRowVector column_min (Array<octave_idx_type>& index) const;
ComplexRowVector column_max (Array<octave_idx_type>& index) const;
// i/o
friend OCTAVE_API std::ostream& operator << (std::ostream& os,
const ComplexMatrix& a);
friend OCTAVE_API std::istream& operator >> (std::istream& is,
ComplexMatrix& a);
};
extern OCTAVE_API ComplexMatrix conj (const ComplexMatrix& a);
// column vector by row vector -> matrix operations
extern OCTAVE_API ComplexMatrix
operator * (const ColumnVector& a, const ComplexRowVector& b);
extern OCTAVE_API ComplexMatrix
operator * (const ComplexColumnVector& a, const RowVector& b);
extern OCTAVE_API ComplexMatrix
operator * (const ComplexColumnVector& a, const ComplexRowVector& b);
extern OCTAVE_API ComplexMatrix
Givens (const Complex&, const Complex&);
extern OCTAVE_API ComplexMatrix
Sylvester (const ComplexMatrix&, const ComplexMatrix&, const ComplexMatrix&);
extern OCTAVE_API ComplexMatrix
xgemm (const ComplexMatrix& a, const ComplexMatrix& b,
blas_trans_type transa = blas_no_trans,
blas_trans_type transb = blas_no_trans);
extern OCTAVE_API ComplexMatrix operator * (const Matrix&,
const ComplexMatrix&);
extern OCTAVE_API ComplexMatrix operator * (const ComplexMatrix&,
const Matrix&);
extern OCTAVE_API ComplexMatrix operator * (const ComplexMatrix&,
const ComplexMatrix&);
extern OCTAVE_API ComplexMatrix min (const Complex& c, const ComplexMatrix& m);
extern OCTAVE_API ComplexMatrix min (const ComplexMatrix& m, const Complex& c);
extern OCTAVE_API ComplexMatrix min (const ComplexMatrix& a,
const ComplexMatrix& b);
extern OCTAVE_API ComplexMatrix max (const Complex& c, const ComplexMatrix& m);
extern OCTAVE_API ComplexMatrix max (const ComplexMatrix& m, const Complex& c);
extern OCTAVE_API ComplexMatrix max (const ComplexMatrix& a,
const ComplexMatrix& b);
extern OCTAVE_API ComplexMatrix linspace (const ComplexColumnVector& x1,
const ComplexColumnVector& x2,
octave_idx_type n);
MS_CMP_OP_DECLS (ComplexMatrix, Complex, OCTAVE_API)
MS_BOOL_OP_DECLS (ComplexMatrix, Complex, OCTAVE_API)
SM_CMP_OP_DECLS (Complex, ComplexMatrix, OCTAVE_API)
SM_BOOL_OP_DECLS (Complex, ComplexMatrix, OCTAVE_API)
MM_CMP_OP_DECLS (ComplexMatrix, ComplexMatrix, OCTAVE_API)
MM_BOOL_OP_DECLS (ComplexMatrix, ComplexMatrix, OCTAVE_API)
MARRAY_FORWARD_DEFS (MArray, ComplexMatrix, Complex)
#endif
|