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