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