/usr/include/octave-3.8.1/octave/dSparse.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 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 500 501 502 503 504 | /*
Copyright (C) 2004-2013 David Bateman
Copyright (C) 1998-2004 Andy Adler
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_dSparse_h)
#define octave_dSparse_h 1
#include "dMatrix.h"
#include "dNDArray.h"
#include "CMatrix.h"
#include "dColVector.h"
#include "CColVector.h"
#include "DET.h"
#include "MSparse.h"
#include "MSparse-defs.h"
#include "Sparse-op-defs.h"
#include "MatrixType.h"
class PermMatrix;
class DiagMatrix;
class SparseComplexMatrix;
class SparseBoolMatrix;
class
OCTAVE_API
SparseMatrix : public MSparse<double>
{
public:
typedef void (*solve_singularity_handler) (double rcond);
SparseMatrix (void) : MSparse<double> () { }
SparseMatrix (octave_idx_type r, octave_idx_type c)
: MSparse<double> (r, c) { }
SparseMatrix (const dim_vector& dv, octave_idx_type nz = 0) :
MSparse<double> (dv, nz) { }
explicit SparseMatrix (octave_idx_type r, octave_idx_type c, double val)
: MSparse<double> (r, c, val) { }
SparseMatrix (const SparseMatrix& a) : MSparse<double> (a) { }
SparseMatrix (const SparseMatrix& a, const dim_vector& dv)
: MSparse<double> (a, dv) { }
SparseMatrix (const MSparse<double>& a) : MSparse<double> (a) { }
SparseMatrix (const Sparse<double>& a) : MSparse<double> (a) { }
explicit SparseMatrix (const SparseBoolMatrix& a);
explicit SparseMatrix (const Matrix& a) : MSparse<double> (a) { }
explicit SparseMatrix (const NDArray& a) : MSparse<double> (a) { }
SparseMatrix (const Array<double>& a, const idx_vector& r,
const idx_vector& c, octave_idx_type nr = -1,
octave_idx_type nc = -1, bool sum_terms = true,
octave_idx_type nzm = -1)
: MSparse<double> (a, r, c, nr, nc, sum_terms, nzm) { }
explicit SparseMatrix (const DiagMatrix& a);
explicit SparseMatrix (const PermMatrix& a) : MSparse<double>(a) { }
SparseMatrix (octave_idx_type r, octave_idx_type c,
octave_idx_type num_nz) : MSparse<double> (r, c, num_nz) { }
SparseMatrix& operator = (const SparseMatrix& a)
{
MSparse<double>::operator = (a);
return *this;
}
bool operator == (const SparseMatrix& a) const;
bool operator != (const SparseMatrix& a) const;
bool is_symmetric (void) const;
SparseMatrix max (int dim = -1) const;
SparseMatrix max (Array<octave_idx_type>& index, int dim = -1) const;
SparseMatrix min (int dim = -1) const;
SparseMatrix min (Array<octave_idx_type>& index, int dim = -1) const;
// destructive insert/delete/reorder operations
SparseMatrix& insert (const SparseMatrix& a, octave_idx_type r,
octave_idx_type c);
SparseMatrix& insert (const SparseMatrix& a,
const Array<octave_idx_type>& indx);
SparseMatrix concat (const SparseMatrix& rb,
const Array<octave_idx_type>& ra_idx);
SparseComplexMatrix concat (const SparseComplexMatrix& rb,
const Array<octave_idx_type>& ra_idx);
friend OCTAVE_API SparseMatrix real (const SparseComplexMatrix& a);
friend OCTAVE_API SparseMatrix imag (const SparseComplexMatrix& a);
friend OCTAVE_API SparseMatrix atan2 (const double& x, const SparseMatrix& y);
friend OCTAVE_API SparseMatrix atan2 (const SparseMatrix& x, const double& y);
friend OCTAVE_API SparseMatrix atan2 (const SparseMatrix& x,
const SparseMatrix& y);
SparseMatrix transpose (void) const
{
return MSparse<double>::transpose ();
}
SparseMatrix hermitian (void) const { return transpose (); }
// extract row or column i.
RowVector row (octave_idx_type i) const;
ColumnVector column (octave_idx_type i) const;
private:
SparseMatrix dinverse (MatrixType &mattyp, octave_idx_type& info,
double& rcond, const bool force = false,
const bool calccond = true) const;
SparseMatrix tinverse (MatrixType &mattyp, octave_idx_type& info,
double& rcond, const bool force = false,
const bool calccond = true) const;
public:
SparseMatrix inverse (void) const;
SparseMatrix inverse (MatrixType& mattype) const;
SparseMatrix inverse (MatrixType& mattype, octave_idx_type& info) const;
SparseMatrix inverse (MatrixType& mattype, octave_idx_type& info,
double& rcond, int force = 0, int calc_cond = 1) const;
DET determinant (void) const;
DET determinant (octave_idx_type& info) const;
DET determinant (octave_idx_type& info, double& rcond,
int calc_cond = 1) const;
private:
// Diagonal matrix solvers
Matrix dsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix dsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix dsolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix dsolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
// Upper triangular matrix solvers
Matrix utsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix utsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix utsolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix utsolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
// Lower triangular matrix solvers
Matrix ltsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix ltsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix ltsolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix ltsolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
// Tridiagonal matrix solvers
Matrix trisolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix trisolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix trisolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix trisolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
// Banded matrix solvers (umfpack/cholesky)
Matrix bsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix bsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix bsolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix bsolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
// Full matrix solvers (umfpack/cholesky)
void * factorize (octave_idx_type& err, double &rcond, Matrix &Control,
Matrix &Info, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
Matrix fsolve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool calc_cond = false) const;
ComplexMatrix fsolve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseMatrix fsolve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
SparseComplexMatrix fsolve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool calc_cond = false) const;
public:
// Generic interface to solver with no probing of type
Matrix solve (MatrixType &typ, const Matrix& b) const;
Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info) const;
Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond) const;
Matrix solve (MatrixType &typ, const Matrix& b, octave_idx_type& info,
double& rcond, solve_singularity_handler sing_handler,
bool singular_fallback = true) 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& rcond) const;
ComplexMatrix solve (MatrixType &typ, const ComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool singular_fallback = true) const;
SparseMatrix solve (MatrixType &typ, const SparseMatrix& b) const;
SparseMatrix solve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info) const;
SparseMatrix solve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond) const;
SparseMatrix solve (MatrixType &typ, const SparseMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool singular_fallback = true) const;
SparseComplexMatrix solve (MatrixType &typ,
const SparseComplexMatrix& b) const;
SparseComplexMatrix solve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info) const;
SparseComplexMatrix solve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond) const;
SparseComplexMatrix solve (MatrixType &typ, const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler,
bool singular_fallabck = true) const;
ColumnVector solve (MatrixType &typ, const ColumnVector& b) const;
ColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info) const;
ColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info, double& rcond) const;
ColumnVector solve (MatrixType &typ, const ColumnVector& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler) 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& rcond) const;
ComplexColumnVector solve (MatrixType &typ, const ComplexColumnVector& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler) const;
// Generic interface to solver with probing of type
Matrix solve (const Matrix& b) const;
Matrix solve (const Matrix& b, octave_idx_type& info) const;
Matrix solve (const Matrix& b, octave_idx_type& info, double& rcond) const;
Matrix solve (const Matrix& b, octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler) 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& rcond) const;
ComplexMatrix solve (const ComplexMatrix& b, octave_idx_type& info,
double& rcond,
solve_singularity_handler sing_handler) const;
SparseMatrix solve (const SparseMatrix& b) const;
SparseMatrix solve (const SparseMatrix& b, octave_idx_type& info) const;
SparseMatrix solve (const SparseMatrix& b, octave_idx_type& info,
double& rcond) const;
SparseMatrix solve (const SparseMatrix& b, octave_idx_type& info,
double& rcond,
solve_singularity_handler sing_handler) const;
SparseComplexMatrix solve (const SparseComplexMatrix& b) const;
SparseComplexMatrix solve (const SparseComplexMatrix& b,
octave_idx_type& info) const;
SparseComplexMatrix solve (const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond) const;
SparseComplexMatrix solve (const SparseComplexMatrix& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler) const;
ColumnVector solve (const ColumnVector& b) const;
ColumnVector solve (const ColumnVector& b, octave_idx_type& info) const;
ColumnVector solve (const ColumnVector& b, octave_idx_type& info,
double& rcond) const;
ColumnVector solve (const ColumnVector& b, octave_idx_type& info,
double& rcond,
solve_singularity_handler sing_handler) 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& rcond) const;
ComplexColumnVector solve (const ComplexColumnVector& b,
octave_idx_type& info, double& rcond,
solve_singularity_handler sing_handler) const;
// other operations
bool any_element_is_negative (bool = false) const;
bool any_element_is_nan (void) const;
bool any_element_is_inf_or_nan (void) const;
bool any_element_not_one_or_zero (void) const;
bool all_elements_are_zero (void) const;
bool all_elements_are_int_or_inf_or_nan (void) const;
bool all_integers (double& max_val, double& min_val) const;
bool too_large_for_float (void) const;
SparseBoolMatrix operator ! (void) const;
SparseBoolMatrix all (int dim = -1) const;
SparseBoolMatrix any (int dim = -1) const;
SparseMatrix cumprod (int dim = -1) const;
SparseMatrix cumsum (int dim = -1) const;
SparseMatrix prod (int dim = -1) const;
SparseMatrix sum (int dim = -1) const;
SparseMatrix sumsq (int dim = -1) const;
SparseMatrix abs (void) const;
SparseMatrix diag (octave_idx_type k = 0) const;
Matrix matrix_value (void) const;
SparseMatrix squeeze (void) const;
SparseMatrix reshape (const dim_vector& new_dims) const;
SparseMatrix permute (const Array<octave_idx_type>& vec,
bool inv = false) const;
SparseMatrix ipermute (const Array<octave_idx_type>& vec) const;
// i/o
friend OCTAVE_API std::ostream& operator << (std::ostream& os,
const SparseMatrix& a);
friend OCTAVE_API std::istream& operator >> (std::istream& is,
SparseMatrix& a);
};
// Publish externally used friend functions.
extern OCTAVE_API SparseMatrix real (const SparseComplexMatrix& a);
extern OCTAVE_API SparseMatrix imag (const SparseComplexMatrix& a);
// Other operators.
extern OCTAVE_API SparseMatrix operator * (const SparseMatrix& a,
const SparseMatrix& b);
extern OCTAVE_API Matrix operator * (const Matrix& a,
const SparseMatrix& b);
extern OCTAVE_API Matrix mul_trans (const Matrix& a,
const SparseMatrix& b);
extern OCTAVE_API Matrix operator * (const SparseMatrix& a,
const Matrix& b);
extern OCTAVE_API Matrix trans_mul (const SparseMatrix& a,
const Matrix& b);
extern OCTAVE_API SparseMatrix operator * (const DiagMatrix&,
const SparseMatrix&);
extern OCTAVE_API SparseMatrix operator * (const SparseMatrix&,
const DiagMatrix&);
extern OCTAVE_API SparseMatrix operator + (const DiagMatrix&,
const SparseMatrix&);
extern OCTAVE_API SparseMatrix operator + (const SparseMatrix&,
const DiagMatrix&);
extern OCTAVE_API SparseMatrix operator - (const DiagMatrix&,
const SparseMatrix&);
extern OCTAVE_API SparseMatrix operator - (const SparseMatrix&,
const DiagMatrix&);
extern OCTAVE_API SparseMatrix operator * (const PermMatrix&,
const SparseMatrix&);
extern OCTAVE_API SparseMatrix operator * (const SparseMatrix&,
const PermMatrix&);
extern OCTAVE_API SparseMatrix min (double d, const SparseMatrix& m);
extern OCTAVE_API SparseMatrix min (const SparseMatrix& m, double d);
extern OCTAVE_API SparseMatrix min (const SparseMatrix& a,
const SparseMatrix& b);
extern OCTAVE_API SparseMatrix max (double d, const SparseMatrix& m);
extern OCTAVE_API SparseMatrix max (const SparseMatrix& m, double d);
extern OCTAVE_API SparseMatrix max (const SparseMatrix& a,
const SparseMatrix& b);
SPARSE_SMS_CMP_OP_DECLS (SparseMatrix, double, OCTAVE_API)
SPARSE_SMS_BOOL_OP_DECLS (SparseMatrix, double, OCTAVE_API)
SPARSE_SSM_CMP_OP_DECLS (double, SparseMatrix, OCTAVE_API)
SPARSE_SSM_BOOL_OP_DECLS (double, SparseMatrix, OCTAVE_API)
SPARSE_SMSM_CMP_OP_DECLS (SparseMatrix, SparseMatrix, OCTAVE_API)
SPARSE_SMSM_BOOL_OP_DECLS (SparseMatrix, SparseMatrix, OCTAVE_API)
SPARSE_FORWARD_DEFS (MSparse, SparseMatrix, Matrix, double)
#ifdef USE_64_BIT_IDX_T
#define UMFPACK_DNAME(name) umfpack_dl_ ## name
#else
#define UMFPACK_DNAME(name) umfpack_di_ ## name
#endif
#endif
|