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