Mercurial > hg > octave-nkf
annotate src/ov-re-mat.h @ 12386:c1ea9b90a272 release-3-4-x
Added tag ss-3-3-92 for changeset c468c5b902b3
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sun, 06 Feb 2011 07:30:27 -0500 |
| parents | 12df7854fa7c |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 2376 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 1996-2011 John W. Eaton |
| 4 Copyright (C) 2009-2010 VZLU Prague | |
| 2376 | 5 |
| 6 This file is part of Octave. | |
| 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. | |
| 2376 | 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/>. | |
| 2376 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_matrix_h) | |
| 25 #define octave_matrix_h 1 | |
| 26 | |
| 27 #include <cstdlib> | |
| 28 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
29 #include <iosfwd> |
| 2376 | 30 #include <string> |
| 31 | |
| 32 #include "mx-base.h" | |
| 2477 | 33 #include "oct-alloc.h" |
| 2376 | 34 #include "str-vec.h" |
| 35 | |
| 36 #include "error.h" | |
| 4944 | 37 #include "oct-stream.h" |
| 2376 | 38 #include "ov-base.h" |
| 3219 | 39 #include "ov-base-mat.h" |
| 2376 | 40 #include "ov-typeinfo.h" |
| 41 | |
| 5785 | 42 #include "MatrixType.h" |
| 43 | |
| 2376 | 44 class octave_value_list; |
| 45 | |
| 46 class tree_walker; | |
| 47 | |
| 48 // Real matrix values. | |
| 49 | |
| 50 class | |
| 6153 | 51 OCTINTERP_API |
| 4513 | 52 octave_matrix : public octave_base_matrix<NDArray> |
| 2376 | 53 { |
| 54 public: | |
| 55 | |
| 56 octave_matrix (void) | |
| 4513 | 57 : octave_base_matrix<NDArray> () { } |
| 2376 | 58 |
| 59 octave_matrix (const Matrix& m) | |
| 4513 | 60 : octave_base_matrix<NDArray> (m) { } |
| 61 | |
| 5785 | 62 octave_matrix (const Matrix& m, const MatrixType& t) |
| 63 : octave_base_matrix<NDArray> (m, t) { } | |
| 64 | |
| 4513 | 65 octave_matrix (const NDArray& nda) |
| 66 : octave_base_matrix<NDArray> (nda) { } | |
| 2376 | 67 |
|
9732
b4fdfee405b5
remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents:
9685
diff
changeset
|
68 octave_matrix (const Array<double>& m) |
| 4911 | 69 : octave_base_matrix<NDArray> (NDArray (m)) { } |
| 70 | |
| 2376 | 71 octave_matrix (const DiagMatrix& d) |
| 4513 | 72 : octave_base_matrix<NDArray> (Matrix (d)) { } |
| 2376 | 73 |
| 3418 | 74 octave_matrix (const RowVector& v) |
| 4513 | 75 : octave_base_matrix<NDArray> (Matrix (v)) { } |
| 2376 | 76 |
| 3418 | 77 octave_matrix (const ColumnVector& v) |
| 4513 | 78 : octave_base_matrix<NDArray> (Matrix (v)) { } |
| 2376 | 79 |
| 80 octave_matrix (const octave_matrix& m) | |
| 4513 | 81 : octave_base_matrix<NDArray> (m) { } |
| 2376 | 82 |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
83 octave_matrix (const Array<octave_idx_type>& idx, |
|
9351
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
84 bool zero_based = false, bool cache_index = false) |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
85 : octave_base_matrix<NDArray> (NDArray (idx, zero_based)) |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
86 { |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
87 // Auto-create cache to speed up subsequent indexing. |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
88 if (zero_based && cache_index) |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
89 set_idx_cache (idx_vector (idx)); |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
90 } |
|
e2344f4af0cb
autocache indices returned from find et al.
Jaroslav Hajek <highegg@gmail.com>
parents:
9350
diff
changeset
|
91 |
|
9479
d9716e3ee0dd
supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents:
9358
diff
changeset
|
92 octave_matrix (const NDArray& nda, const idx_vector& cache) |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
93 : octave_base_matrix<NDArray> (nda) |
|
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
94 { |
|
9894
83bd7f34f9da
improve idx_vector->octave_value conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
9881
diff
changeset
|
95 set_idx_cache (cache); |
|
9479
d9716e3ee0dd
supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents:
9358
diff
changeset
|
96 } |
|
d9716e3ee0dd
supply optimized compiled sub2ind & ind2sub
Jaroslav Hajek <highegg@gmail.com>
parents:
9358
diff
changeset
|
97 |
| 2376 | 98 ~octave_matrix (void) { } |
| 99 | |
| 5759 | 100 octave_base_value *clone (void) const { return new octave_matrix (*this); } |
| 101 octave_base_value *empty_clone (void) const { return new octave_matrix (); } | |
| 2376 | 102 |
|
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7885
diff
changeset
|
103 type_conv_info numeric_demotion_function (void) const; |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
104 |
| 5759 | 105 octave_base_value *try_narrowing_conversion (void); |
| 2410 | 106 |
|
9350
16a5f9e1fdb3
cache idx_vector result in matrices once used for indexing
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
107 idx_vector index_vector (void) const |
|
16a5f9e1fdb3
cache idx_vector result in matrices once used for indexing
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
108 { return idx_cache ? *idx_cache : set_idx_cache (idx_vector (matrix)); } |
| 2376 | 109 |
| 9685 | 110 builtin_type_t builtin_type (void) const { return btyp_double; } |
| 111 | |
| 2376 | 112 bool is_real_matrix (void) const { return true; } |
| 113 | |
| 114 bool is_real_type (void) const { return true; } | |
| 115 | |
| 5895 | 116 bool is_double_type (void) const { return true; } |
| 117 | |
| 7576 | 118 bool is_float_type (void) const { return true; } |
| 119 | |
| 5533 | 120 int8NDArray |
| 121 int8_array_value (void) const { return int8NDArray (matrix); } | |
| 122 | |
| 123 int16NDArray | |
| 124 int16_array_value (void) const { return int16NDArray (matrix); } | |
| 125 | |
| 126 int32NDArray | |
| 127 int32_array_value (void) const { return int32NDArray (matrix); } | |
| 128 | |
| 129 int64NDArray | |
| 130 int64_array_value (void) const { return int64NDArray (matrix); } | |
| 131 | |
| 132 uint8NDArray | |
| 133 uint8_array_value (void) const { return uint8NDArray (matrix); } | |
| 134 | |
| 135 uint16NDArray | |
| 136 uint16_array_value (void) const { return uint16NDArray (matrix); } | |
| 137 | |
| 138 uint32NDArray | |
| 139 uint32_array_value (void) const { return uint32NDArray (matrix); } | |
| 140 | |
| 141 uint64NDArray | |
| 142 uint64_array_value (void) const { return uint64NDArray (matrix); } | |
| 143 | |
| 2376 | 144 double double_value (bool = false) const; |
| 145 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
146 float float_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
147 |
| 3145 | 148 double scalar_value (bool frc_str_conv = false) const |
| 149 { return double_value (frc_str_conv); } | |
| 2916 | 150 |
| 4513 | 151 Matrix matrix_value (bool = false) const; |
| 2376 | 152 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
153 FloatMatrix float_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
154 |
| 2376 | 155 Complex complex_value (bool = false) const; |
| 156 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
157 FloatComplex float_complex_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
158 |
| 4513 | 159 ComplexMatrix complex_matrix_value (bool = false) const; |
| 2376 | 160 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
161 FloatComplexMatrix float_complex_matrix_value (bool = false) const; |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
162 |
| 4699 | 163 ComplexNDArray complex_array_value (bool = false) const; |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
164 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
165 FloatComplexNDArray float_complex_array_value (bool = false) const; |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
166 |
| 5943 | 167 boolNDArray bool_array_value (bool warn = false) const; |
| 5898 | 168 |
| 4758 | 169 charNDArray char_array_value (bool = false) const; |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
170 |
| 4550 | 171 NDArray array_value (bool = false) const { return matrix; } |
| 4505 | 172 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
173 FloatNDArray float_array_value (bool = false) const { return matrix; } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
174 |
| 5164 | 175 SparseMatrix sparse_matrix_value (bool = false) const; |
| 176 | |
| 177 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const; | |
| 178 | |
|
8366
8b1a2555c4e2
implement diagonal matrix objects
Jaroslav Hajek <highegg@gmail.com>
parents:
8345
diff
changeset
|
179 octave_value diag (octave_idx_type k = 0) const; |
|
8b1a2555c4e2
implement diagonal matrix objects
Jaroslav Hajek <highegg@gmail.com>
parents:
8345
diff
changeset
|
180 |
|
10339
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
181 octave_value reshape (const dim_vector& new_dims) const; |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
182 |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
183 octave_value squeeze (void) const; |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
184 |
|
10273
3a8c13b71612
implement special-case optimization for sort of index vectors
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
185 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; |
|
3a8c13b71612
implement special-case optimization for sort of index vectors
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
186 octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0, |
| 10313 | 187 sortmode mode = ASCENDING) const; |
|
10273
3a8c13b71612
implement special-case optimization for sort of index vectors
Jaroslav Hajek <highegg@gmail.com>
parents:
10160
diff
changeset
|
188 |
|
10339
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
189 sortmode is_sorted (sortmode mode = UNSORTED) const; |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
190 |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
191 Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const; |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
192 |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
193 sortmode is_sorted_rows (sortmode mode = UNSORTED) const; |
|
de2d43bcb083
optimize some lazy index operations
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
194 |
|
9606
a04352386a6b
clear index cache on ++,-- operators
Jaroslav Hajek <highegg@gmail.com>
parents:
9479
diff
changeset
|
195 // Use matrix_ref here to clear index cache. |
|
a04352386a6b
clear index cache on ++,-- operators
Jaroslav Hajek <highegg@gmail.com>
parents:
9479
diff
changeset
|
196 void increment (void) { matrix_ref () += 1.0; } |
| 2376 | 197 |
|
9606
a04352386a6b
clear index cache on ++,-- operators
Jaroslav Hajek <highegg@gmail.com>
parents:
9479
diff
changeset
|
198 void decrement (void) { matrix_ref () -= 1.0; } |
| 2376 | 199 |
|
9607
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9606
diff
changeset
|
200 void changesign (void) { matrix_ref ().changesign (); } |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9606
diff
changeset
|
201 |
| 5279 | 202 octave_value convert_to_str_internal (bool pad, bool force, char type) const; |
| 2376 | 203 |
| 4643 | 204 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
| 205 | |
| 6974 | 206 bool save_ascii (std::ostream& os); |
| 4687 | 207 |
| 208 bool load_ascii (std::istream& is); | |
| 209 | |
| 210 bool save_binary (std::ostream& os, bool& save_as_floats); | |
| 211 | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
212 bool load_binary (std::istream& is, bool swap, |
| 10313 | 213 oct_mach_info::float_format fmt); |
| 4687 | 214 |
| 215 #if defined (HAVE_HDF5) | |
| 216 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
| 217 | |
|
9881
b3089dba88bf
Remove HDF5 cruft for older versions of HDF5
Kacper Kowalik
parents:
9812
diff
changeset
|
218 bool load_hdf5 (hid_t loc_id, const char *name); |
| 4687 | 219 #endif |
| 220 | |
| 4944 | 221 int write (octave_stream& os, int block_size, |
| 10313 | 222 oct_data_conv::data_type output_type, int skip, |
| 223 oct_mach_info::float_format flt_fmt) const | |
| 4944 | 224 { return os.write (matrix, block_size, output_type, skip, flt_fmt); } |
| 225 | |
|
9358
d4b1314a7c31
mex.cc (mxArray_octave_value::get_data): avoid enumerating types that can be handled as foreign
John W. Eaton <jwe@octave.org>
parents:
9351
diff
changeset
|
226 // Unsafe. This function exists to support the MEX interface. |
|
d4b1314a7c31
mex.cc (mxArray_octave_value::get_data): avoid enumerating types that can be handled as foreign
John W. Eaton <jwe@octave.org>
parents:
9351
diff
changeset
|
227 // You should not use it anywhere else. |
|
d4b1314a7c31
mex.cc (mxArray_octave_value::get_data): avoid enumerating types that can be handled as foreign
John W. Eaton <jwe@octave.org>
parents:
9351
diff
changeset
|
228 void *mex_get_data (void) const { return matrix.mex_get_data (); } |
|
d4b1314a7c31
mex.cc (mxArray_octave_value::get_data): avoid enumerating types that can be handled as foreign
John W. Eaton <jwe@octave.org>
parents:
9351
diff
changeset
|
229 |
| 5900 | 230 mxArray *as_mxArray (void) const; |
| 231 | |
|
9812
f80c566bc751
improve unary mapper system
Jaroslav Hajek <highegg@gmail.com>
parents:
9732
diff
changeset
|
232 octave_value map (unary_mapper_t umap) const; |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
233 |
| 2376 | 234 private: |
| 3219 | 235 DECLARE_OCTAVE_ALLOCATOR |
| 2477 | 236 |
| 3219 | 237 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
| 2376 | 238 }; |
| 239 | |
| 240 #endif |