|
2376
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
2376
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #if !defined (octave_value_h) |
|
|
24 #define octave_value_h 1 |
|
|
25 |
|
4192
|
26 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION) |
|
2376
|
27 #pragma interface |
|
|
28 #endif |
|
|
29 |
|
|
30 #include <cstdlib> |
|
|
31 |
|
3503
|
32 #include <iostream> |
|
2376
|
33 #include <string> |
|
4219
|
34 #include <list> |
|
2376
|
35 |
|
4687
|
36 #if defined (HAVE_HDF5) |
|
|
37 #include <hdf5.h> |
|
|
38 #endif |
|
4507
|
39 |
|
2376
|
40 #include "Range.h" |
|
|
41 #include "idx-vector.h" |
|
|
42 #include "mx-base.h" |
|
2477
|
43 #include "oct-alloc.h" |
|
4254
|
44 #include "oct-time.h" |
|
2942
|
45 #include "str-vec.h" |
|
|
46 |
|
3351
|
47 class Cell; |
|
4654
|
48 class fcn_handle_array; |
|
4643
|
49 class streamoff_array; |
|
2376
|
50 class Octave_map; |
|
2903
|
51 class octave_stream; |
|
4643
|
52 class octave_streamoff; |
|
2974
|
53 class octave_function; |
|
4700
|
54 class octave_user_function; |
|
4342
|
55 class octave_fcn_handle; |
|
2376
|
56 class octave_value_list; |
|
2979
|
57 class octave_lvalue; |
|
2376
|
58 |
|
|
59 // Constants. |
|
|
60 |
|
|
61 // This just provides a way to avoid infinite recursion when building |
|
|
62 // octave_value objects. |
|
|
63 |
|
|
64 class |
|
|
65 octave_xvalue |
|
|
66 { |
|
|
67 public: |
|
|
68 |
|
|
69 octave_xvalue (void) { } |
|
|
70 }; |
|
|
71 |
|
2427
|
72 class octave_value; |
|
|
73 |
|
|
74 // XXX FIXME XXX -- these should probably really be inside the scope |
|
|
75 // of the octave_value class, but the cygwin32 beta16 version of g++ |
|
3203
|
76 // can't handle that. |
|
|
77 |
|
|
78 typedef octave_value (*unary_op_fcn) |
|
|
79 (const octave_value&); |
|
|
80 |
|
|
81 typedef void (*non_const_unary_op_fcn) |
|
|
82 (octave_value&); |
|
2427
|
83 |
|
|
84 typedef octave_value (*binary_op_fcn) |
|
|
85 (const octave_value&, const octave_value&); |
|
|
86 |
|
|
87 typedef octave_value (*assign_op_fcn) |
|
|
88 (octave_value&, const octave_value_list&, const octave_value&); |
|
|
89 |
|
|
90 typedef octave_value * (*type_conv_fcn) (const octave_value&); |
|
|
91 |
|
2376
|
92 class |
|
2974
|
93 octave_value |
|
2376
|
94 { |
|
|
95 public: |
|
|
96 |
|
3203
|
97 enum unary_op |
|
|
98 { |
|
3525
|
99 op_not, |
|
|
100 op_uminus, |
|
|
101 op_transpose, |
|
|
102 op_hermitian, |
|
|
103 op_incr, |
|
|
104 op_decr, |
|
3203
|
105 num_unary_ops, |
|
|
106 unknown_unary_op |
|
|
107 }; |
|
|
108 |
|
2376
|
109 enum binary_op |
|
|
110 { |
|
3525
|
111 op_add, |
|
|
112 op_sub, |
|
|
113 op_mul, |
|
|
114 op_div, |
|
|
115 op_pow, |
|
|
116 op_ldiv, |
|
|
117 op_lshift, |
|
|
118 op_rshift, |
|
|
119 op_lt, |
|
|
120 op_le, |
|
|
121 op_eq, |
|
|
122 op_ge, |
|
|
123 op_gt, |
|
|
124 op_ne, |
|
|
125 op_el_mul, |
|
|
126 op_el_div, |
|
|
127 op_el_pow, |
|
|
128 op_el_ldiv, |
|
|
129 op_el_and, |
|
|
130 op_el_or, |
|
|
131 op_struct_ref, |
|
2376
|
132 num_binary_ops, |
|
|
133 unknown_binary_op |
|
|
134 }; |
|
|
135 |
|
2880
|
136 enum assign_op |
|
|
137 { |
|
3525
|
138 op_asn_eq, |
|
|
139 op_add_eq, |
|
|
140 op_sub_eq, |
|
|
141 op_mul_eq, |
|
|
142 op_div_eq, |
|
|
143 op_ldiv_eq, |
|
4018
|
144 op_pow_eq, |
|
3525
|
145 op_lshift_eq, |
|
|
146 op_rshift_eq, |
|
|
147 op_el_mul_eq, |
|
|
148 op_el_div_eq, |
|
|
149 op_el_ldiv_eq, |
|
4018
|
150 op_el_pow_eq, |
|
3525
|
151 op_el_and_eq, |
|
|
152 op_el_or_eq, |
|
2880
|
153 num_assign_ops, |
|
|
154 unknown_assign_op |
|
|
155 }; |
|
|
156 |
|
3523
|
157 static std::string unary_op_as_string (unary_op); |
|
3203
|
158 |
|
3523
|
159 static std::string binary_op_as_string (binary_op); |
|
2376
|
160 |
|
3523
|
161 static std::string assign_op_as_string (assign_op); |
|
2880
|
162 |
|
3933
|
163 static octave_value empty_conv (const std::string& type, |
|
|
164 const octave_value& rhs = octave_value ()); |
|
|
165 |
|
2376
|
166 enum magic_colon { magic_colon_t }; |
|
|
167 enum all_va_args { all_va_args_t }; |
|
|
168 |
|
|
169 octave_value (void); |
|
4254
|
170 octave_value (short int i); |
|
|
171 octave_value (unsigned short int i); |
|
4233
|
172 octave_value (int i); |
|
4254
|
173 octave_value (unsigned int i); |
|
|
174 octave_value (long int i); |
|
|
175 octave_value (unsigned long int i); |
|
4353
|
176 |
|
|
177 // XXX FIXME XXX -- these are kluges. They turn into doubles |
|
|
178 // internally, which will break for very large values. We just use |
|
|
179 // them to store things like 64-bit ino_t, etc, and hope that those |
|
|
180 // values are never actually larger than can be represented exactly |
|
|
181 // in a double. |
|
|
182 |
|
|
183 #if defined (HAVE_LONG_LONG_INT) |
|
|
184 octave_value (long long int i); |
|
|
185 #endif |
|
4356
|
186 #if defined (HAVE_UNSIGNED_LONG_LONG_INT) |
|
4353
|
187 octave_value (unsigned long long int i); |
|
|
188 #endif |
|
|
189 |
|
4254
|
190 octave_value (octave_time t); |
|
2376
|
191 octave_value (double d); |
|
4532
|
192 octave_value (const ArrayN<octave_value>& a, bool is_cs_list = false); |
|
|
193 octave_value (const Cell& c, bool is_cs_list = false); |
|
2376
|
194 octave_value (const Matrix& m); |
|
4513
|
195 octave_value (const NDArray& nda); |
|
2376
|
196 octave_value (const DiagMatrix& d); |
|
3418
|
197 octave_value (const RowVector& v); |
|
|
198 octave_value (const ColumnVector& v); |
|
2376
|
199 octave_value (const Complex& C); |
|
|
200 octave_value (const ComplexMatrix& m); |
|
4513
|
201 octave_value (const ComplexNDArray& cnda); |
|
4478
|
202 octave_value (const ArrayN<Complex>& m); |
|
2376
|
203 octave_value (const ComplexDiagMatrix& d); |
|
3418
|
204 octave_value (const ComplexRowVector& v); |
|
|
205 octave_value (const ComplexColumnVector& v); |
|
2825
|
206 octave_value (bool b); |
|
|
207 octave_value (const boolMatrix& bm); |
|
4513
|
208 octave_value (const boolNDArray& bnda); |
|
3189
|
209 octave_value (char c); |
|
2376
|
210 octave_value (const char *s); |
|
3523
|
211 octave_value (const std::string& s); |
|
2376
|
212 octave_value (const string_vector& s); |
|
|
213 octave_value (const charMatrix& chm, bool is_string = false); |
|
4513
|
214 octave_value (const charNDArray& chnda, bool is_string = false); |
|
4901
|
215 octave_value (const octave_int8& i); |
|
4910
|
216 octave_value (const octave_int16& i); |
|
|
217 octave_value (const octave_int32& i); |
|
|
218 octave_value (const octave_int64& i); |
|
4901
|
219 octave_value (const octave_uint8& i); |
|
|
220 octave_value (const octave_uint16& i); |
|
|
221 octave_value (const octave_uint32& i); |
|
|
222 octave_value (const octave_uint64& i); |
|
|
223 octave_value (const int8NDArray& inda); |
|
4910
|
224 octave_value (const int16NDArray& inda); |
|
|
225 octave_value (const int32NDArray& inda); |
|
|
226 octave_value (const int64NDArray& inda); |
|
4901
|
227 octave_value (const uint8NDArray& inda); |
|
|
228 octave_value (const uint16NDArray& inda); |
|
|
229 octave_value (const uint32NDArray& inda); |
|
|
230 octave_value (const uint64NDArray& inda); |
|
2376
|
231 octave_value (double base, double limit, double inc); |
|
|
232 octave_value (const Range& r); |
|
|
233 octave_value (const Octave_map& m); |
|
3340
|
234 octave_value (const octave_stream& s, int n); |
|
4643
|
235 octave_value (const streamoff_array& off); |
|
2974
|
236 octave_value (octave_function *f); |
|
4654
|
237 octave_value (const fcn_handle_array& fha); |
|
|
238 octave_value (octave_function *f, const std::string &nm); // function handle |
|
3977
|
239 octave_value (const octave_value_list& m, bool is_cs_list = false); |
|
2376
|
240 octave_value (octave_value::magic_colon); |
|
|
241 octave_value (octave_value::all_va_args); |
|
|
242 |
|
3933
|
243 octave_value (octave_value *new_rep, int count = 1); |
|
2376
|
244 |
|
|
245 // Copy constructor. |
|
|
246 |
|
|
247 octave_value (const octave_value& a) |
|
|
248 { |
|
|
249 rep = a.rep; |
|
|
250 rep->count++; |
|
|
251 } |
|
|
252 |
|
3933
|
253 // This should only be called for derived types. |
|
|
254 |
|
|
255 virtual octave_value *clone (void) const; |
|
|
256 |
|
|
257 virtual octave_value *empty_clone (void) const |
|
|
258 { return rep->empty_clone (); } |
|
|
259 |
|
2376
|
260 // Delete the representation of this constant if the count drops to |
|
|
261 // zero. |
|
|
262 |
|
|
263 virtual ~octave_value (void); |
|
|
264 |
|
|
265 void make_unique (void) |
|
|
266 { |
|
|
267 if (rep->count > 1) |
|
|
268 { |
|
|
269 --rep->count; |
|
|
270 rep = rep->clone (); |
|
|
271 rep->count = 1; |
|
|
272 } |
|
|
273 } |
|
|
274 |
|
|
275 // Simple assignment. |
|
|
276 |
|
|
277 octave_value& operator = (const octave_value& a) |
|
|
278 { |
|
|
279 if (rep != a.rep) |
|
|
280 { |
|
|
281 if (--rep->count == 0) |
|
|
282 delete rep; |
|
|
283 |
|
|
284 rep = a.rep; |
|
|
285 rep->count++; |
|
|
286 } |
|
|
287 |
|
|
288 return *this; |
|
|
289 } |
|
|
290 |
|
3933
|
291 int get_count (void) const { return rep->count; } |
|
3239
|
292 |
|
2409
|
293 virtual type_conv_fcn numeric_conversion_function (void) const |
|
2376
|
294 { return rep->numeric_conversion_function (); } |
|
|
295 |
|
2409
|
296 void maybe_mutate (void); |
|
|
297 |
|
4532
|
298 virtual octave_value squeeze (void) const |
|
|
299 { return rep->squeeze (); } |
|
|
300 |
|
2410
|
301 virtual octave_value *try_narrowing_conversion (void) |
|
|
302 { return rep->try_narrowing_conversion (); } |
|
2409
|
303 |
|
4271
|
304 octave_value single_subsref (const std::string& type, |
|
|
305 const octave_value_list& idx); |
|
|
306 |
|
4247
|
307 virtual octave_value subsref (const std::string& type, |
|
4219
|
308 const std::list<octave_value_list>& idx) |
|
3933
|
309 { return rep->subsref (type, idx); } |
|
|
310 |
|
4247
|
311 virtual octave_value_list subsref (const std::string& type, |
|
4219
|
312 const std::list<octave_value_list>& idx, |
|
3933
|
313 int nargout); |
|
|
314 |
|
4247
|
315 octave_value next_subsref (const std::string& type, const |
|
4219
|
316 std::list<octave_value_list>& idx, |
|
4233
|
317 size_t skip = 1); |
|
3933
|
318 |
|
|
319 virtual octave_value do_index_op (const octave_value_list& idx, |
|
|
320 int resize_ok) |
|
|
321 { return rep->do_index_op (idx, resize_ok); } |
|
|
322 |
|
|
323 octave_value do_index_op (const octave_value_list& idx) |
|
|
324 { return do_index_op (idx, 0); } |
|
2376
|
325 |
|
2974
|
326 virtual octave_value_list |
|
3544
|
327 do_multi_index_op (int nargout, const octave_value_list& idx); |
|
2974
|
328 |
|
4247
|
329 virtual octave_value subsasgn (const std::string& type, |
|
4219
|
330 const std::list<octave_value_list>& idx, |
|
3933
|
331 const octave_value& rhs); |
|
2376
|
332 |
|
4247
|
333 octave_value assign (assign_op op, const std::string& type, |
|
4219
|
334 const std::list<octave_value_list>& idx, |
|
3933
|
335 const octave_value& rhs); |
|
2948
|
336 |
|
3933
|
337 const octave_value& assign (assign_op, const octave_value& rhs); |
|
2948
|
338 |
|
2376
|
339 virtual idx_vector index_vector (void) const |
|
|
340 { return rep->index_vector (); } |
|
|
341 |
|
|
342 // Size. |
|
|
343 |
|
4513
|
344 virtual dim_vector dims (void) const |
|
|
345 { return rep->dims (); } |
|
|
346 |
|
4563
|
347 int rows (void) const; |
|
|
348 |
|
|
349 int columns (void) const; |
|
3195
|
350 |
|
4563
|
351 int length (void) const; |
|
4554
|
352 |
|
4563
|
353 int ndims (void) const; |
|
|
354 |
|
|
355 int numel (void) const; |
|
4559
|
356 |
|
4791
|
357 virtual size_t byte_size (void) const |
|
|
358 { return rep->byte_size (); } |
|
|
359 |
|
4587
|
360 virtual octave_value reshape (const dim_vector& dv) const |
|
|
361 { return rep->reshape (dv); } |
|
4567
|
362 |
|
4593
|
363 virtual octave_value permute (const Array<int>& vec, bool inv = false) const |
|
|
364 { return rep->permute (vec, inv); } |
|
|
365 |
|
|
366 octave_value ipermute (const Array<int>& vec) const |
|
|
367 { return rep->permute (vec, true); } |
|
|
368 |
|
2376
|
369 // Does this constant have a type? Both of these are provided since |
|
|
370 // it is sometimes more natural to write is_undefined() instead of |
|
|
371 // ! is_defined(). |
|
|
372 |
|
|
373 virtual bool is_defined (void) const |
|
|
374 { return rep->is_defined (); } |
|
|
375 |
|
|
376 bool is_undefined (void) const |
|
|
377 { return ! is_defined (); } |
|
|
378 |
|
4559
|
379 bool is_empty (void) const |
|
|
380 { return numel () == 0; } |
|
|
381 |
|
3351
|
382 virtual bool is_cell (void) const |
|
|
383 { return rep->is_cell (); } |
|
|
384 |
|
2376
|
385 virtual bool is_real_scalar (void) const |
|
|
386 { return rep->is_real_scalar (); } |
|
|
387 |
|
|
388 virtual bool is_real_matrix (void) const |
|
|
389 { return rep->is_real_matrix (); } |
|
|
390 |
|
4505
|
391 virtual bool is_real_nd_array (void) const |
|
|
392 { return rep->is_real_nd_array (); } |
|
|
393 |
|
2376
|
394 virtual bool is_complex_scalar (void) const |
|
|
395 { return rep->is_complex_scalar (); } |
|
|
396 |
|
|
397 virtual bool is_complex_matrix (void) const |
|
|
398 { return rep->is_complex_matrix (); } |
|
|
399 |
|
4587
|
400 virtual bool is_bool_matrix (void) const |
|
|
401 { return rep->is_bool_matrix (); } |
|
|
402 |
|
2376
|
403 virtual bool is_char_matrix (void) const |
|
|
404 { return rep->is_char_matrix (); } |
|
|
405 |
|
|
406 virtual bool is_string (void) const |
|
|
407 { return rep->is_string (); } |
|
|
408 |
|
|
409 virtual bool is_range (void) const |
|
|
410 { return rep->is_range (); } |
|
|
411 |
|
|
412 virtual bool is_map (void) const |
|
|
413 { return rep->is_map (); } |
|
|
414 |
|
3340
|
415 virtual bool is_stream (void) const |
|
|
416 { return rep->is_stream (); } |
|
|
417 |
|
4643
|
418 virtual bool is_streamoff (void) const |
|
|
419 { return rep->is_streamoff (); } |
|
|
420 |
|
3977
|
421 virtual bool is_cs_list (void) const |
|
|
422 { return rep->is_cs_list (); } |
|
|
423 |
|
2880
|
424 virtual bool is_list (void) const |
|
|
425 { return rep->is_list (); } |
|
|
426 |
|
2376
|
427 virtual bool is_magic_colon (void) const |
|
|
428 { return rep->is_magic_colon (); } |
|
|
429 |
|
|
430 virtual bool is_all_va_args (void) const |
|
|
431 { return rep->is_all_va_args (); } |
|
|
432 |
|
|
433 // Are any or all of the elements in this constant nonzero? |
|
|
434 |
|
4015
|
435 virtual octave_value all (int dim = 0) const |
|
|
436 { return rep->all (dim); } |
|
2376
|
437 |
|
4015
|
438 virtual octave_value any (int dim = 0) const |
|
|
439 { return rep->any (dim); } |
|
2376
|
440 |
|
|
441 // Other type stuff. |
|
|
442 |
|
3209
|
443 virtual bool is_bool_type (void) const |
|
|
444 { return rep->is_bool_type (); } |
|
|
445 |
|
2376
|
446 virtual bool is_real_type (void) const |
|
|
447 { return rep->is_real_type (); } |
|
|
448 |
|
|
449 virtual bool is_complex_type (void) const |
|
|
450 { return rep->is_complex_type (); } |
|
|
451 |
|
|
452 virtual bool is_scalar_type (void) const |
|
|
453 { return rep->is_scalar_type (); } |
|
|
454 |
|
|
455 virtual bool is_matrix_type (void) const |
|
|
456 { return rep->is_matrix_type (); } |
|
|
457 |
|
|
458 virtual bool is_numeric_type (void) const |
|
|
459 { return rep->is_numeric_type (); } |
|
|
460 |
|
|
461 virtual bool valid_as_scalar_index (void) const |
|
|
462 { return rep->valid_as_scalar_index (); } |
|
|
463 |
|
|
464 virtual bool valid_as_zero_index (void) const |
|
|
465 { return rep->valid_as_zero_index (); } |
|
|
466 |
|
|
467 // Does this constant correspond to a truth value? |
|
|
468 |
|
|
469 virtual bool is_true (void) const |
|
|
470 { return rep->is_true (); } |
|
|
471 |
|
|
472 // Are the dimensions of this constant zero by zero? |
|
|
473 |
|
|
474 virtual bool is_zero_by_zero (void) const |
|
|
475 { return rep->is_zero_by_zero (); } |
|
|
476 |
|
2974
|
477 virtual bool is_constant (void) const |
|
|
478 { return rep->is_constant (); } |
|
|
479 |
|
4654
|
480 virtual bool is_function_handle (void) const |
|
|
481 { return rep->is_function_handle (); } |
|
|
482 |
|
2974
|
483 virtual bool is_function (void) const |
|
|
484 { return rep->is_function (); } |
|
2891
|
485 |
|
3325
|
486 virtual bool is_builtin_function (void) const |
|
|
487 { return rep->is_builtin_function (); } |
|
|
488 |
|
|
489 virtual bool is_dld_function (void) const |
|
|
490 { return rep->is_dld_function (); } |
|
|
491 |
|
2376
|
492 // Values. |
|
|
493 |
|
2891
|
494 octave_value eval (void) { return *this; } |
|
|
495 |
|
4254
|
496 virtual short int |
|
|
497 short_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
498 { return rep->short_value (req_int, frc_str_conv); } |
|
|
499 |
|
|
500 virtual unsigned short int |
|
|
501 ushort_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
502 { return rep->ushort_value (req_int, frc_str_conv); } |
|
|
503 |
|
3202
|
504 virtual int int_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
505 { return rep->int_value (req_int, frc_str_conv); } |
|
|
506 |
|
4254
|
507 virtual unsigned int |
|
|
508 uint_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
509 { return rep->uint_value (req_int, frc_str_conv); } |
|
|
510 |
|
3202
|
511 virtual int nint_value (bool frc_str_conv = false) const |
|
|
512 { return rep->nint_value (frc_str_conv); } |
|
|
513 |
|
4254
|
514 virtual long int |
|
|
515 long_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
516 { return rep->long_value (req_int, frc_str_conv); } |
|
|
517 |
|
|
518 virtual unsigned long int |
|
|
519 ulong_value (bool req_int = false, bool frc_str_conv = false) const |
|
|
520 { return rep->ulong_value (req_int, frc_str_conv); } |
|
|
521 |
|
2376
|
522 virtual double double_value (bool frc_str_conv = false) const |
|
|
523 { return rep->double_value (frc_str_conv); } |
|
|
524 |
|
2916
|
525 virtual double scalar_value (bool frc_str_conv = false) const |
|
|
526 { return rep->scalar_value (frc_str_conv); } |
|
|
527 |
|
3351
|
528 virtual Cell cell_value (void) const; |
|
|
529 |
|
2376
|
530 virtual Matrix matrix_value (bool frc_str_conv = false) const |
|
|
531 { return rep->matrix_value (frc_str_conv); } |
|
|
532 |
|
4550
|
533 virtual NDArray array_value (bool frc_str_conv = false) const |
|
|
534 { return rep->array_value (frc_str_conv); } |
|
4505
|
535 |
|
2376
|
536 virtual Complex complex_value (bool frc_str_conv = false) const |
|
|
537 { return rep->complex_value (frc_str_conv); } |
|
|
538 |
|
|
539 virtual ComplexMatrix complex_matrix_value (bool frc_str_conv = false) const |
|
|
540 { return rep->complex_matrix_value (frc_str_conv); } |
|
|
541 |
|
4550
|
542 virtual ComplexNDArray complex_array_value (bool frc_str_conv = false) const |
|
|
543 { return rep->complex_array_value (frc_str_conv); } |
|
|
544 |
|
|
545 virtual bool bool_value (void) const |
|
|
546 { return rep->bool_value (); } |
|
|
547 |
|
|
548 virtual boolMatrix bool_matrix_value (void) const |
|
|
549 { return rep->bool_matrix_value (); } |
|
|
550 |
|
|
551 virtual boolNDArray bool_array_value (void) const |
|
|
552 { return rep->bool_array_value (); } |
|
|
553 |
|
2376
|
554 virtual charMatrix char_matrix_value (bool frc_str_conv = false) const |
|
|
555 { return rep->char_matrix_value (frc_str_conv); } |
|
|
556 |
|
4550
|
557 virtual charNDArray char_array_value (bool frc_str_conv = false) const |
|
|
558 { return rep->char_array_value (frc_str_conv); } |
|
|
559 |
|
4910
|
560 virtual octave_int8 int8_scalar_value (void) const |
|
|
561 { return rep->int8_scalar_value (); } |
|
|
562 |
|
|
563 virtual octave_int16 int16_scalar_value (void) const |
|
|
564 { return rep->int16_scalar_value (); } |
|
|
565 |
|
|
566 virtual octave_int32 int32_scalar_value (void) const |
|
|
567 { return rep->int32_scalar_value (); } |
|
|
568 |
|
|
569 virtual octave_int64 int64_scalar_value (void) const |
|
|
570 { return rep->int64_scalar_value (); } |
|
|
571 |
|
|
572 virtual octave_uint8 uint8_scalar_value (void) const |
|
|
573 { return rep->uint8_scalar_value (); } |
|
|
574 |
|
|
575 virtual octave_uint16 uint16_scalar_value (void) const |
|
|
576 { return rep->uint16_scalar_value (); } |
|
|
577 |
|
|
578 virtual octave_uint32 uint32_scalar_value (void) const |
|
|
579 { return rep->uint32_scalar_value (); } |
|
|
580 |
|
|
581 virtual octave_uint64 uint64_scalar_value (void) const |
|
|
582 { return rep->uint64_scalar_value (); } |
|
|
583 |
|
4906
|
584 virtual int8NDArray int8_array_value (void) const |
|
|
585 { return rep->int8_array_value (); } |
|
|
586 |
|
|
587 virtual int16NDArray int16_array_value (void) const |
|
|
588 { return rep->int16_array_value (); } |
|
|
589 |
|
|
590 virtual int32NDArray int32_array_value (void) const |
|
|
591 { return rep->int32_array_value (); } |
|
|
592 |
|
|
593 virtual int64NDArray int64_array_value (void) const |
|
|
594 { return rep->int64_array_value (); } |
|
|
595 |
|
|
596 virtual uint8NDArray uint8_array_value (void) const |
|
|
597 { return rep->uint8_array_value (); } |
|
|
598 |
|
|
599 virtual uint16NDArray uint16_array_value (void) const |
|
|
600 { return rep->uint16_array_value (); } |
|
|
601 |
|
|
602 virtual uint32NDArray uint32_array_value (void) const |
|
|
603 { return rep->uint32_array_value (); } |
|
|
604 |
|
|
605 virtual uint64NDArray uint64_array_value (void) const |
|
|
606 { return rep->uint64_array_value (); } |
|
|
607 |
|
4457
|
608 virtual string_vector all_strings (bool pad = false, |
|
|
609 bool force = false) const |
|
4661
|
610 { return rep->all_strings (pad, force); } |
|
2376
|
611 |
|
4457
|
612 virtual std::string string_value (bool force = false) const |
|
4665
|
613 { return rep->string_value (force); } |
|
2376
|
614 |
|
|
615 virtual Range range_value (void) const |
|
|
616 { return rep->range_value (); } |
|
|
617 |
|
|
618 virtual Octave_map map_value (void) const; |
|
|
619 |
|
3933
|
620 virtual string_vector map_keys (void) const |
|
|
621 { return rep->map_keys (); } |
|
|
622 |
|
3340
|
623 virtual octave_stream stream_value (void) const; |
|
2903
|
624 |
|
|
625 virtual int stream_number (void) const; |
|
|
626 |
|
4645
|
627 virtual std::streamoff streamoff_value (void) const; |
|
|
628 |
|
|
629 virtual streamoff_array streamoff_array_value (void) const; |
|
4643
|
630 |
|
2974
|
631 virtual octave_function *function_value (bool silent = false); |
|
|
632 |
|
4700
|
633 virtual octave_user_function *user_function_value (bool silent = false); |
|
|
634 |
|
4346
|
635 virtual octave_fcn_handle *fcn_handle_value (bool silent = false); |
|
4343
|
636 |
|
2880
|
637 virtual octave_value_list list_value (void) const; |
|
|
638 |
|
3419
|
639 ColumnVector column_vector_value (bool frc_str_conv = false, |
|
2376
|
640 bool frc_vec_conv = false) const; |
|
|
641 |
|
|
642 ComplexColumnVector |
|
3419
|
643 complex_column_vector_value (bool frc_str_conv = false, |
|
2376
|
644 bool frc_vec_conv = false) const; |
|
|
645 |
|
3419
|
646 RowVector row_vector_value (bool frc_str_conv = false, |
|
|
647 bool frc_vec_conv = false) const; |
|
|
648 |
|
|
649 ComplexRowVector |
|
|
650 complex_row_vector_value (bool frc_str_conv = false, |
|
|
651 bool frc_vec_conv = false) const; |
|
|
652 |
|
4044
|
653 Array<int> int_vector_value (bool req_int = false, |
|
|
654 bool frc_str_conv = false, |
|
|
655 bool frc_vec_conv = false) const; |
|
|
656 |
|
3419
|
657 Array<double> vector_value (bool frc_str_conv = false, |
|
|
658 bool frc_vec_conv = false) const; |
|
|
659 |
|
|
660 Array<Complex> complex_vector_value (bool frc_str_conv = false, |
|
|
661 bool frc_vec_conv = false) const; |
|
|
662 |
|
2376
|
663 // Conversions. These should probably be private. If a user of this |
|
|
664 // class wants a certain kind of constant, he should simply ask for |
|
|
665 // it, and we should convert it if possible. |
|
|
666 |
|
4457
|
667 octave_value convert_to_str (bool pad = false, bool force = false) const; |
|
4452
|
668 |
|
4457
|
669 virtual octave_value convert_to_str_internal (bool pad, bool force) const |
|
|
670 { return rep->convert_to_str_internal (pad, force); } |
|
2376
|
671 |
|
|
672 virtual void convert_to_row_or_column_vector (void) |
|
|
673 { rep->convert_to_row_or_column_vector (); } |
|
|
674 |
|
4604
|
675 virtual bool print_as_scalar (void) const |
|
|
676 { return rep->print_as_scalar (); } |
|
|
677 |
|
3523
|
678 virtual void print (std::ostream& os, bool pr_as_read_syntax = false) const |
|
2466
|
679 { rep->print (os, pr_as_read_syntax); } |
|
2376
|
680 |
|
4457
|
681 virtual void print_raw (std::ostream& os, |
|
|
682 bool pr_as_read_syntax = false) const |
|
2903
|
683 { rep->print_raw (os, pr_as_read_syntax); } |
|
|
684 |
|
3523
|
685 virtual bool print_name_tag (std::ostream& os, const std::string& name) const |
|
2903
|
686 { return rep->print_name_tag (os, name); } |
|
2376
|
687 |
|
3523
|
688 void print_with_name (std::ostream& os, const std::string& name, |
|
2903
|
689 bool print_padding = true) const; |
|
2376
|
690 |
|
|
691 virtual int type_id (void) const { return rep->type_id (); } |
|
|
692 |
|
3523
|
693 virtual std::string type_name (void) const { return rep->type_name (); } |
|
2376
|
694 |
|
4612
|
695 virtual std::string class_name (void) const { return rep->class_name (); } |
|
|
696 |
|
3203
|
697 // Unary and binary operations. |
|
|
698 |
|
3933
|
699 friend octave_value do_unary_op (unary_op op, |
|
|
700 const octave_value& a); |
|
3203
|
701 |
|
3933
|
702 const octave_value& do_non_const_unary_op (unary_op op); |
|
|
703 |
|
|
704 void do_non_const_unary_op (unary_op op, const octave_value_list& idx); |
|
2376
|
705 |
|
4247
|
706 octave_value do_non_const_unary_op (unary_op op, const std::string& type, |
|
4219
|
707 const std::list<octave_value_list>& idx); |
|
3205
|
708 |
|
3933
|
709 friend octave_value do_binary_op (binary_op op, |
|
|
710 const octave_value& a, |
|
|
711 const octave_value& b); |
|
2376
|
712 |
|
3301
|
713 const octave_value& get_rep (void) const { return *rep; } |
|
|
714 |
|
3933
|
715 virtual void print_info (std::ostream& os, |
|
|
716 const std::string& prefix = std::string ()) const; |
|
|
717 |
|
4687
|
718 virtual bool save_ascii (std::ostream& os, bool& infnan_warned, |
|
|
719 bool strip_nan_and_inf) |
|
|
720 { return rep->save_ascii (os, infnan_warned, strip_nan_and_inf); } |
|
|
721 |
|
|
722 virtual bool load_ascii (std::istream& is) |
|
|
723 { return rep->load_ascii (is); } |
|
|
724 |
|
|
725 virtual bool save_binary (std::ostream& os, bool& save_as_floats) |
|
|
726 { return rep->save_binary (os, save_as_floats); } |
|
|
727 |
|
|
728 virtual bool load_binary (std::istream& is, bool swap, |
|
|
729 oct_mach_info::float_format fmt) |
|
|
730 { return rep->load_binary (is, swap, fmt); } |
|
|
731 |
|
|
732 #if defined (HAVE_HDF5) |
|
|
733 virtual bool save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats) |
|
|
734 { return rep->save_hdf5 (loc_id, name, save_as_floats); } |
|
|
735 |
|
|
736 virtual bool load_hdf5 (hid_t loc_id, const char *name, |
|
|
737 bool have_h5giterate_bug) |
|
|
738 { return rep->load_hdf5 (loc_id, name, have_h5giterate_bug); } |
|
|
739 #endif |
|
|
740 |
|
4901
|
741 octave_value *internal_rep (void) const { return rep; } |
|
|
742 |
|
2376
|
743 protected: |
|
|
744 |
|
|
745 octave_value (const octave_xvalue&) : rep (0) { } |
|
|
746 |
|
3933
|
747 // This should only be called for derived types. |
|
|
748 |
|
4247
|
749 octave_value numeric_assign (const std::string& type, |
|
4219
|
750 const std::list<octave_value_list>& idx, |
|
3933
|
751 const octave_value& rhs); |
|
|
752 |
|
2903
|
753 void reset_indent_level (void) const |
|
|
754 { curr_print_indent_level = 0; } |
|
|
755 |
|
|
756 void increment_indent_level (void) const |
|
|
757 { curr_print_indent_level += 2; } |
|
|
758 |
|
|
759 void decrement_indent_level (void) const |
|
|
760 { curr_print_indent_level -= 2; } |
|
|
761 |
|
|
762 int current_print_indent_level (void) const |
|
|
763 { return curr_print_indent_level; } |
|
|
764 |
|
3523
|
765 void newline (std::ostream& os) const; |
|
2903
|
766 |
|
3523
|
767 void indent (std::ostream& os) const; |
|
2903
|
768 |
|
|
769 void reset (void) const; |
|
|
770 |
|
2376
|
771 union |
|
|
772 { |
|
|
773 octave_value *rep; // The real representation. |
|
|
774 int count; // A reference count. |
|
|
775 }; |
|
2413
|
776 |
|
3933
|
777 private: |
|
2903
|
778 |
|
|
779 static int curr_print_indent_level; |
|
|
780 static bool beginning_of_line; |
|
3204
|
781 |
|
3205
|
782 assign_op unary_op_to_assign_op (unary_op op); |
|
|
783 |
|
3204
|
784 binary_op op_eq_to_binary_op (assign_op op); |
|
|
785 |
|
3219
|
786 DECLARE_OCTAVE_ALLOCATOR |
|
4513
|
787 |
|
|
788 octave_value *nil_rep (void) const; |
|
2376
|
789 }; |
|
|
790 |
|
3203
|
791 #define OV_UNOP_FN(name) \ |
|
|
792 inline octave_value \ |
|
|
793 name (const octave_value& a) \ |
|
|
794 { \ |
|
|
795 return do_unary_op (octave_value::name, a); \ |
|
|
796 } |
|
|
797 |
|
|
798 #define OV_UNOP_OP(name, op) \ |
|
|
799 inline octave_value \ |
|
|
800 operator op (const octave_value& a) \ |
|
|
801 { \ |
|
|
802 return name (a); \ |
|
|
803 } |
|
|
804 |
|
|
805 #define OV_UNOP_FN_OP(name, op) \ |
|
|
806 OV_UNOP_FN (name) \ |
|
|
807 OV_UNOP_OP (name, op) |
|
|
808 |
|
3525
|
809 OV_UNOP_FN_OP (op_not, !) |
|
|
810 OV_UNOP_FN_OP (op_uminus, -) |
|
3203
|
811 |
|
3525
|
812 OV_UNOP_FN (op_transpose) |
|
|
813 OV_UNOP_FN (op_hermitian) |
|
3203
|
814 |
|
|
815 // No simple way to define these for prefix and suffix ops? |
|
|
816 // |
|
|
817 // incr |
|
|
818 // decr |
|
|
819 |
|
|
820 #define OV_BINOP_FN(name) \ |
|
|
821 inline octave_value \ |
|
|
822 name (const octave_value& a1, const octave_value& a2) \ |
|
|
823 { \ |
|
|
824 return do_binary_op (octave_value::name, a1, a2); \ |
|
|
825 } |
|
|
826 |
|
|
827 #define OV_BINOP_OP(name, op) \ |
|
|
828 inline octave_value \ |
|
|
829 operator op (const octave_value& a1, const octave_value& a2) \ |
|
|
830 { \ |
|
|
831 return name (a1, a2); \ |
|
|
832 } |
|
|
833 |
|
|
834 #define OV_BINOP_FN_OP(name, op) \ |
|
|
835 OV_BINOP_FN (name) \ |
|
|
836 OV_BINOP_OP (name, op) |
|
|
837 |
|
3525
|
838 OV_BINOP_FN_OP (op_add, +) |
|
|
839 OV_BINOP_FN_OP (op_sub, -) |
|
|
840 OV_BINOP_FN_OP (op_mul, *) |
|
|
841 OV_BINOP_FN_OP (op_div, /) |
|
3203
|
842 |
|
3525
|
843 OV_BINOP_FN (op_pow) |
|
|
844 OV_BINOP_FN (op_ldiv) |
|
|
845 OV_BINOP_FN (op_lshift) |
|
|
846 OV_BINOP_FN (op_rshift) |
|
3203
|
847 |
|
3525
|
848 OV_BINOP_FN_OP (op_lt, <) |
|
|
849 OV_BINOP_FN_OP (op_le, <=) |
|
|
850 OV_BINOP_FN_OP (op_eq, ==) |
|
|
851 OV_BINOP_FN_OP (op_ge, >=) |
|
|
852 OV_BINOP_FN_OP (op_gt, >) |
|
|
853 OV_BINOP_FN_OP (op_ne, !=) |
|
3203
|
854 |
|
3525
|
855 OV_BINOP_FN (op_el_mul) |
|
|
856 OV_BINOP_FN (op_el_div) |
|
|
857 OV_BINOP_FN (op_el_pow) |
|
|
858 OV_BINOP_FN (op_el_ldiv) |
|
|
859 OV_BINOP_FN (op_el_and) |
|
|
860 OV_BINOP_FN (op_el_or) |
|
3203
|
861 |
|
3525
|
862 OV_BINOP_FN (op_struct_ref) |
|
3203
|
863 |
|
3219
|
864 // T_ID is the type id of struct objects, set by register_type(). |
|
|
865 // T_NAME is the type name of struct objects. |
|
|
866 #define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA \ |
|
|
867 public: \ |
|
|
868 int type_id (void) const { return t_id; } \ |
|
3523
|
869 std::string type_name (void) const { return t_name; } \ |
|
4612
|
870 std::string class_name (void) const { return c_name; } \ |
|
4252
|
871 static int static_type_id (void) { return t_id; } \ |
|
4901
|
872 static std::string static_type_name (void) { return t_name; } \ |
|
|
873 static std::string static_class_name (void) { return c_name; } \ |
|
4640
|
874 static void register_type (void); \ |
|
3219
|
875 \ |
|
|
876 private: \ |
|
4252
|
877 static int t_id; \ |
|
4612
|
878 static const std::string t_name; \ |
|
|
879 static const std::string c_name; |
|
3219
|
880 |
|
4612
|
881 #define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c) \ |
|
4252
|
882 int t::t_id (-1); \ |
|
4612
|
883 const std::string t::t_name (n); \ |
|
4640
|
884 const std::string t::c_name (c); \ |
|
|
885 void t::register_type (void) \ |
|
|
886 { \ |
|
|
887 t_id = octave_value_typeinfo::register_type (t::t_name, \ |
|
|
888 t::c_name, \ |
|
4645
|
889 octave_value (new t ())); \ |
|
4640
|
890 } |
|
3219
|
891 |
|
4455
|
892 // If TRUE, print a warning for assignments like |
|
2376
|
893 // |
|
|
894 // octave> A(1) = 3; A(2) = 5 |
|
|
895 // |
|
|
896 // for A already defined and a matrix type. |
|
4455
|
897 extern bool Vwarn_fortran_indexing; |
|
2376
|
898 |
|
4452
|
899 // Should we print a warning when converting `[97, 98, 99, "123"]' |
|
|
900 // to a character string? |
|
|
901 extern bool Vwarn_num_to_str; |
|
4257
|
902 |
|
4452
|
903 // If TRUE, warn for operations like |
|
2376
|
904 // |
|
|
905 // octave> 'abc' + 0 |
|
|
906 // 97 98 99 |
|
|
907 // |
|
4452
|
908 extern int Vwarn_str_to_num; |
|
2376
|
909 |
|
4451
|
910 // Should we warn about conversions from complex to real? |
|
|
911 extern int Vwarn_imag_to_real; |
|
2376
|
912 |
|
|
913 // If TRUE, print the name along with the value. |
|
|
914 extern bool Vprint_answer_id_name; |
|
|
915 |
|
|
916 // How many levels of structure elements should we print? |
|
|
917 extern int Vstruct_levels_to_print; |
|
|
918 |
|
|
919 // Allow divide by zero errors to be suppressed. |
|
|
920 extern bool Vwarn_divide_by_zero; |
|
|
921 |
|
4461
|
922 // If TRUE, print a warning when a matrix is resized by an indexed |
|
|
923 // assignment with indices outside the current bounds. |
|
|
924 extern bool Vwarn_resize_on_range_error; |
|
3195
|
925 |
|
2376
|
926 // Indentation level for structures. |
|
|
927 extern int struct_indent; |
|
|
928 |
|
|
929 extern void increment_struct_indent (void); |
|
|
930 extern void decrement_struct_indent (void); |
|
|
931 |
|
2880
|
932 // Indentation level for lists. |
|
|
933 extern int list_indent; |
|
|
934 |
|
|
935 extern void increment_list_indent (void); |
|
|
936 extern void decrement_list_indent (void); |
|
|
937 |
|
2376
|
938 extern void install_types (void); |
|
|
939 |
|
|
940 #endif |
|
|
941 |
|
|
942 /* |
|
|
943 ;; Local Variables: *** |
|
|
944 ;; mode: C++ *** |
|
|
945 ;; End: *** |
|
|
946 */ |
