GNU Octave 11.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 
Loading...
Searching...
No Matches
dSparse.h
Go to the documentation of this file.
1////////////////////////////////////////////////////////////////////////
2//
3// Copyright (C) 1998-2026 The Octave Project Developers
4//
5// See the file COPYRIGHT.md in the top-level directory of this
6// distribution or <https://octave.org/copyright/>.
7//
8// This file is part of Octave.
9//
10// Octave is free software: you can redistribute it and/or modify it
11// under the terms of the GNU General Public License as published by
12// the Free Software Foundation, either version 3 of the License, or
13// (at your option) any later version.
14//
15// Octave is distributed in the hope that it will be useful, but
16// WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19//
20// You should have received a copy of the GNU General Public License
21// along with Octave; see the file COPYING. If not, see
22// <https://www.gnu.org/licenses/>.
23//
24////////////////////////////////////////////////////////////////////////
25
26#if ! defined (octave_dSparse_h)
27#define octave_dSparse_h 1
28
29#include "octave-config.h"
30
31#include "mx-fwd.h"
32
33#include "CColVector.h"
34#include "CMatrix.h"
35#include "DET.h"
36#include "MSparse.h"
37#include "MatrixType.h"
38#include "Sparse-op-decls.h"
39#include "dColVector.h"
40#include "dMatrix.h"
41#include "dNDArray.h"
42
43class SparseMatrix : public MSparse<double>
44{
45public:
46
47 // Corresponding dense matrix type for this sparse matrix type.
48 typedef Matrix dense_matrix_type;
49
50 typedef void (*solve_singularity_handler) (double rcond);
51
52 SparseMatrix () : MSparse<double> () { }
53
56
57 SparseMatrix (const dim_vector& dv, octave_idx_type nz = 0) :
58 MSparse<double> (dv, nz) { }
59
60 explicit SparseMatrix (octave_idx_type r, octave_idx_type c, double val)
61 : MSparse<double> (r, c, val) { }
62
63 SparseMatrix (const SparseMatrix& a) : MSparse<double> (a) { }
64
65 SparseMatrix (const SparseMatrix& a, const dim_vector& dv)
66 : MSparse<double> (a, dv) { }
67
68 SparseMatrix (const MSparse<double>& a) : MSparse<double> (a) { }
69
70 SparseMatrix (const Sparse<double>& a) : MSparse<double> (a) { }
71
72 explicit OCTAVE_API SparseMatrix (const SparseBoolMatrix& a);
73
74 explicit SparseMatrix (const Matrix& a) : MSparse<double> (a) { }
75
76 explicit SparseMatrix (const NDArray& a) : MSparse<double> (a) { }
77
78 SparseMatrix (const Array<double>& a, const octave::idx_vector& r,
79 const octave::idx_vector& c, octave_idx_type nr = -1,
80 octave_idx_type nc = -1, bool sum_terms = true,
81 octave_idx_type nzm = -1)
82 : MSparse<double> (a, r, c, nr, nc, sum_terms, nzm) { }
83
84 explicit OCTAVE_API SparseMatrix (const DiagMatrix& a);
85
86 explicit SparseMatrix (const PermMatrix& a) : MSparse<double> (a) { }
87
90
91 SparseMatrix& operator = (const SparseMatrix& a)
92 {
93 MSparse<double>::operator = (a);
94 return *this;
95 }
96
97 ~SparseMatrix () = default;
98
99 OCTAVE_API bool operator == (const SparseMatrix& a) const;
100 OCTAVE_API bool operator != (const SparseMatrix& a) const;
101
102 OCTAVE_API bool issymmetric () const;
103
104 OCTAVE_API SparseMatrix
105 max (int dim = -1, bool nanflag = true, bool realabs = true) const;
106 OCTAVE_API SparseMatrix
107 max (Array<octave_idx_type>& index, int dim = -1,
108 bool nanflag = true, bool realabs = true) const;
109 OCTAVE_API SparseMatrix
110 min (int dim = -1, bool nanflag = true, bool realabs = true) const;
111 OCTAVE_API SparseMatrix
112 min (Array<octave_idx_type>& index, int dim = -1,
113 bool nanflag = true, bool realabs = true) const;
114
115 // destructive insert/delete/reorder operations
116
117 OCTAVE_API SparseMatrix&
118 insert (const SparseMatrix& a, octave_idx_type r, octave_idx_type c);
119
120 OCTAVE_API SparseMatrix&
121 insert (const SparseMatrix& a, const Array<octave_idx_type>& indx);
122
123 OCTAVE_API SparseMatrix
124 concat (const SparseMatrix& rb, const Array<octave_idx_type>& ra_idx);
125 OCTAVE_API SparseComplexMatrix
126 concat (const SparseComplexMatrix& rb, const Array<octave_idx_type>& ra_idx);
127
128 friend OCTAVE_API SparseMatrix real (const SparseComplexMatrix& a);
129 friend OCTAVE_API SparseMatrix imag (const SparseComplexMatrix& a);
130
131 SparseMatrix transpose () const
132 {
133 return MSparse<double>::transpose ();
134 }
135 SparseMatrix hermitian () const { return transpose (); }
136
137 // extract row or column i.
138
139 OCTAVE_API RowVector row (octave_idx_type i) const;
140
141 OCTAVE_API ColumnVector column (octave_idx_type i) const;
142
143private:
144 OCTAVE_API SparseMatrix
145 dinverse (MatrixType& mattype, octave_idx_type& info, double& rcond,
146 const bool force = false, const bool calccond = true) const;
147
148 OCTAVE_API SparseMatrix
149 tinverse (MatrixType& mattype, octave_idx_type& info, double& rcond,
150 const bool force = false, const bool calccond = true) const;
151
152public:
153 OCTAVE_API SparseMatrix inverse () const;
154 OCTAVE_API SparseMatrix inverse (MatrixType& mattype) const;
155 OCTAVE_API SparseMatrix
156 inverse (MatrixType& mattype, octave_idx_type& info) const;
157 OCTAVE_API SparseMatrix
158 inverse (MatrixType& mattype, octave_idx_type& info, double& rcond,
159 bool force = false, bool calc_cond = true) const;
160
161 OCTAVE_API DET determinant () const;
162 OCTAVE_API DET determinant (octave_idx_type& info) const;
163 OCTAVE_API DET determinant (octave_idx_type& info, double& rcond,
164 bool calc_cond = true) const;
165
166private:
167 // Diagonal matrix solvers
168 OCTAVE_API Matrix
169 dsolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
170 double& rcond, solve_singularity_handler sing_handler,
171 bool calc_cond = false) const;
172
173 OCTAVE_API ComplexMatrix
174 dsolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
175 double& rcond, solve_singularity_handler sing_handler,
176 bool calc_cond = false) const;
177
178 OCTAVE_API SparseMatrix
179 dsolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
180 double& rcond, solve_singularity_handler sing_handler,
181 bool calc_cond = false) const;
182
183 OCTAVE_API SparseComplexMatrix
184 dsolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
185 double& rcond, solve_singularity_handler sing_handler,
186 bool calc_cond = false) const;
187
188 // Upper triangular matrix solvers
189 OCTAVE_API Matrix
190 utsolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
191 double& rcond, solve_singularity_handler sing_handler,
192 bool calc_cond = false) const;
193
194 OCTAVE_API ComplexMatrix
195 utsolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
196 double& rcond, solve_singularity_handler sing_handler,
197 bool calc_cond = false) const;
198
199 OCTAVE_API SparseMatrix
200 utsolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
201 double& rcond, solve_singularity_handler sing_handler,
202 bool calc_cond = false) const;
203
204 OCTAVE_API SparseComplexMatrix
205 utsolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
206 double& rcond, solve_singularity_handler sing_handler,
207 bool calc_cond = false) const;
208
209 // Lower triangular matrix solvers
210 OCTAVE_API Matrix
211 ltsolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
212 double& rcond, solve_singularity_handler sing_handler,
213 bool calc_cond = false) const;
214
215 OCTAVE_API ComplexMatrix
216 ltsolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
217 double& rcond, solve_singularity_handler sing_handler,
218 bool calc_cond = false) const;
219
220 OCTAVE_API SparseMatrix
221 ltsolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
222 double& rcond, solve_singularity_handler sing_handler,
223 bool calc_cond = false) const;
224
225 OCTAVE_API SparseComplexMatrix
226 ltsolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
227 double& rcond, solve_singularity_handler sing_handler,
228 bool calc_cond = false) const;
229
230 // Tridiagonal matrix solvers
231 OCTAVE_API Matrix
232 trisolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
233 double& rcond, solve_singularity_handler sing_handler,
234 bool calc_cond = false) const;
235
236 OCTAVE_API ComplexMatrix
237 trisolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
238 double& rcond, solve_singularity_handler sing_handler,
239 bool calc_cond = false) const;
240
241 OCTAVE_API SparseMatrix
242 trisolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
243 double& rcond, solve_singularity_handler sing_handler,
244 bool calc_cond = false) const;
245
246 OCTAVE_API SparseComplexMatrix
247 trisolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
248 double& rcond, solve_singularity_handler sing_handler,
249 bool calc_cond = false) const;
250
251 // Banded matrix solvers (umfpack/cholesky)
252 OCTAVE_API Matrix
253 bsolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
254 double& rcond, solve_singularity_handler sing_handler,
255 bool calc_cond = false) const;
256
257 OCTAVE_API ComplexMatrix
258 bsolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
259 double& rcond, solve_singularity_handler sing_handler,
260 bool calc_cond = false) const;
261
262 OCTAVE_API SparseMatrix
263 bsolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
264 double& rcond, solve_singularity_handler sing_handler,
265 bool calc_cond = false) const;
266
267 OCTAVE_API SparseComplexMatrix
268 bsolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
269 double& rcond, solve_singularity_handler sing_handler,
270 bool calc_cond = false) const;
271
272 // Full matrix solvers (umfpack/cholesky)
273 OCTAVE_API void *
274 factorize (octave_idx_type& err, double& rcond, Matrix& Control,
275 Matrix& Info, solve_singularity_handler sing_handler,
276 bool calc_cond = false) const;
277
278 OCTAVE_API Matrix
279 fsolve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
280 double& rcond, solve_singularity_handler sing_handler,
281 bool calc_cond = false) const;
282
283 OCTAVE_API ComplexMatrix
284 fsolve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
285 double& rcond, solve_singularity_handler sing_handler,
286 bool calc_cond = false) const;
287
288 OCTAVE_API SparseMatrix
289 fsolve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
290 double& rcond, solve_singularity_handler sing_handler,
291 bool calc_cond = false) const;
292
293 OCTAVE_API SparseComplexMatrix
294 fsolve (MatrixType& typ, const SparseComplexMatrix& b, octave_idx_type& info,
295 double& rcond, solve_singularity_handler sing_handler,
296 bool calc_cond = false) const;
297
298public:
299 // Generic interface to solver with no probing of type
300 OCTAVE_API Matrix solve (MatrixType& typ, const Matrix& b) const;
301 OCTAVE_API Matrix
302 solve (MatrixType& typ, const Matrix& b, octave_idx_type& info) const;
303 OCTAVE_API Matrix
304 solve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
305 double& rcond) const;
306 OCTAVE_API Matrix
307 solve (MatrixType& typ, const Matrix& b, octave_idx_type& info,
308 double& rcond, solve_singularity_handler sing_handler,
309 bool singular_fallback = true) const;
310
311 OCTAVE_API ComplexMatrix
312 solve (MatrixType& typ, const ComplexMatrix& b) const;
313 OCTAVE_API ComplexMatrix
314 solve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info) const;
315 OCTAVE_API ComplexMatrix
316 solve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
317 double& rcond) const;
318 OCTAVE_API ComplexMatrix
319 solve (MatrixType& typ, const ComplexMatrix& b, octave_idx_type& info,
320 double& rcond, solve_singularity_handler sing_handler,
321 bool singular_fallback = true) const;
322
323 OCTAVE_API SparseMatrix solve (MatrixType& typ, const SparseMatrix& b) const;
324 OCTAVE_API SparseMatrix
325 solve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info) const;
326 OCTAVE_API SparseMatrix
327 solve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
328 double& rcond) const;
329 OCTAVE_API SparseMatrix
330 solve (MatrixType& typ, const SparseMatrix& b, octave_idx_type& info,
331 double& rcond, solve_singularity_handler sing_handler,
332 bool singular_fallback = true) const;
333
334 OCTAVE_API SparseComplexMatrix
335 solve (MatrixType& typ, const SparseComplexMatrix& b) const;
336 OCTAVE_API SparseComplexMatrix
337 solve (MatrixType& typ, const SparseComplexMatrix& b,
338 octave_idx_type& info) const;
339 OCTAVE_API SparseComplexMatrix
340 solve (MatrixType& typ, const SparseComplexMatrix& b,
341 octave_idx_type& info, double& rcond) const;
342 OCTAVE_API SparseComplexMatrix
343 solve (MatrixType& typ, const SparseComplexMatrix& b,
344 octave_idx_type& info, double& rcond,
345 solve_singularity_handler sing_handler,
346 bool singular_fallabck = true) const;
347
348 OCTAVE_API ColumnVector solve (MatrixType& typ, const ColumnVector& b) const;
349 OCTAVE_API ColumnVector
350 solve (MatrixType& typ, const ColumnVector& b, octave_idx_type& info) const;
351 OCTAVE_API ColumnVector
352 solve (MatrixType& typ, const ColumnVector& b, octave_idx_type& info,
353 double& rcond) const;
354 OCTAVE_API ColumnVector
355 solve (MatrixType& typ, const ColumnVector& b, octave_idx_type& info,
356 double& rcond, solve_singularity_handler sing_handler) const;
357
358 OCTAVE_API ComplexColumnVector
359 solve (MatrixType& typ, const ComplexColumnVector& b) const;
360 OCTAVE_API ComplexColumnVector
361 solve (MatrixType& typ, const ComplexColumnVector& b,
362 octave_idx_type& info) const;
363 OCTAVE_API ComplexColumnVector
364 solve (MatrixType& typ, const ComplexColumnVector& b,
365 octave_idx_type& info, double& rcond) const;
366 OCTAVE_API ComplexColumnVector
367 solve (MatrixType& typ, const ComplexColumnVector& b,
368 octave_idx_type& info, double& rcond,
369 solve_singularity_handler sing_handler) const;
370
371 // Generic interface to solver with probing of type
372 OCTAVE_API Matrix solve (const Matrix& b) const;
373 OCTAVE_API Matrix solve (const Matrix& b, octave_idx_type& info) const;
374 OCTAVE_API Matrix
375 solve (const Matrix& b, octave_idx_type& info, double& rcond) const;
376 OCTAVE_API Matrix
377 solve (const Matrix& b, octave_idx_type& info, double& rcond,
378 solve_singularity_handler sing_handler) const;
379
380 OCTAVE_API ComplexMatrix solve (const ComplexMatrix& b) const;
381 OCTAVE_API ComplexMatrix
382 solve (const ComplexMatrix& b, octave_idx_type& info) const;
383 OCTAVE_API ComplexMatrix
384 solve (const ComplexMatrix& b, octave_idx_type& info, double& rcond) const;
385 OCTAVE_API ComplexMatrix
386 solve (const ComplexMatrix& b, octave_idx_type& info, double& rcond,
387 solve_singularity_handler sing_handler) const;
388
389 OCTAVE_API SparseMatrix solve (const SparseMatrix& b) const;
390 OCTAVE_API SparseMatrix
391 solve (const SparseMatrix& b, octave_idx_type& info) const;
392 OCTAVE_API SparseMatrix
393 solve (const SparseMatrix& b, octave_idx_type& info, double& rcond) const;
394 OCTAVE_API SparseMatrix
395 solve (const SparseMatrix& b, octave_idx_type& info, double& rcond,
396 solve_singularity_handler sing_handler) const;
397
398 OCTAVE_API SparseComplexMatrix solve (const SparseComplexMatrix& b) const;
399 OCTAVE_API SparseComplexMatrix
400 solve (const SparseComplexMatrix& b, octave_idx_type& info) const;
401 OCTAVE_API SparseComplexMatrix
402 solve (const SparseComplexMatrix& b, octave_idx_type& info,
403 double& rcond) const;
404 OCTAVE_API SparseComplexMatrix
405 solve (const SparseComplexMatrix& b, octave_idx_type& info,
406 double& rcond, solve_singularity_handler sing_handler) const;
407
408 OCTAVE_API ColumnVector solve (const ColumnVector& b) const;
409 OCTAVE_API ColumnVector
410 solve (const ColumnVector& b, octave_idx_type& info) const;
411 OCTAVE_API ColumnVector
412 solve (const ColumnVector& b, octave_idx_type& info, double& rcond) const;
413 OCTAVE_API ColumnVector
414 solve (const ColumnVector& b, octave_idx_type& info, double& rcond,
415 solve_singularity_handler sing_handler) const;
416
417 OCTAVE_API ComplexColumnVector solve (const ComplexColumnVector& b) const;
418 OCTAVE_API ComplexColumnVector
419 solve (const ComplexColumnVector& b, octave_idx_type& info) const;
420 OCTAVE_API ComplexColumnVector
421 solve (const ComplexColumnVector& b, octave_idx_type& info,
422 double& rcond) const;
423 OCTAVE_API ComplexColumnVector
424 solve (const ComplexColumnVector& b, octave_idx_type& info,
425 double& rcond, solve_singularity_handler sing_handler) const;
426
427 // other operations
428
429 OCTAVE_API bool any_element_is_negative (bool = false) const;
430 OCTAVE_API bool any_element_is_nan () const;
431 OCTAVE_API bool any_element_is_inf_or_nan () const;
432 OCTAVE_API bool any_element_not_one_or_zero () const;
433 OCTAVE_API bool all_elements_are_zero () const;
434 OCTAVE_API bool all_elements_are_int_or_inf_or_nan () const;
435 OCTAVE_API bool all_integers (double& max_val, double& min_val) const;
436 OCTAVE_API bool too_large_for_float () const;
437
438 OCTAVE_API SparseBoolMatrix operator ! () const;
439
440 OCTAVE_API SparseBoolMatrix all (int dim = -1) const;
441 OCTAVE_API SparseBoolMatrix any (int dim = -1) const;
442
443 OCTAVE_API SparseMatrix cumprod (int dim = -1, bool nanflag = false) const;
444 OCTAVE_API SparseMatrix cumsum (int dim = -1, bool nanflag = false) const;
445 OCTAVE_API SparseMatrix prod (int dim = -1, bool nanflag = false) const;
446 OCTAVE_API SparseMatrix sum (int dim = -1, bool nanflag = false) const;
447 OCTAVE_API SparseMatrix xsum (int dim = -1, bool nanflag = false) const;
448 OCTAVE_API SparseMatrix sumsq (int dim = -1, bool nanflag = false) const;
449 OCTAVE_API SparseMatrix abs () const;
450
451 OCTAVE_API SparseMatrix diag (octave_idx_type k = 0) const;
452
453 OCTAVE_API Matrix matrix_value () const;
454
455 OCTAVE_API SparseMatrix squeeze () const;
456
457 OCTAVE_API SparseMatrix reshape (const dim_vector& new_dims) const;
458
459 OCTAVE_API SparseMatrix
460 permute (const Array<octave_idx_type>& vec, bool inv = false) const;
461
462 OCTAVE_API SparseMatrix ipermute (const Array<octave_idx_type>& vec) const;
463
464 // i/o
465
466 friend OCTAVE_API std::ostream& operator << (std::ostream& os,
467 const SparseMatrix& a);
468 friend OCTAVE_API std::istream& operator >> (std::istream& is,
469 SparseMatrix& a);
470
471};
472
473// Publish externally used friend functions.
474
475extern OCTAVE_API SparseMatrix real (const SparseComplexMatrix& a);
476extern OCTAVE_API SparseMatrix imag (const SparseComplexMatrix& a);
477
478// Other operators.
479
480extern OCTAVE_API SparseMatrix operator * (const SparseMatrix& a,
481 const SparseMatrix& b);
482extern OCTAVE_API Matrix operator * (const Matrix& a,
483 const SparseMatrix& b);
484extern OCTAVE_API Matrix mul_trans (const Matrix& a,
485 const SparseMatrix& b);
486extern OCTAVE_API Matrix operator * (const SparseMatrix& a,
487 const Matrix& b);
488extern OCTAVE_API Matrix trans_mul (const SparseMatrix& a,
489 const Matrix& b);
490
491extern OCTAVE_API SparseMatrix operator * (const DiagMatrix&,
492 const SparseMatrix&);
493extern OCTAVE_API SparseMatrix operator * (const SparseMatrix&,
494 const DiagMatrix&);
495
496extern OCTAVE_API SparseMatrix operator + (const DiagMatrix&,
497 const SparseMatrix&);
498extern OCTAVE_API SparseMatrix operator + (const SparseMatrix&,
499 const DiagMatrix&);
500extern OCTAVE_API SparseMatrix operator - (const DiagMatrix&,
501 const SparseMatrix&);
502extern OCTAVE_API SparseMatrix operator - (const SparseMatrix&,
503 const DiagMatrix&);
504
505extern OCTAVE_API SparseMatrix operator * (const PermMatrix&,
506 const SparseMatrix&);
507extern OCTAVE_API SparseMatrix operator * (const SparseMatrix&,
508 const PermMatrix&);
509
510extern OCTAVE_API SparseMatrix min (double d, const SparseMatrix& m);
511extern OCTAVE_API SparseMatrix min (double d, const SparseMatrix& m,
512 const bool nanflag);
513extern OCTAVE_API SparseMatrix min (double d, const SparseMatrix& m,
514 const bool nanflag, const bool realabs);
515extern OCTAVE_API SparseMatrix min (const SparseMatrix& m, double d);
516extern OCTAVE_API SparseMatrix min (const SparseMatrix& m, double d,
517 const bool nanflag);
518extern OCTAVE_API SparseMatrix min (const SparseMatrix& m, double d,
519 const bool nanflag, const bool realabs);
520extern OCTAVE_API SparseMatrix min (const SparseMatrix& a,
521 const SparseMatrix& b);
522extern OCTAVE_API SparseMatrix min (const SparseMatrix& a,
523 const SparseMatrix& b, const bool nanflag);
524extern OCTAVE_API SparseMatrix min (const SparseMatrix& a,
525 const SparseMatrix& b,
526 const bool nanflag, const bool realabs);
527
528extern OCTAVE_API SparseMatrix max (double d, const SparseMatrix& m);
529extern OCTAVE_API SparseMatrix max (double d, const SparseMatrix& m,
530 const bool nanflag);
531extern OCTAVE_API SparseMatrix max (double d, const SparseMatrix& m,
532 const bool nanflag, const bool realabs);
533extern OCTAVE_API SparseMatrix max (const SparseMatrix& m, double d);
534extern OCTAVE_API SparseMatrix max (const SparseMatrix& m, double d,
535 const bool nanflag);
536extern OCTAVE_API SparseMatrix max (const SparseMatrix& m, double d,
537 const bool nanflag, const bool realabs);
538extern OCTAVE_API SparseMatrix max (const SparseMatrix& a,
539 const SparseMatrix& b);
540extern OCTAVE_API SparseMatrix max (const SparseMatrix& a,
541 const SparseMatrix& b, const bool nanflag);
542extern OCTAVE_API SparseMatrix max (const SparseMatrix& a,
543 const SparseMatrix& b,
544 const bool nanflag, const bool realabs);
545
546SPARSE_SMS_CMP_OP_DECLS (SparseMatrix, double, OCTAVE_API)
547SPARSE_SMS_BOOL_OP_DECLS (SparseMatrix, double, OCTAVE_API)
548
549SPARSE_SSM_CMP_OP_DECLS (double, SparseMatrix, OCTAVE_API)
550SPARSE_SSM_BOOL_OP_DECLS (double, SparseMatrix, OCTAVE_API)
551
552SPARSE_SMSM_CMP_OP_DECLS (SparseMatrix, SparseMatrix, OCTAVE_API)
553SPARSE_SMSM_BOOL_OP_DECLS (SparseMatrix, SparseMatrix, OCTAVE_API)
554
555SPARSE_FORWARD_DEFS (MSparse, SparseMatrix, Matrix, double)
556
557#endif
SPARSE_FORWARD_DEFS
#define SPARSE_FORWARD_DEFS(B, R, F, T)
Definition MSparse.h:192
SPARSE_SMSM_CMP_OP_DECLS
#define SPARSE_SMSM_CMP_OP_DECLS(M1, M2, API)
Definition Sparse-op-decls.h:111
SPARSE_SMSM_BOOL_OP_DECLS
#define SPARSE_SMSM_BOOL_OP_DECLS(M1, M2, API)
Definition Sparse-op-decls.h:123
SPARSE_SSM_CMP_OP_DECLS
#define SPARSE_SSM_CMP_OP_DECLS(S, M, API)
Definition Sparse-op-decls.h:82
SPARSE_SMS_BOOL_OP_DECLS
#define SPARSE_SMS_BOOL_OP_DECLS(M, S, API)
Definition Sparse-op-decls.h:65
SPARSE_SSM_BOOL_OP_DECLS
#define SPARSE_SSM_BOOL_OP_DECLS(S, M, API)
Definition Sparse-op-decls.h:94
SPARSE_SMS_CMP_OP_DECLS
#define SPARSE_SMS_CMP_OP_DECLS(M, S, API)
Definition Sparse-op-decls.h:53
Array
N Dimensional Array with copy-on-write semantics.
Definition Array-base.h:130
MSparse::transpose
MSparse< T > transpose() const
Definition MSparse.h:96
MSparse::operator=
MSparse< T > & operator=(const MSparse< T > &a)
Definition MSparse.h:78
SparseMatrix::insert
SparseMatrix & insert(const SparseMatrix &a, octave_idx_type r, octave_idx_type c)
Definition dSparse.cc:168
SparseMatrix::squeeze
SparseMatrix squeeze() const
Definition dSparse.cc:7735
SparseMatrix::min
SparseMatrix min(int dim=-1, bool nanflag=true, bool realabs=true) const
Definition dSparse.cc:439
SparseMatrix::issymmetric
bool issymmetric() const
Definition dSparse.cc:128
SparseMatrix::any_element_not_one_or_zero
bool any_element_not_one_or_zero() const
Definition dSparse.cc:7429
SparseMatrix::reshape
SparseMatrix reshape(const dim_vector &new_dims) const
Definition dSparse.cc:7741
SparseMatrix::any
SparseBoolMatrix any(int dim=-1) const
Definition dSparse.cc:7553
SparseMatrix::any_element_is_inf_or_nan
bool any_element_is_inf_or_nan() const
Definition dSparse.cc:7414
SparseMatrix::cumprod
SparseMatrix cumprod(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7560
SparseMatrix::all_integers
bool all_integers(double &max_val, double &min_val) const
Definition dSparse.cc:7476
SparseMatrix::any_element_is_nan
bool any_element_is_nan() const
Definition dSparse.cc:7399
SparseMatrix::too_large_for_float
bool too_large_for_float() const
Definition dSparse.cc:7504
SparseMatrix::operator==
bool operator==(const SparseMatrix &a) const
Definition dSparse.cc:98
SparseMatrix::max
SparseMatrix max(int dim=-1, bool nanflag=true, bool realabs=true) const
Definition dSparse.cc:183
SparseMatrix::transpose
SparseMatrix transpose() const
Definition dSparse.h:131
SparseMatrix::SparseMatrix
SparseMatrix(const Sparse< double > &a)
Definition dSparse.h:70
SparseMatrix::determinant
DET determinant() const
Definition dSparse.cc:1227
SparseMatrix::abs
SparseMatrix abs() const
Definition dSparse.cc:7681
SparseMatrix::prod
SparseMatrix prod(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7588
SparseMatrix::inverse
SparseMatrix inverse() const
Definition dSparse.cc:818
SparseMatrix::operator!=
bool operator!=(const SparseMatrix &a) const
Definition dSparse.cc:122
SparseMatrix::row
RowVector row(octave_idx_type i) const
Definition dSparse.cc:710
SparseMatrix::sum
SparseMatrix sum(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7619
SparseMatrix::solve
ComplexMatrix solve(const ComplexMatrix &b) const
SparseMatrix::real
friend SparseMatrix real(const SparseComplexMatrix &a)
Definition dSparse.cc:761
SparseMatrix::diag
SparseMatrix diag(octave_idx_type k=0) const
Definition dSparse.cc:7694
SparseMatrix::SparseMatrix
SparseMatrix(const SparseMatrix &a, const dim_vector &dv)
Definition dSparse.h:65
SparseMatrix::all_elements_are_zero
bool all_elements_are_zero() const
Definition dSparse.cc:7444
SparseMatrix::~SparseMatrix
~SparseMatrix()=default
SparseMatrix::all
SparseBoolMatrix all(int dim=-1) const
Definition dSparse.cc:7546
SparseMatrix::xsum
SparseMatrix xsum(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7645
SparseMatrix::SparseMatrix
SparseMatrix(const SparseMatrix &a)
Definition dSparse.h:63
SparseMatrix::sumsq
SparseMatrix sumsq(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7653
SparseMatrix::permute
SparseMatrix permute(const Array< octave_idx_type > &vec, bool inv=false) const
Definition dSparse.cc:7747
SparseMatrix::SparseMatrix
SparseMatrix(octave_idx_type r, octave_idx_type c)
Definition dSparse.h:54
SparseMatrix::column
ColumnVector column(octave_idx_type i) const
Definition dSparse.cc:729
SparseMatrix::concat
SparseMatrix concat(const SparseMatrix &rb, const Array< octave_idx_type > &ra_idx)
Definition dSparse.cc:741
SparseMatrix::SparseMatrix
SparseMatrix(const MSparse< double > &a)
Definition dSparse.h:68
SparseMatrix::cumsum
SparseMatrix cumsum(int dim=-1, bool nanflag=false) const
Definition dSparse.cc:7568
SparseMatrix::solve_singularity_handler
void(* solve_singularity_handler)(double rcond)
Definition dSparse.h:50
SparseMatrix::ipermute
SparseMatrix ipermute(const Array< octave_idx_type > &vec) const
Definition dSparse.cc:7753
SparseMatrix::dense_matrix_type
Matrix dense_matrix_type
Definition dSparse.h:48
SparseMatrix::operator!
SparseBoolMatrix operator!() const
Definition dSparse.cc:7510
SparseMatrix::SparseMatrix
SparseMatrix(const Array< double > &a, const octave::idx_vector &r, const octave::idx_vector &c, octave_idx_type nr=-1, octave_idx_type nc=-1, bool sum_terms=true, octave_idx_type nzm=-1)
Definition dSparse.h:78
SparseMatrix::hermitian
SparseMatrix hermitian() const
Definition dSparse.h:135
SparseMatrix::SparseMatrix
SparseMatrix(octave_idx_type r, octave_idx_type c, octave_idx_type num_nz)
Definition dSparse.h:88
SparseMatrix::SparseMatrix
SparseMatrix(const NDArray &a)
Definition dSparse.h:76
SparseMatrix::all_elements_are_int_or_inf_or_nan
bool all_elements_are_int_or_inf_or_nan() const
Definition dSparse.cc:7456
SparseMatrix::solve
Matrix solve(MatrixType &typ, const Matrix &b) const
Definition dSparse.cc:6888
SparseMatrix::SparseMatrix
SparseMatrix(const PermMatrix &a)
Definition dSparse.h:86
SparseMatrix::SparseMatrix
SparseMatrix(const Matrix &a)
Definition dSparse.h:74
SparseMatrix::imag
friend SparseMatrix imag(const SparseComplexMatrix &a)
Definition dSparse.cc:782
SparseMatrix::operator<<
friend std::ostream & operator<<(std::ostream &os, const SparseMatrix &a)
Definition dSparse.cc:7706
SparseMatrix::SparseMatrix
SparseMatrix(const dim_vector &dv, octave_idx_type nz=0)
Definition dSparse.h:57
SparseMatrix::operator=
SparseMatrix & operator=(const SparseMatrix &a)
Definition dSparse.h:91
SparseMatrix::any_element_is_negative
bool any_element_is_negative(bool=false) const
Definition dSparse.cc:7378
SparseMatrix::matrix_value
Matrix matrix_value() const
Definition dSparse.cc:7700
SparseMatrix::operator>>
friend std::istream & operator>>(std::istream &is, SparseMatrix &a)
Definition dSparse.cc:7727
SparseMatrix::SparseMatrix
SparseMatrix(octave_idx_type r, octave_idx_type c, double val)
Definition dSparse.h:60
Sparse::index
Sparse< T, Alloc > index(const octave::idx_vector &i, bool resize_ok=false) const
Definition Sparse.cc:1447
base_det
Definition DET.h:38
dim_vector
Vector representing the dimensions (size) of an Array.
Definition dim-vector.h:92
octave_idx_type
operator+
SparseMatrix operator+(const DiagMatrix &, const SparseMatrix &)
Definition dSparse.cc:7805
trans_mul
Matrix trans_mul(const SparseMatrix &a, const Matrix &b)
Definition dSparse.cc:7785
operator*
SparseMatrix operator*(const SparseMatrix &a, const SparseMatrix &b)
Definition dSparse.cc:7761
real
SparseMatrix real(const SparseComplexMatrix &a)
Definition dSparse.cc:761
min
SparseMatrix min(double d, const SparseMatrix &m)
Definition dSparse.cc:7849
operator-
SparseMatrix operator-(const DiagMatrix &, const SparseMatrix &)
Definition dSparse.cc:7811
max
SparseMatrix max(double d, const SparseMatrix &m)
Definition dSparse.cc:8072
mul_trans
Matrix mul_trans(const Matrix &a, const SparseMatrix &b)
Definition dSparse.cc:7773
imag
SparseMatrix imag(const SparseComplexMatrix &a)
Definition dSparse.cc:782
OCTAVE_API
#define OCTAVE_API
Definition main.in.cc:55
ra_idx
const octave_base_value const Array< octave_idx_type > & ra_idx
Definition op-int-concat.cc:170
d
F77_RET_T const F77_DBLE const F77_DBLE F77_DBLE * d
Definition slatec-proto.h:39