|
1
|
1 // The rest of the tree classes. -*- C++ -*- |
|
|
2 /* |
|
|
3 |
|
296
|
4 Copyright (C) 1992, 1993, 1994 John W. Eaton |
|
1
|
5 |
|
|
6 This file is part of Octave. |
|
|
7 |
|
|
8 Octave is free software; you can redistribute it and/or modify it |
|
|
9 under the terms of the GNU General Public License as published by the |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
12 |
|
|
13 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
16 for more details. |
|
|
17 |
|
|
18 You should have received a copy of the GNU General Public License |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
|
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
383
|
24 #if !defined (octave_tree_const_h) |
|
|
25 #define octave_tree_const_h 1 |
|
1
|
26 |
|
455
|
27 #if defined (__GNUG__) |
|
|
28 #pragma interface |
|
|
29 #endif |
|
|
30 |
|
1
|
31 #include <stdlib.h> |
|
|
32 |
|
|
33 #include "builtins.h" |
|
|
34 #include "tree-base.h" |
|
495
|
35 #include "tree-expr.h" |
|
|
36 #include "tc-rep.h" |
|
455
|
37 |
|
|
38 #include "mx-base.h" |
|
|
39 #include "Range.h" |
|
164
|
40 |
|
|
41 class idx_vector; |
|
1
|
42 |
|
|
43 /* |
|
495
|
44 * Constants. |
|
1
|
45 */ |
|
|
46 class |
|
495
|
47 tree_constant : public tree_fvc |
|
1
|
48 { |
|
|
49 friend class tree_constant_rep; |
|
|
50 |
|
|
51 public: |
|
|
52 tree_constant (void) |
|
|
53 { rep = new tree_constant_rep (); rep->count = 1; } |
|
|
54 |
|
|
55 tree_constant (double d) |
|
|
56 { rep = new tree_constant_rep (d); rep->count = 1; } |
|
161
|
57 tree_constant (const Matrix& m) |
|
1
|
58 { rep = new tree_constant_rep (m); rep->count = 1; } |
|
161
|
59 tree_constant (const DiagMatrix& d) |
|
1
|
60 { rep = new tree_constant_rep (d); rep->count = 1; } |
|
455
|
61 tree_constant (const RowVector& v, int pcv = -1) |
|
1
|
62 { rep = new tree_constant_rep (v, pcv); rep->count = 1; } |
|
455
|
63 tree_constant (const ColumnVector& v, int pcv = -1) |
|
1
|
64 { rep = new tree_constant_rep (v, pcv); rep->count = 1; } |
|
|
65 |
|
161
|
66 tree_constant (const Complex& c) |
|
1
|
67 { rep = new tree_constant_rep (c); rep->count = 1; } |
|
161
|
68 tree_constant (const ComplexMatrix& m) |
|
1
|
69 { rep = new tree_constant_rep (m); rep->count = 1; } |
|
161
|
70 tree_constant (const ComplexDiagMatrix& d) |
|
1
|
71 { rep = new tree_constant_rep (d); rep->count = 1; } |
|
455
|
72 tree_constant (const ComplexRowVector& v, int pcv = -1) |
|
1
|
73 { rep = new tree_constant_rep (v, pcv); rep->count = 1; } |
|
455
|
74 tree_constant (const ComplexColumnVector& v, int pcv = -1) |
|
1
|
75 { rep = new tree_constant_rep (v, pcv); rep->count = 1; } |
|
|
76 |
|
|
77 tree_constant (const char *s) |
|
|
78 { rep = new tree_constant_rep (s); rep->count = 1; } |
|
|
79 |
|
|
80 tree_constant (double base, double limit, double inc) |
|
|
81 { rep = new tree_constant_rep (base, limit, inc); rep->count = 1; } |
|
161
|
82 tree_constant (const Range& r) |
|
1
|
83 { rep = new tree_constant_rep (r); rep->count = 1; } |
|
|
84 |
|
|
85 tree_constant (tree_constant_rep::constant_type t) |
|
|
86 { rep = new tree_constant_rep (t); rep->count = 1; } |
|
|
87 |
|
161
|
88 tree_constant (const tree_constant& a) |
|
1
|
89 { rep = a.rep; rep->count++; } |
|
|
90 tree_constant (tree_constant_rep& r) |
|
|
91 { rep = &r; rep->count++; } |
|
|
92 |
|
|
93 ~tree_constant (void); |
|
|
94 |
|
|
95 #if defined (MDEBUG) |
|
|
96 void *operator new (size_t size); |
|
|
97 void operator delete (void *p, size_t size); |
|
|
98 #endif |
|
|
99 |
|
|
100 tree_constant operator = (tree_constant& a) |
|
|
101 { |
|
|
102 if (--rep->count <= 0 && rep != a.rep) |
|
|
103 delete rep; |
|
|
104 |
|
|
105 rep = a.rep; |
|
|
106 rep->count++; |
|
|
107 return *this; |
|
|
108 } |
|
|
109 |
|
164
|
110 int is_constant (void) const { return 1; } |
|
1
|
111 |
|
164
|
112 int is_scalar_type (void) const { return rep->is_scalar_type (); } |
|
|
113 int is_matrix_type (void) const { return rep->is_matrix_type (); } |
|
1
|
114 |
|
164
|
115 int is_real_type (void) const { return rep->is_real_type (); } |
|
|
116 int is_complex_type (void) const { return rep->is_complex_type (); } |
|
1
|
117 |
|
164
|
118 int is_numeric_type (void) const { return rep->is_numeric_type (); } |
|
1
|
119 |
|
164
|
120 int is_numeric_or_range_type (void) const |
|
1
|
121 { return rep->is_numeric_or_range_type (); } |
|
|
122 |
|
164
|
123 int is_string_type (void) const { return rep->is_string_type (); } |
|
1
|
124 |
|
164
|
125 int valid_as_scalar_index (void) const |
|
|
126 { return rep->valid_as_scalar_index (); } |
|
1
|
127 |
|
164
|
128 int is_defined (void) const { return rep->is_defined (); } |
|
|
129 int is_undefined (void) const { return rep->is_undefined (); } |
|
1
|
130 |
|
164
|
131 double to_scalar (void) const { return rep->to_scalar (); } |
|
|
132 ColumnVector to_vector (void) const { return rep->to_vector (); } |
|
|
133 Matrix to_matrix (void) const { return rep->to_matrix (); } |
|
1
|
134 |
|
|
135 tree_constant_rep::constant_type force_numeric (int force_str_conv = 0) |
|
|
136 { return rep->force_numeric (force_str_conv); } |
|
|
137 |
|
164
|
138 tree_constant make_numeric (int force_str_conv = 0) const |
|
1
|
139 { |
|
|
140 if (is_numeric_type ()) |
|
|
141 return *this; |
|
|
142 else |
|
|
143 return rep->make_numeric (force_str_conv); |
|
|
144 } |
|
|
145 |
|
164
|
146 tree_constant make_numeric_or_range (void) const |
|
1
|
147 { |
|
|
148 if (is_numeric_type () |
|
|
149 || rep->type_tag == tree_constant_rep::range_constant) |
|
|
150 return *this; |
|
|
151 else |
|
|
152 return rep->make_numeric (); |
|
|
153 } |
|
|
154 |
|
164
|
155 tree_constant make_numeric_or_magic (void) const |
|
1
|
156 { |
|
|
157 if (is_numeric_type () |
|
|
158 || rep->type_tag == tree_constant_rep::magic_colon) |
|
|
159 return *this; |
|
|
160 else |
|
|
161 return rep->make_numeric (); |
|
|
162 } |
|
|
163 |
|
164
|
164 tree_constant make_numeric_or_range_or_magic (void) const |
|
1
|
165 { |
|
|
166 if (is_numeric_type () |
|
|
167 || rep->type_tag == tree_constant_rep::magic_colon |
|
|
168 || rep->type_tag == tree_constant_rep::range_constant) |
|
|
169 return *this; |
|
|
170 else |
|
|
171 return rep->make_numeric (); |
|
|
172 } |
|
|
173 |
|
|
174 tree_constant assign (tree_constant& rhs, tree_constant *args, int nargs) |
|
|
175 { |
|
|
176 if (rep->count > 1) |
|
|
177 { |
|
|
178 --rep->count; |
|
|
179 rep = new tree_constant_rep (*rep); |
|
|
180 rep->count = 1; |
|
|
181 } |
|
|
182 rep->assign (rhs, args, nargs); |
|
|
183 return *this; |
|
|
184 } |
|
|
185 |
|
276
|
186 int save (ostream& os, int mark_as_global = 0, int precision = 17) |
|
|
187 { return rep->save (os, mark_as_global, precision); } |
|
1
|
188 int save_three_d (ostream& os, int parametric = 0) |
|
|
189 { return rep->save_three_d (os, parametric); } |
|
|
190 |
|
|
191 int load (istream& is) { return rep->load (is); } |
|
|
192 tree_constant_rep::constant_type load |
|
|
193 (istream& is, tree_constant_rep::constant_type t) |
|
|
194 { return rep->load (is, t); } |
|
|
195 |
|
164
|
196 double double_value (void) const { return rep->double_value (); } |
|
|
197 Matrix matrix_value (void) const { return rep->matrix_value (); } |
|
|
198 Complex complex_value (void) const { return rep->complex_value (); } |
|
|
199 ComplexMatrix complex_matrix_value (void) const |
|
1
|
200 { return rep->complex_matrix_value (); } |
|
164
|
201 char *string_value (void) const { return rep->string_value (); } |
|
|
202 Range range_value (void) const { return rep->range_value (); } |
|
1
|
203 |
|
164
|
204 int rows (void) const { return rep->rows (); } |
|
|
205 int columns (void) const { return rep->columns (); } |
|
1
|
206 |
|
208
|
207 int is_empty (void) const |
|
|
208 { |
|
|
209 return (rep->type_tag != tree_constant_rep::magic_colon |
|
|
210 && rep->type_tag != tree_constant_rep::unknown_constant |
|
|
211 && (rows () == 0 || columns () == 0)); |
|
|
212 } |
|
|
213 |
|
|
214 int is_zero_by_zero (void) const |
|
212
|
215 { |
|
|
216 return (rep->type_tag != tree_constant_rep::magic_colon |
|
|
217 && rep->type_tag != tree_constant_rep::unknown_constant |
|
|
218 && rows () == 0 |
|
|
219 && columns () == 0); |
|
|
220 } |
|
208
|
221 |
|
93
|
222 |
|
164
|
223 tree_constant all (void) const { return rep->all (); } |
|
|
224 tree_constant any (void) const { return rep->any (); } |
|
|
225 tree_constant isstr (void) const { return rep->isstr (); } |
|
1
|
226 |
|
|
227 tree_constant convert_to_str (void) { return rep->convert_to_str (); } |
|
|
228 |
|
435
|
229 void convert_to_row_or_column_vector (void) |
|
455
|
230 { rep->convert_to_row_or_column_vector (); } |
|
435
|
231 |
|
428
|
232 int is_true (void) const { return rep->is_true (); } |
|
|
233 |
|
164
|
234 tree_constant cumprod (void) const { return rep->cumprod (); } |
|
|
235 tree_constant cumsum (void) const { return rep->cumsum (); } |
|
|
236 tree_constant prod (void) const { return rep->prod (); } |
|
|
237 tree_constant sum (void) const { return rep->sum (); } |
|
|
238 tree_constant sumsq (void) const { return rep->sumsq (); } |
|
1
|
239 |
|
164
|
240 tree_constant diag (void) const { return rep->diag (); } |
|
|
241 tree_constant diag (const tree_constant& a) const { return rep->diag (a); } |
|
1
|
242 |
|
164
|
243 tree_constant_rep::constant_type const_type (void) const |
|
1
|
244 { return rep->const_type (); } |
|
|
245 |
|
164
|
246 tree_constant mapper (Mapper_fcn& m_fcn, int print) const |
|
1
|
247 { return rep->mapper (m_fcn, print); } |
|
|
248 |
|
|
249 void bump_value (tree::expression_type et) |
|
|
250 { |
|
|
251 if (rep->count > 1) |
|
|
252 { |
|
|
253 --rep->count; |
|
|
254 rep = new tree_constant_rep (*rep); |
|
|
255 rep->count = 1; |
|
|
256 } |
|
|
257 rep->bump_value (et); |
|
|
258 } |
|
|
259 |
|
|
260 tree_constant eval (int print) |
|
495
|
261 { |
|
|
262 rep->maybe_mutate (); |
|
|
263 if (print) |
|
|
264 rep->print (); |
|
|
265 return *this; |
|
|
266 } |
|
1
|
267 |
|
495
|
268 tree_constant *eval (int print, int nargout, |
|
|
269 const tree_constant *args = NULL_TREE_CONST, |
|
|
270 int nargin = 0) |
|
1
|
271 { |
|
|
272 tree_constant *retval = new tree_constant [2]; |
|
495
|
273 |
|
|
274 if (args != NULL_TREE_CONST && nargin > 0) |
|
|
275 retval[0] = rep->do_index (args, nargin); |
|
|
276 else |
|
|
277 retval[0] = *this; |
|
|
278 |
|
|
279 if (retval[0].is_defined ()) |
|
|
280 retval[0].eval (print); |
|
1
|
281 return retval; |
|
|
282 } |
|
|
283 |
|
|
284 private: |
|
|
285 tree_constant_rep *rep; |
|
|
286 }; |
|
|
287 |
|
94
|
288 /* |
|
|
289 * Here are some extra functions that are related to the tree_constant |
|
|
290 * class but that don't need to be class members or friends. |
|
|
291 */ |
|
|
292 |
|
164
|
293 extern tree_constant *vector_of_empties (int nargout, const char *fcn_name); |
|
94
|
294 |
|
495
|
295 extern tree_constant fill_matrix (const tree_constant& a, |
|
|
296 double d, const char *warn_for); |
|
|
297 extern tree_constant fill_matrix (const tree_constant& a, |
|
|
298 const tree_constant& b, |
|
|
299 double d, const char *warn_for); |
|
|
300 |
|
|
301 extern tree_constant identity_matrix (const tree_constant& a); |
|
|
302 extern tree_constant identity_matrix (const tree_constant& a, |
|
|
303 const tree_constant& b); |
|
|
304 |
|
|
305 extern tree_constant find_nonzero_elem_idx (const tree_constant& a); |
|
|
306 |
|
|
307 extern tree_constant *matrix_log (const tree_constant& a); |
|
|
308 extern tree_constant *matrix_sqrt (const tree_constant& a); |
|
|
309 |
|
|
310 extern tree_constant *column_max (const tree_constant *args, int nargin, |
|
|
311 int nargout); |
|
|
312 |
|
|
313 extern tree_constant *column_min (const tree_constant *args, int nargin, |
|
|
314 int nargout); |
|
|
315 |
|
|
316 extern tree_constant *sort (const tree_constant *args, int nargin, |
|
|
317 int nargout); |
|
|
318 |
|
|
319 extern tree_constant *feval (const tree_constant *args, int nargin, |
|
|
320 int nargout); |
|
|
321 |
|
|
322 extern tree_constant eval_string (const tree_constant& arg, int& |
|
|
323 parse_status); |
|
|
324 |
|
|
325 extern tree_constant get_user_input (const tree_constant *args, |
|
|
326 int nargin, int nargout, |
|
|
327 int debug = 0); |
|
|
328 |
|
1
|
329 #endif |
|
|
330 |
|
|
331 /* |
|
|
332 ;;; Local Variables: *** |
|
|
333 ;;; mode: C++ *** |
|
|
334 ;;; page-delimiter: "^/\\*" *** |
|
|
335 ;;; End: *** |
|
|
336 */ |
