Mercurial > hg > octave-nkf
annotate liboctave/boolSparse.h @ 10687:a8ce6bdecce5
Improve documentation strings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 08 Jun 2010 20:22:38 -0700 |
| parents | b4d2080b6df7 |
| children | 4b51c0a20a98 |
| rev | line source |
|---|---|
| 5164 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2004, 2005, 2006, 2007, 2008 David Bateman |
| 7016 | 4 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Andy Adler |
| 5 | |
| 6 This file is part of Octave. | |
| 5164 | 7 |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 5164 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 5164 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_boolSparse_h) | |
| 25 #define octave_boolSparse_h 1 | |
| 26 | |
| 27 #include "Sparse.h" | |
| 28 #include "MSparse-defs.h" | |
| 29 #include "Sparse-op-defs.h" | |
| 30 | |
| 31 class | |
| 6108 | 32 OCTAVE_API |
| 5164 | 33 SparseBoolMatrix : public Sparse<bool> |
| 34 { | |
| 35 public: | |
| 36 | |
| 37 SparseBoolMatrix (void) : Sparse<bool> () { } | |
| 38 | |
| 5275 | 39 SparseBoolMatrix (octave_idx_type r, octave_idx_type c) : Sparse<bool> (r, c) { } |
| 5164 | 40 |
| 5275 | 41 explicit SparseBoolMatrix (octave_idx_type r, octave_idx_type c, bool val) |
| 5164 | 42 : Sparse<bool> (r, c, val) { } |
| 43 | |
| 6823 | 44 SparseBoolMatrix (const dim_vector& dv, octave_idx_type nz = 0) : |
| 45 Sparse<bool> (dv, nz) { } | |
| 46 | |
| 5164 | 47 SparseBoolMatrix (const Sparse<bool>& a) : Sparse<bool> (a) { } |
| 48 | |
| 49 SparseBoolMatrix (const SparseBoolMatrix& a) : Sparse<bool> (a) { } | |
| 50 | |
| 51 SparseBoolMatrix (const SparseBoolMatrix& a, const dim_vector& dv) | |
| 52 : Sparse<bool> (a, dv) { } | |
| 53 | |
| 54 explicit SparseBoolMatrix (const boolMatrix& a) : Sparse<bool> (a) { } | |
| 55 | |
| 56 explicit SparseBoolMatrix (const boolNDArray& a) : Sparse<bool> (a) { } | |
| 57 | |
|
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10421
diff
changeset
|
58 SparseBoolMatrix (const Array<bool>& a, const idx_vector& r, |
|
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10421
diff
changeset
|
59 const idx_vector& c, octave_idx_type nr = -1, |
|
10527
b4d2080b6df7
Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents:
10480
diff
changeset
|
60 octave_idx_type nc = -1, bool sum_terms = true, |
|
b4d2080b6df7
Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents:
10480
diff
changeset
|
61 octave_idx_type nzm = -1) |
|
b4d2080b6df7
Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents:
10480
diff
changeset
|
62 : Sparse<bool> (a, r, c, nr, nc, sum_terms, nzm) { } |
|
10479
ded9beac7582
optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents:
10421
diff
changeset
|
63 |
| 5275 | 64 SparseBoolMatrix (octave_idx_type r, octave_idx_type c, octave_idx_type num_nz) : Sparse<bool> (r, c, num_nz) { } |
| 5164 | 65 |
| 66 SparseBoolMatrix& operator = (const SparseBoolMatrix& a) | |
| 67 { | |
| 68 Sparse<bool>::operator = (a); | |
| 69 return *this; | |
| 70 } | |
| 71 | |
| 72 bool operator == (const SparseBoolMatrix& a) const; | |
| 73 bool operator != (const SparseBoolMatrix& a) const; | |
| 74 | |
| 75 SparseBoolMatrix transpose (void) const | |
| 76 { return Sparse<bool>::transpose (); } | |
| 77 | |
| 78 // destructive insert/delete/reorder operations | |
| 79 | |
| 5275 | 80 SparseBoolMatrix& insert (const SparseBoolMatrix& a, octave_idx_type r, octave_idx_type c); |
| 5164 | 81 |
| 6823 | 82 SparseBoolMatrix& insert (const SparseBoolMatrix& a, const Array<octave_idx_type>& indx); |
| 83 | |
| 5164 | 84 SparseBoolMatrix concat (const SparseBoolMatrix& rb, |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
85 const Array<octave_idx_type>& ra_idx); |
| 5164 | 86 |
|
7515
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
87 SparseBoolMatrix diag (octave_idx_type k = 0) const; |
|
f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
88 |
| 5164 | 89 boolMatrix matrix_value (void) const; |
| 90 | |
| 91 SparseBoolMatrix squeeze (void) const; | |
| 92 | |
|
10421
99e9bae2d81e
improve sparse indexing interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10312
diff
changeset
|
93 SparseBoolMatrix index (const idx_vector& i, bool resize_ok) const; |
| 5164 | 94 |
|
10421
99e9bae2d81e
improve sparse indexing interface
Jaroslav Hajek <highegg@gmail.com>
parents:
10312
diff
changeset
|
95 SparseBoolMatrix index (const idx_vector& i, const idx_vector& j, bool resize_ok) const; |
| 5164 | 96 |
| 97 SparseBoolMatrix reshape (const dim_vector& new_dims) const; | |
| 98 | |
| 5275 | 99 SparseBoolMatrix permute (const Array<octave_idx_type>& vec, bool inv = false) const; |
| 5164 | 100 |
| 5275 | 101 SparseBoolMatrix ipermute (const Array<octave_idx_type>& vec) const; |
| 5164 | 102 |
| 103 // unary operations | |
| 104 | |
| 105 SparseBoolMatrix operator ! (void) const; | |
| 106 | |
| 107 // other operations | |
| 108 | |
| 109 SparseBoolMatrix all (int dim = -1) const; | |
| 110 SparseBoolMatrix any (int dim = -1) const; | |
| 111 | |
| 112 // i/o | |
| 113 | |
| 6108 | 114 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const SparseBoolMatrix& a); |
| 115 friend OCTAVE_API std::istream& operator >> (std::istream& is, SparseBoolMatrix& a); | |
| 5164 | 116 }; |
| 117 | |
| 6708 | 118 SPARSE_SMS_EQNE_OP_DECLS (SparseBoolMatrix, bool, OCTAVE_API) |
| 119 SPARSE_SMS_BOOL_OP_DECLS (SparseBoolMatrix, bool, OCTAVE_API) | |
| 5164 | 120 |
| 6708 | 121 SPARSE_SSM_EQNE_OP_DECLS (bool, SparseBoolMatrix, OCTAVE_API) |
| 122 SPARSE_SSM_BOOL_OP_DECLS (bool, SparseBoolMatrix, OCTAVE_API) | |
| 5164 | 123 |
| 6708 | 124 SPARSE_SMSM_EQNE_OP_DECLS (SparseBoolMatrix, SparseBoolMatrix, OCTAVE_API) |
| 125 SPARSE_SMSM_BOOL_OP_DECLS (SparseBoolMatrix, SparseBoolMatrix, OCTAVE_API) | |
| 5164 | 126 |
| 127 #endif |