|
2376
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996 John W. Eaton |
|
|
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 |
|
|
26 #if defined (__GNUG__) |
|
|
27 #pragma interface |
|
|
28 #endif |
|
|
29 |
|
|
30 #include <cstdlib> |
|
|
31 |
|
|
32 #include <string> |
|
|
33 |
|
|
34 class ostream; |
|
|
35 |
|
|
36 #include <SLList.h> |
|
|
37 |
|
|
38 #include "Range.h" |
|
|
39 #include "idx-vector.h" |
|
|
40 #include "mx-base.h" |
|
|
41 #include "str-vec.h" |
|
|
42 |
|
|
43 #include "error.h" |
|
|
44 #include "pt-exp.h" |
|
|
45 |
|
|
46 class Octave_map; |
|
|
47 class octave_value_list; |
|
|
48 |
|
|
49 // Constants. |
|
|
50 |
|
|
51 // This just provides a way to avoid infinite recursion when building |
|
|
52 // octave_value objects. |
|
|
53 |
|
|
54 class |
|
|
55 octave_xvalue |
|
|
56 { |
|
|
57 public: |
|
|
58 |
|
|
59 octave_xvalue (void) { } |
|
|
60 }; |
|
|
61 |
|
|
62 class |
|
|
63 octave_value |
|
|
64 { |
|
|
65 public: |
|
|
66 |
|
|
67 typedef octave_value (*binary_op_fcn) |
|
|
68 (const octave_value&, const octave_value&); |
|
|
69 |
|
|
70 typedef octave_value (*assign_op_fcn) |
|
|
71 (octave_value&, const octave_value_list&, const octave_value&); |
|
|
72 |
|
|
73 typedef octave_value * (*widening_op_fcn) (const octave_value&); |
|
|
74 |
|
|
75 typedef octave_value * (*numeric_conv_fcn) (const octave_value&); |
|
|
76 |
|
|
77 enum binary_op |
|
|
78 { |
|
|
79 add, |
|
|
80 sub, |
|
|
81 mul, |
|
|
82 div, |
|
|
83 pow, |
|
|
84 ldiv, |
|
|
85 lt, |
|
|
86 le, |
|
|
87 eq, |
|
|
88 ge, |
|
|
89 gt, |
|
|
90 ne, |
|
|
91 el_mul, |
|
|
92 el_div, |
|
|
93 el_pow, |
|
|
94 el_ldiv, |
|
|
95 el_and, |
|
|
96 el_or, |
|
|
97 struct_ref, |
|
|
98 num_binary_ops, |
|
|
99 unknown_binary_op |
|
|
100 }; |
|
|
101 |
|
|
102 static string binary_op_as_string (binary_op); |
|
|
103 |
|
|
104 enum magic_colon { magic_colon_t }; |
|
|
105 enum all_va_args { all_va_args_t }; |
|
|
106 |
|
|
107 octave_value (void); |
|
|
108 octave_value (double d); |
|
|
109 octave_value (const Matrix& m); |
|
|
110 octave_value (const DiagMatrix& d); |
|
|
111 octave_value (const RowVector& v, int pcv = -1); |
|
|
112 octave_value (const ColumnVector& v, int pcv = -1); |
|
|
113 octave_value (const Complex& C); |
|
|
114 octave_value (const ComplexMatrix& m); |
|
|
115 octave_value (const ComplexDiagMatrix& d); |
|
|
116 octave_value (const ComplexRowVector& v, int pcv = -1); |
|
|
117 octave_value (const ComplexColumnVector& v, int pcv = -1); |
|
|
118 octave_value (const char *s); |
|
|
119 octave_value (const string& s); |
|
|
120 octave_value (const string_vector& s); |
|
|
121 octave_value (const charMatrix& chm, bool is_string = false); |
|
|
122 octave_value (double base, double limit, double inc); |
|
|
123 octave_value (const Range& r); |
|
|
124 octave_value (const Octave_map& m); |
|
|
125 octave_value (octave_value::magic_colon); |
|
|
126 octave_value (octave_value::all_va_args); |
|
|
127 |
|
|
128 octave_value (octave_value *new_rep); |
|
|
129 |
|
|
130 // Copy constructor. |
|
|
131 |
|
|
132 octave_value (const octave_value& a) |
|
|
133 { |
|
|
134 rep = a.rep; |
|
|
135 rep->count++; |
|
|
136 } |
|
|
137 |
|
|
138 // Delete the representation of this constant if the count drops to |
|
|
139 // zero. |
|
|
140 |
|
|
141 virtual ~octave_value (void); |
|
|
142 |
|
|
143 // This should only be called for derived types. |
|
|
144 |
|
|
145 virtual octave_value *clone (void) { panic_impossible (); } |
|
|
146 |
|
|
147 void make_unique (void) |
|
|
148 { |
|
|
149 if (rep->count > 1) |
|
|
150 { |
|
|
151 --rep->count; |
|
|
152 rep = rep->clone (); |
|
|
153 rep->count = 1; |
|
|
154 } |
|
|
155 } |
|
|
156 |
|
|
157 #if 0 |
|
|
158 void *operator new (size_t size); |
|
|
159 void operator delete (void *p, size_t size); |
|
|
160 #endif |
|
|
161 |
|
|
162 // Simple assignment. |
|
|
163 |
|
|
164 octave_value& operator = (const octave_value& a) |
|
|
165 { |
|
|
166 if (rep != a.rep) |
|
|
167 { |
|
|
168 if (--rep->count == 0) |
|
|
169 delete rep; |
|
|
170 |
|
|
171 rep = a.rep; |
|
|
172 rep->count++; |
|
|
173 } |
|
|
174 |
|
|
175 return *this; |
|
|
176 } |
|
|
177 |
|
|
178 virtual numeric_conv_fcn numeric_conversion_function (void) const |
|
|
179 { return rep->numeric_conversion_function (); } |
|
|
180 |
|
|
181 virtual octave_value index (const octave_value_list& idx) const |
|
|
182 { return rep->index (idx); } |
|
|
183 |
|
|
184 octave_value& assign (const octave_value_list& idx, const octave_value& rhs); |
|
|
185 |
|
|
186 virtual idx_vector index_vector (void) const |
|
|
187 { return rep->index_vector (); } |
|
|
188 |
|
|
189 virtual octave_value struct_elt_val (const string& nm) const |
|
|
190 { return rep->struct_elt_val (nm); } |
|
|
191 |
|
|
192 virtual octave_value& struct_elt_ref (const string& nm) |
|
|
193 { return rep->struct_elt_ref (nm); } |
|
|
194 |
|
|
195 #if 0 |
|
|
196 // Simple structure assignment. |
|
|
197 |
|
|
198 octave_value assign_map_element (SLList<string>& list, |
|
|
199 octave_value& rhs); |
|
|
200 |
|
|
201 // Indexed structure assignment. |
|
|
202 |
|
|
203 octave_value assign_map_element (SLList<string>& list, |
|
|
204 octave_value& rhs, |
|
|
205 const octave_value_list& args); |
|
|
206 #endif |
|
|
207 |
|
|
208 // Size. |
|
|
209 |
|
|
210 virtual int rows (void) const |
|
|
211 { return rep->rows (); } |
|
|
212 |
|
|
213 virtual int columns (void) const |
|
|
214 { return rep->columns (); } |
|
|
215 |
|
|
216 // Does this constant have a type? Both of these are provided since |
|
|
217 // it is sometimes more natural to write is_undefined() instead of |
|
|
218 // ! is_defined(). |
|
|
219 |
|
|
220 virtual bool is_defined (void) const |
|
|
221 { return rep->is_defined (); } |
|
|
222 |
|
|
223 bool is_undefined (void) const |
|
|
224 { return ! is_defined (); } |
|
|
225 |
|
|
226 virtual bool is_real_scalar (void) const |
|
|
227 { return rep->is_real_scalar (); } |
|
|
228 |
|
|
229 virtual bool is_real_matrix (void) const |
|
|
230 { return rep->is_real_matrix (); } |
|
|
231 |
|
|
232 virtual bool is_complex_scalar (void) const |
|
|
233 { return rep->is_complex_scalar (); } |
|
|
234 |
|
|
235 virtual bool is_complex_matrix (void) const |
|
|
236 { return rep->is_complex_matrix (); } |
|
|
237 |
|
|
238 virtual bool is_char_matrix (void) const |
|
|
239 { return rep->is_char_matrix (); } |
|
|
240 |
|
|
241 virtual bool is_string (void) const |
|
|
242 { return rep->is_string (); } |
|
|
243 |
|
|
244 virtual bool is_range (void) const |
|
|
245 { return rep->is_range (); } |
|
|
246 |
|
|
247 virtual bool is_map (void) const |
|
|
248 { return rep->is_map (); } |
|
|
249 |
|
|
250 virtual bool is_magic_colon (void) const |
|
|
251 { return rep->is_magic_colon (); } |
|
|
252 |
|
|
253 virtual bool is_all_va_args (void) const |
|
|
254 { return rep->is_all_va_args (); } |
|
|
255 |
|
|
256 // Are any or all of the elements in this constant nonzero? |
|
|
257 |
|
|
258 virtual octave_value all (void) const |
|
|
259 { return rep->all (); } |
|
|
260 |
|
|
261 virtual octave_value any (void) const |
|
|
262 { return rep->any (); } |
|
|
263 |
|
|
264 // Other type stuff. |
|
|
265 |
|
|
266 virtual bool is_real_type (void) const |
|
|
267 { return rep->is_real_type (); } |
|
|
268 |
|
|
269 virtual bool is_complex_type (void) const |
|
|
270 { return rep->is_complex_type (); } |
|
|
271 |
|
|
272 virtual bool is_scalar_type (void) const |
|
|
273 { return rep->is_scalar_type (); } |
|
|
274 |
|
|
275 virtual bool is_matrix_type (void) const |
|
|
276 { return rep->is_matrix_type (); } |
|
|
277 |
|
|
278 virtual bool is_numeric_type (void) const |
|
|
279 { return rep->is_numeric_type (); } |
|
|
280 |
|
|
281 virtual bool valid_as_scalar_index (void) const |
|
|
282 { return rep->valid_as_scalar_index (); } |
|
|
283 |
|
|
284 virtual bool valid_as_zero_index (void) const |
|
|
285 { return rep->valid_as_zero_index (); } |
|
|
286 |
|
|
287 // Does this constant correspond to a truth value? |
|
|
288 |
|
|
289 virtual bool is_true (void) const |
|
|
290 { return rep->is_true (); } |
|
|
291 |
|
|
292 // Is at least one of the dimensions of this constant zero? |
|
|
293 |
|
|
294 virtual bool is_empty (void) const |
|
|
295 { return rep->is_empty (); } |
|
|
296 |
|
|
297 // Are the dimensions of this constant zero by zero? |
|
|
298 |
|
|
299 virtual bool is_zero_by_zero (void) const |
|
|
300 { return rep->is_zero_by_zero (); } |
|
|
301 |
|
|
302 // Values. |
|
|
303 |
|
|
304 virtual double double_value (bool frc_str_conv = false) const |
|
|
305 { return rep->double_value (frc_str_conv); } |
|
|
306 |
|
|
307 virtual Matrix matrix_value (bool frc_str_conv = false) const |
|
|
308 { return rep->matrix_value (frc_str_conv); } |
|
|
309 |
|
|
310 virtual Complex complex_value (bool frc_str_conv = false) const |
|
|
311 { return rep->complex_value (frc_str_conv); } |
|
|
312 |
|
|
313 virtual ComplexMatrix complex_matrix_value (bool frc_str_conv = false) const |
|
|
314 { return rep->complex_matrix_value (frc_str_conv); } |
|
|
315 |
|
|
316 virtual charMatrix char_matrix_value (bool frc_str_conv = false) const |
|
|
317 { return rep->char_matrix_value (frc_str_conv); } |
|
|
318 |
|
|
319 virtual charMatrix all_strings (void) const |
|
|
320 { return rep->all_strings (); } |
|
|
321 |
|
|
322 virtual string string_value (void) const |
|
|
323 { return rep->string_value (); } |
|
|
324 |
|
|
325 virtual Range range_value (void) const |
|
|
326 { return rep->range_value (); } |
|
|
327 |
|
|
328 virtual Octave_map map_value (void) const; |
|
|
329 |
|
|
330 // Unary ops. |
|
|
331 |
|
|
332 virtual octave_value not (void) const { return rep->not (); } |
|
|
333 |
|
|
334 virtual octave_value uminus (void) const { return rep->uminus (); } |
|
|
335 |
|
|
336 virtual octave_value transpose (void) const { return rep->transpose (); } |
|
|
337 |
|
|
338 virtual octave_value hermitian (void) const { return rep->hermitian (); } |
|
|
339 |
|
|
340 virtual void increment (void) |
|
|
341 { |
|
|
342 make_unique (); |
|
|
343 rep->increment (); |
|
|
344 } |
|
|
345 |
|
|
346 virtual void decrement (void) |
|
|
347 { |
|
|
348 make_unique (); |
|
|
349 rep->decrement (); |
|
|
350 } |
|
|
351 |
|
|
352 #if 0 |
|
|
353 virtual octave_value |
|
|
354 lookup_map_element (const string& ref, bool insert = false, |
|
|
355 bool silent = false) |
|
|
356 { return lookup_map_element (ref, insert, silent); } |
|
|
357 |
|
|
358 virtual octave_value |
|
|
359 lookup_map_element (SLList<string>& list, bool insert = false, |
|
|
360 bool silent = false) |
|
|
361 { return rep->lookup_map_element (list, insert, silent); } |
|
|
362 #endif |
|
|
363 |
|
|
364 ColumnVector vector_value (bool frc_str_conv = false, |
|
|
365 bool frc_vec_conv = false) const; |
|
|
366 |
|
|
367 ComplexColumnVector |
|
|
368 complex_vector_value (bool frc_str_conv = false, |
|
|
369 bool frc_vec_conv = false) const; |
|
|
370 |
|
|
371 // Conversions. These should probably be private. If a user of this |
|
|
372 // class wants a certain kind of constant, he should simply ask for |
|
|
373 // it, and we should convert it if possible. |
|
|
374 |
|
|
375 virtual octave_value convert_to_str (void) const |
|
|
376 { return rep->convert_to_str (); } |
|
|
377 |
|
|
378 virtual void convert_to_row_or_column_vector (void) |
|
|
379 { rep->convert_to_row_or_column_vector (); } |
|
|
380 |
|
|
381 void print (void); |
|
|
382 |
|
|
383 virtual void print (ostream& os) { rep->print (os); } |
|
|
384 |
|
|
385 void print_with_name (const string& name, bool print_padding = true); |
|
|
386 |
|
|
387 void print_with_name (ostream& os, const string& name, |
|
|
388 bool print_padding = true); |
|
|
389 |
|
|
390 virtual int type_id (void) const { return rep->type_id (); } |
|
|
391 |
|
|
392 virtual string type_name (void) const { return rep->type_name (); } |
|
|
393 |
|
|
394 #if 0 |
|
|
395 octave_value_rep *make_unique_map (void); |
|
|
396 |
|
|
397 // We want to eliminate this, or at least make it private. |
|
|
398 |
|
|
399 virtual octave_value_rep::constant_type const_type (void) const |
|
|
400 { return rep->const_type (); } |
|
|
401 #endif |
|
|
402 |
|
|
403 virtual void convert_to_matrix_type (bool make_complex) |
|
|
404 { rep->convert_to_matrix_type (make_complex); } |
|
|
405 |
|
|
406 // Can we make these go away? |
|
|
407 |
|
|
408 // These need better names, since a range really is a numeric type. |
|
|
409 |
|
|
410 virtual void force_numeric (bool frc_str_conv = false) |
|
|
411 { rep->force_numeric (frc_str_conv); } |
|
|
412 |
|
|
413 octave_value make_numeric (bool) const |
|
|
414 { |
|
|
415 warning ("octave_value::make_numeric() is a no-op"); |
|
|
416 return *this; |
|
|
417 } |
|
|
418 |
|
|
419 #if 0 |
|
|
420 { |
|
|
421 if (is_numeric_type ()) |
|
|
422 return *this; |
|
|
423 else |
|
|
424 return rep->make_numeric (frc_str_conv); |
|
|
425 } |
|
|
426 #endif |
|
|
427 |
|
|
428 bool print_as_scalar (void); |
|
|
429 |
|
|
430 bool print_as_structure (void) { return is_map (); } |
|
|
431 |
|
|
432 // Binary and unary operations. |
|
|
433 |
|
|
434 friend octave_value do_binary_op (octave_value& a, octave_value& b, |
|
|
435 tree_expression::type t); |
|
|
436 |
|
|
437 protected: |
|
|
438 |
|
|
439 octave_value (const octave_xvalue&) : rep (0) { } |
|
|
440 |
|
|
441 private: |
|
|
442 |
|
|
443 union |
|
|
444 { |
|
|
445 octave_value *freeptr; // For custom memory management. |
|
|
446 octave_value *rep; // The real representation. |
|
|
447 int count; // A reference count. |
|
|
448 }; |
|
|
449 }; |
|
|
450 |
|
|
451 // If TRUE, allow assignments like |
|
|
452 // |
|
|
453 // octave> A(1) = 3; A(2) = 5 |
|
|
454 // |
|
|
455 // for A already defined and a matrix type. |
|
|
456 extern bool Vdo_fortran_indexing; |
|
|
457 |
|
|
458 // Should we allow things like: |
|
|
459 // |
|
|
460 // octave> 'abc' + 0 |
|
|
461 // 97 98 99 |
|
|
462 // |
|
|
463 // to happen? A positive value means yes. A negative value means |
|
|
464 // yes, but print a warning message. Zero means it should be |
|
|
465 // considered an error. |
|
|
466 extern int Vimplicit_str_to_num_ok; |
|
|
467 |
|
|
468 // Should we allow silent conversion of complex to real when a real |
|
|
469 // type is what we're really looking for? A positive value means yes. |
|
|
470 // A negative value means yes, but print a warning message. Zero |
|
|
471 // means it should be considered an error. |
|
|
472 extern int Vok_to_lose_imaginary_part; |
|
|
473 |
|
|
474 // If TRUE, create column vectors when doing assignments like: |
|
|
475 // |
|
|
476 // octave> A(1) = 3; A(2) = 5 |
|
|
477 // |
|
|
478 // (for A undefined). Only matters when resize_on_range_error is also |
|
|
479 // TRUE. |
|
|
480 extern bool Vprefer_column_vectors; |
|
|
481 |
|
|
482 // If TRUE, prefer logical (zore-one) indexing over normal indexing |
|
|
483 // when there is a conflice. For example, given a = [2, 3], the |
|
|
484 // expression a ([1, 1]) would return [2 3] (instead of [2 2], which |
|
|
485 // would be returned if prefer_zero_one_indxing were FALSE). |
|
|
486 extern bool Vprefer_zero_one_indexing; |
|
|
487 |
|
|
488 // If TRUE, print the name along with the value. |
|
|
489 extern bool Vprint_answer_id_name; |
|
|
490 |
|
|
491 // Should operations on empty matrices return empty matrices or an |
|
|
492 // error? A positive value means yes. A negative value means yes, |
|
|
493 // but print a warning message. Zero means it should be considered an |
|
|
494 // error. |
|
|
495 extern int Vpropagate_empty_matrices; |
|
|
496 |
|
|
497 // If TRUE, resize matrices when performing and indexed assignment and |
|
|
498 // the indices are outside the current bounds. |
|
|
499 extern bool Vresize_on_range_error; |
|
|
500 |
|
|
501 // How many levels of structure elements should we print? |
|
|
502 extern int Vstruct_levels_to_print; |
|
|
503 |
|
|
504 // Allow divide by zero errors to be suppressed. |
|
|
505 extern bool Vwarn_divide_by_zero; |
|
|
506 |
|
|
507 // Indentation level for structures. |
|
|
508 extern int struct_indent; |
|
|
509 |
|
|
510 extern void symbols_of_value (void); |
|
|
511 |
|
|
512 extern void increment_struct_indent (void); |
|
|
513 extern void decrement_struct_indent (void); |
|
|
514 |
|
|
515 extern octave_value |
|
|
516 do_binary_op (octave_value::binary_op, const octave_value&, |
|
|
517 const octave_value&); |
|
|
518 |
|
|
519 extern void install_types (void); |
|
|
520 |
|
|
521 #endif |
|
|
522 |
|
|
523 /* |
|
|
524 ;; Local Variables: *** |
|
|
525 ;; mode: C++ *** |
|
|
526 ;; End: *** |
|
|
527 */ |
