Mercurial > octave-nkf
annotate src/ov-range.h @ 8437:f00578b495e9
remove valid_as_scalar_index
author | Jaroslav Hajek <highegg@gmail.com> |
---|---|
date | Sat, 27 Dec 2008 17:01:52 +0100 |
parents | 8b1a2555c4e2 |
children | d254a21e0120 |
rev | line source |
---|---|
2376 | 1 /* |
2 | |
7017 | 3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005, 2006, |
4 2007 John W. Eaton | |
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_range_h) | |
25 #define octave_range_h 1 | |
26 | |
27 #include <cstdlib> | |
28 | |
3503 | 29 #include <iostream> |
2376 | 30 #include <string> |
31 | |
32 #include "Range.h" | |
33 | |
2889 | 34 #include "lo-mappers.h" |
2376 | 35 #include "lo-utils.h" |
36 #include "mx-base.h" | |
2477 | 37 #include "oct-alloc.h" |
2376 | 38 #include "str-vec.h" |
39 | |
40 #include "error.h" | |
5051 | 41 #include "oct-stream.h" |
2376 | 42 #include "ov-base.h" |
6127 | 43 #include "ov-re-mat.h" |
2376 | 44 #include "ov-typeinfo.h" |
45 | |
46 class Octave_map; | |
47 class octave_value_list; | |
48 | |
49 class tree_walker; | |
50 | |
51 // Range values. | |
52 | |
53 class | |
54 octave_range : public octave_base_value | |
55 { | |
56 public: | |
57 | |
58 octave_range (void) | |
59 : octave_base_value () { } | |
60 | |
61 octave_range (double base, double limit, double inc) | |
62 : octave_base_value (), range (base, limit, inc) | |
63 { | |
64 if (range.nelem () < 0) | |
65 ::error ("invalid range"); | |
66 } | |
67 | |
68 octave_range (const Range& r) | |
69 : octave_base_value (), range (r) | |
70 { | |
71 if (range.nelem () < 0) | |
72 ::error ("invalid range"); | |
73 } | |
74 | |
75 octave_range (const octave_range& r) | |
76 : octave_base_value (), range (r.range) { } | |
77 | |
78 ~octave_range (void) { } | |
79 | |
5759 | 80 octave_base_value *clone (void) const { return new octave_range (*this); } |
6127 | 81 |
82 // A range is really just a special kind of real matrix object. In | |
83 // the places where we need to call empty_clone, it makes more sense | |
84 // to create an empty matrix (0x0) instead of an empty range (1x0). | |
85 octave_base_value *empty_clone (void) const { return new octave_matrix (); } | |
2376 | 86 |
8345
c777f3ce02d8
smarter conversion lookup
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
87 type_conv_info numeric_conversion_function (void) const; |
2410 | 88 |
5759 | 89 octave_base_value *try_narrowing_conversion (void); |
2376 | 90 |
4247 | 91 octave_value subsref (const std::string& type, |
4219 | 92 const std::list<octave_value_list>& idx); |
3933 | 93 |
7651
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7638
diff
changeset
|
94 octave_value_list subsref (const std::string& type, |
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7638
diff
changeset
|
95 const std::list<octave_value_list>& idx, int) |
443a8f5a50fd
require both subsref variants to be defined in octave_value subclasses
John W. Eaton <jwe@octave.org>
parents:
7638
diff
changeset
|
96 { return subsref (type, idx); } |
4271 | 97 |
5885 | 98 octave_value do_index_op (const octave_value_list& idx, |
99 bool resize_ok = false); | |
2436 | 100 |
2376 | 101 idx_vector index_vector (void) const { return idx_vector (range); } |
102 | |
4563 | 103 dim_vector dims (void) const |
5275 | 104 { |
105 octave_idx_type n = range.nelem (); | |
4563 | 106 return dim_vector (n > 0, n); |
107 } | |
3195 | 108 |
5731 | 109 octave_value resize (const dim_vector& dv, bool fill = false) const; |
110 | |
4915 | 111 |
4792 | 112 size_t byte_size (void) const { return 3 * sizeof (double); } |
4791 | 113 |
4627 | 114 octave_value reshape (const dim_vector& new_dims) const |
4901 | 115 { return NDArray (array_value().reshape (new_dims)); } |
4627 | 116 |
5434 | 117 octave_value permute (const Array<int>& vec, bool inv = false) const |
118 { return NDArray (array_value().permute (vec, inv)); } | |
119 | |
6999 | 120 octave_value squeeze (void) const { return range; } |
121 | |
2376 | 122 bool is_defined (void) const { return true; } |
123 | |
2974 | 124 bool is_constant (void) const { return true; } |
125 | |
2376 | 126 bool is_range (void) const { return true; } |
127 | |
4017 | 128 octave_value all (int dim = 0) const; |
129 | |
130 octave_value any (int dim = 0) const; | |
2376 | 131 |
8366
8b1a2555c4e2
implement diagonal matrix objects
Jaroslav Hajek <highegg@gmail.com>
parents:
8345
diff
changeset
|
132 octave_value diag (octave_idx_type k = 0) const; |
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7576
diff
changeset
|
133 |
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7458
diff
changeset
|
134 octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const |
7458 | 135 { return range.sort (dim, mode); } |
136 | |
137 octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0, | |
7463
2467639bd8c0
eliminate UNDEFINED sort mode
John W. Eaton <jwe@octave.org>
parents:
7458
diff
changeset
|
138 sortmode mode = ASCENDING) const |
7458 | 139 { return range.sort (sidx, dim, mode); } |
140 | |
2376 | 141 bool is_real_type (void) const { return true; } |
142 | |
5895 | 143 bool is_double_type (void) const { return true; } |
144 | |
7576 | 145 bool is_float_type (void) const { return true; } |
146 | |
3678 | 147 bool is_numeric_type (void) const { return true; } |
148 | |
2376 | 149 bool is_true (void) const; |
150 | |
3145 | 151 double double_value (bool = false) const; |
2376 | 152 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
153 float float_value (bool = false) const; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
154 |
3145 | 155 double scalar_value (bool frc_str_conv = false) const |
156 { return double_value (frc_str_conv); } | |
2916 | 157 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
158 float float_scalar_value (bool frc_str_conv = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
159 { return float_value (frc_str_conv); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
160 |
3145 | 161 Matrix matrix_value (bool = false) const |
2376 | 162 { return range.matrix_value (); } |
163 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
164 FloatMatrix float_matrix_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
165 { return range.matrix_value (); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
166 |
4668 | 167 NDArray array_value (bool = false) const |
168 { return range.matrix_value (); } | |
169 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
170 FloatNDArray float_array_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
171 { return FloatMatrix (range.matrix_value ()); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
172 |
6934 | 173 // FIXME -- it would be better to have Range::intXNDArray_value |
174 // functions to avoid the intermediate conversion to a matrix | |
175 // object. | |
176 | |
6932 | 177 int8NDArray |
178 int8_array_value (void) const { return int8NDArray (array_value ()); } | |
179 | |
180 int16NDArray | |
181 int16_array_value (void) const { return int16NDArray (array_value ()); } | |
182 | |
183 int32NDArray | |
184 int32_array_value (void) const { return int32NDArray (array_value ()); } | |
185 | |
186 int64NDArray | |
187 int64_array_value (void) const { return int64NDArray (array_value ()); } | |
188 | |
189 uint8NDArray | |
190 uint8_array_value (void) const { return uint8NDArray (array_value ()); } | |
191 | |
192 uint16NDArray | |
193 uint16_array_value (void) const { return uint16NDArray (array_value ()); } | |
194 | |
195 uint32NDArray | |
196 uint32_array_value (void) const { return uint32NDArray (array_value ()); } | |
197 | |
198 uint64NDArray | |
199 uint64_array_value (void) const { return uint64NDArray (array_value ()); } | |
200 | |
6928 | 201 SparseMatrix sparse_matrix_value (bool = false) const |
202 { return SparseMatrix (range.matrix_value ()); } | |
203 | |
204 SparseComplexMatrix sparse_complex_matrix_value (bool = false) const | |
205 { return SparseComplexMatrix (sparse_matrix_value ()); } | |
206 | |
3145 | 207 Complex complex_value (bool = false) const; |
2376 | 208 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
209 FloatComplex float_complex_value (bool = false) const; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
210 |
5943 | 211 boolNDArray bool_array_value (bool warn = false) const |
212 { | |
213 Matrix m = range.matrix_value (); | |
214 | |
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7789
diff
changeset
|
215 if (m.any_element_is_nan ()) |
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7789
diff
changeset
|
216 error ("invalid conversion from NaN to logical"); |
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7789
diff
changeset
|
217 else if (warn && m.any_element_not_one_or_zero ()) |
5943 | 218 gripe_logical_conversion (); |
219 | |
220 return boolNDArray (m); | |
221 } | |
5898 | 222 |
3145 | 223 ComplexMatrix complex_matrix_value (bool = false) const |
3587 | 224 { return ComplexMatrix (range.matrix_value ()); } |
2376 | 225 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
226 FloatComplexMatrix float_complex_matrix_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
227 { return FloatComplexMatrix (range.matrix_value ()); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
228 |
4668 | 229 ComplexNDArray complex_array_value (bool = false) const |
230 { return ComplexMatrix (range.matrix_value ()); } | |
231 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
232 FloatComplexNDArray float_complex_array_value (bool = false) const |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
233 { return FloatComplexMatrix (range.matrix_value ()); } |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7740
diff
changeset
|
234 |
2376 | 235 Range range_value (void) const { return range; } |
236 | |
5279 | 237 octave_value convert_to_str_internal (bool pad, bool force, char type) const; |
2449 | 238 |
3523 | 239 void print (std::ostream& os, bool pr_as_read_syntax = false) const; |
2901 | 240 |
3523 | 241 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; |
2901 | 242 |
3523 | 243 bool print_name_tag (std::ostream& os, const std::string& name) const; |
2376 | 244 |
6974 | 245 bool save_ascii (std::ostream& os); |
4687 | 246 |
247 bool load_ascii (std::istream& is); | |
248 | |
249 bool save_binary (std::ostream& os, bool& save_as_floats); | |
250 | |
251 bool load_binary (std::istream& is, bool swap, | |
252 oct_mach_info::float_format fmt); | |
253 | |
254 #if defined (HAVE_HDF5) | |
255 bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats); | |
256 | |
257 bool load_hdf5 (hid_t loc_id, const char *name, bool have_h5giterate_bug); | |
258 #endif | |
259 | |
5051 | 260 int write (octave_stream& os, int block_size, |
261 oct_data_conv::data_type output_type, int skip, | |
262 oct_mach_info::float_format flt_fmt) const | |
263 { | |
5775 | 264 // FIXME -- could be more memory efficient by having a |
5051 | 265 // special case of the octave_stream::write method for ranges. |
266 | |
267 return os.write (matrix_value (), block_size, output_type, skip, | |
268 flt_fmt); | |
269 } | |
270 | |
5900 | 271 mxArray *as_mxArray (void) const; |
272 | |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
273 // Mapper functions are converted to double for treatment |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
274 #define RANGE_MAPPER(MAP) \ |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
275 octave_value MAP (void) const \ |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
276 { \ |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
277 octave_matrix m (array_value ()); \ |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
278 return m.MAP (); \ |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
279 } |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
280 |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
281 RANGE_MAPPER (abs) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
282 RANGE_MAPPER (acos) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
283 RANGE_MAPPER (acosh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
284 RANGE_MAPPER (angle) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
285 RANGE_MAPPER (arg) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
286 RANGE_MAPPER (asin) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
287 RANGE_MAPPER (asinh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
288 RANGE_MAPPER (atan) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
289 RANGE_MAPPER (atanh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
290 RANGE_MAPPER (ceil) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
291 RANGE_MAPPER (conj) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
292 RANGE_MAPPER (cos) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
293 RANGE_MAPPER (cosh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
294 RANGE_MAPPER (erf) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
295 RANGE_MAPPER (erfc) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
296 RANGE_MAPPER (exp) |
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
297 RANGE_MAPPER (expm1) |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
298 RANGE_MAPPER (finite) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
299 RANGE_MAPPER (fix) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
300 RANGE_MAPPER (floor) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
301 RANGE_MAPPER (gamma) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
302 RANGE_MAPPER (imag) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
303 RANGE_MAPPER (isinf) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
304 RANGE_MAPPER (isna) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
305 RANGE_MAPPER (isnan) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
306 RANGE_MAPPER (lgamma) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
307 RANGE_MAPPER (log) |
7740 | 308 RANGE_MAPPER (log2) |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
309 RANGE_MAPPER (log10) |
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7636
diff
changeset
|
310 RANGE_MAPPER (log1p) |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
311 RANGE_MAPPER (real) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
312 RANGE_MAPPER (round) |
7636
99c410f7f0b0
implement mapper function for banker's rounding
Jaroslav Hajek <highegg@gmail.com>
parents:
7620
diff
changeset
|
313 RANGE_MAPPER (roundb) |
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
314 RANGE_MAPPER (signum) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
315 RANGE_MAPPER (sin) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
316 RANGE_MAPPER (sinh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
317 RANGE_MAPPER (sqrt) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
318 RANGE_MAPPER (tan) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
319 RANGE_MAPPER (tanh) |
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7463
diff
changeset
|
320 |
2376 | 321 private: |
322 | |
323 Range range; | |
324 | |
4612 | 325 DECLARE_OCTAVE_ALLOCATOR |
2477 | 326 |
4612 | 327 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA |
2376 | 328 }; |
329 | |
330 #endif | |
331 | |
332 /* | |
333 ;;; Local Variables: *** | |
334 ;;; mode: C++ *** | |
335 ;;; End: *** | |
336 */ |