|
1
|
1 // builtins.cc -*- C++ -*- |
|
|
2 /* |
|
|
3 |
|
|
4 Copyright (C) 1992, 1993 John W. Eaton |
|
|
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 |
|
|
24 #ifdef __GNUG__ |
|
|
25 #pragma implementation |
|
|
26 #endif |
|
|
27 |
|
|
28 #include <iostream.h> |
|
|
29 #include <math.h> |
|
|
30 #include <float.h> |
|
|
31 |
|
|
32 #include "tree-const.h" |
|
|
33 #include "symtab.h" |
|
|
34 #include "t-builtins.h" |
|
|
35 #include "g-builtins.h" |
|
|
36 #include "builtins.h" |
|
|
37 #include "octave.h" |
|
|
38 #include "utils.h" |
|
|
39 #include "tree.h" |
|
|
40 #include "mappers.h" |
|
|
41 #include "user-prefs.h" |
|
|
42 #include "variables.h" |
|
|
43 |
|
|
44 // NOTE: nargin == 1 means that the function takes no arguments (just |
|
|
45 // like C, the first argument is (or should be, anyway) the function |
|
|
46 // name). Also, -1 is shorthand for infinity. |
|
|
47 |
|
|
48 // The following initializations may eventually need to be reworked |
|
|
49 // like the builtin functions in bash were around version 1.12... |
|
|
50 |
|
|
51 static builtin_mapper_functions mapper_functions[] = |
|
|
52 { |
|
|
53 { "abs", 2, 1, 0, fabs, abs, NULL, |
|
|
54 "compute abs(X) for each element of X\n", }, |
|
|
55 |
|
|
56 { "acos", 2, 1, 0, acos, NULL, acos, |
|
|
57 "compute acos(X) for each element of X\n", }, |
|
|
58 |
|
|
59 { "acosh", 2, 1, 0, acosh, NULL, acosh, |
|
|
60 "compute acosh(X) for each element of X\n", }, |
|
|
61 |
|
|
62 { "angle", 2, 1, 0, arg, arg, NULL, |
|
|
63 "compute arg(X) for each element of X\n", }, |
|
|
64 |
|
|
65 { "arg", 2, 1, 0, arg, arg, NULL, |
|
|
66 "compute arg(X) for each element of X\n", }, |
|
|
67 |
|
|
68 { "asin", 2, 1, 0, asin, NULL, asin, |
|
|
69 "compute asin(X) for each element of X\n", }, |
|
|
70 |
|
|
71 { "asinh", 2, 1, 0, asinh, NULL, asinh, |
|
|
72 "compute asinh(X) for each element of X\n", }, |
|
|
73 |
|
|
74 { "atan", 2, 1, 0, atan, NULL, atan, |
|
|
75 "compute atan(X) for each element of X\n", }, |
|
|
76 |
|
|
77 { "atanh", 2, 1, 0, atanh, NULL, atanh, |
|
|
78 "compute atanh(X) for each element of X\n", }, |
|
|
79 |
|
|
80 { "ceil", 2, 1, 0, ceil, NULL, ceil, |
|
|
81 "ceil(X): round elements of X toward +Inf\n", }, |
|
|
82 |
|
|
83 { "conj", 2, 1, 0, conj, NULL, conj, |
|
|
84 "compute complex conjugate for each element of X\n", }, |
|
|
85 |
|
|
86 { "cos", 2, 1, 0, cos, NULL, cos, |
|
|
87 "compute cos(X) for each element of X\n", }, |
|
|
88 |
|
|
89 { "cosh", 2, 1, 0, cosh, NULL, cosh, |
|
|
90 "compute cosh(X) for each element of X\n", }, |
|
|
91 |
|
|
92 { "exp", 2, 1, 0, exp, NULL, exp, |
|
|
93 "compute exp(X) for each element of X\n", }, |
|
|
94 |
|
|
95 { "finite", 2, 1, 0, xfinite, xfinite, NULL, |
|
|
96 "finite(X): return 1 for finite elements of X\n", }, |
|
|
97 |
|
|
98 { "fix", 2, 1, 0, fix, NULL, fix, |
|
|
99 "fix(X): round elements of X toward zero\n", }, |
|
|
100 |
|
|
101 { "floor", 2, 1, 0, floor, NULL, floor, |
|
|
102 "floor(X): round elements of X toward -Inf\n", }, |
|
|
103 |
|
|
104 { "isinf", 2, 1, 0, xisinf, xisinf, NULL, |
|
|
105 "isinf(X): return 1 for elements of X infinite\n", }, |
|
|
106 |
|
|
107 { "imag", 2, 1, 0, imag, imag, NULL, |
|
|
108 "return imaginary part for each elements of X\n", }, |
|
|
109 |
|
|
110 #ifdef HAVE_ISNAN |
|
|
111 { "isnan", 2, 1, 0, xisnan, xisnan, NULL, |
|
|
112 "isnan(X): return 1 where elements of X are NaNs\n", }, |
|
|
113 #endif |
|
|
114 |
|
|
115 { "log", 2, 1, 1, log, NULL, log, |
|
|
116 "compute log(X) for each element of X\n", }, |
|
|
117 |
|
|
118 { "log10", 2, 1, 1, log10, NULL, log10, |
|
|
119 "compute log10(X) for each element of X\n", }, |
|
|
120 |
|
|
121 { "real", 2, 1, 0, real, real, NULL, |
|
|
122 "return real part for each element of X\n", }, |
|
|
123 |
|
|
124 { "round", 2, 1, 0, round, NULL, round, |
|
|
125 "round(X): round elements of X to nearest integer\n", }, |
|
|
126 |
|
|
127 { "sign", 2, 1, 0, signum, NULL, signum, |
|
|
128 "sign(X): apply signum function to elements of X\n", }, |
|
|
129 |
|
|
130 { "sin", 2, 1, 0, sin, NULL, sin, |
|
|
131 "compute sin(X) for each element of X\n", }, |
|
|
132 |
|
|
133 { "sinh", 2, 1, 0, sinh, NULL, sinh, |
|
|
134 "compute sinh(X) for each element of X\n", }, |
|
|
135 |
|
|
136 { "sqrt", 2, 1, 1, sqrt, NULL, sqrt, |
|
|
137 "compute sqrt(X) for each element of X\n", }, |
|
|
138 |
|
|
139 { "tan", 2, 1, 0, tan, NULL, tan, |
|
|
140 "compute tan(X) for each element of X\n", }, |
|
|
141 |
|
|
142 { "tanh", 2, 1, 0, tanh, NULL, tanh, |
|
|
143 "compute tanh(X) for each element of X\n", }, |
|
|
144 |
|
|
145 { NULL, -1, -1, -1, NULL, NULL, NULL, NULL, }, |
|
|
146 }; |
|
|
147 |
|
|
148 static builtin_text_functions text_functions[] = |
|
|
149 { |
|
|
150 { "casesen", 2, builtin_casesen, |
|
|
151 "print warning if user tries to change case sensitivity\n", }, |
|
|
152 |
|
|
153 { "cd", 2, builtin_cd, |
|
|
154 "change current working directory\n", }, |
|
|
155 |
|
|
156 { "clear", -1, builtin_clear, |
|
|
157 "clear symbol(s) from symbol table\n", }, |
|
|
158 |
|
|
159 { "dir", -1, builtin_ls, |
|
|
160 "print a directory listing\n", }, |
|
|
161 |
|
|
162 { "document", -1, builtin_document, |
|
|
163 "define help string for symbol\n", }, |
|
|
164 |
|
|
165 { "edit_history", -1, builtin_edit_history, |
|
|
166 "usage: edit_history [first] [last]\n", }, |
|
|
167 |
|
|
168 { "format", -1, builtin_format, |
|
|
169 "set output formatting style\n", }, |
|
|
170 |
|
|
171 { "help", -1, builtin_help, |
|
|
172 "print cryptic yet witty messages\n", }, |
|
|
173 |
|
|
174 { "history", -1, builtin_history, |
|
|
175 "print/save/load command history\n", }, |
|
|
176 |
|
|
177 { "load", -1, builtin_load, |
|
|
178 "load variables from a file\n", }, |
|
|
179 |
|
|
180 { "ls", -1, builtin_ls, |
|
|
181 "print a directory listing\n", }, |
|
|
182 |
|
|
183 { "save", -1, builtin_save, |
|
|
184 "save variables to a file\n", }, |
|
|
185 |
|
|
186 { "set", -1, builtin_set, |
|
|
187 "set plotting options\n", }, |
|
|
188 |
|
|
189 { "show", -1, builtin_show, |
|
|
190 "show plotting options\n", }, |
|
|
191 |
|
|
192 { "who", -1, builtin_who, |
|
|
193 "list symbols\n", }, |
|
|
194 |
|
|
195 { NULL, -1, NULL, NULL, }, |
|
|
196 }; |
|
|
197 |
|
|
198 static builtin_general_functions general_functions[] = |
|
|
199 { |
|
|
200 { "all", 2, 1, builtin_all, |
|
|
201 "all(X): are all elements of X nonzero?\n", }, |
|
|
202 |
|
|
203 { "any", 2, 1, builtin_any, |
|
|
204 "any(X): are any elements of X nonzero?\n", }, |
|
|
205 |
|
|
206 { "clc", 1, 0, builtin_clc, |
|
|
207 "clear screen\n", }, |
|
|
208 |
|
|
209 { "clock", 1, 0, builtin_clock, |
|
|
210 "return current date and time in vector\n", }, |
|
|
211 |
|
|
212 { "closeplot", 1, 0, builtin_closeplot, |
|
|
213 "close the stream to plotter\n", }, |
|
|
214 |
|
|
215 { "colloc", 7, 4, builtin_colloc, |
|
|
216 "[r, A, B, q] = colloc (n [, 'left'] [, 'right']): collocation weights\n", }, |
|
|
217 |
|
|
218 { "cumprod", 2, 1, builtin_cumprod, |
|
|
219 "cumprod (X): cumulative products\n", }, |
|
|
220 |
|
|
221 { "cumsum", 2, 1, builtin_cumsum, |
|
|
222 "cumsum (X): cumulative sums\n", }, |
|
|
223 |
|
|
224 { "dassl", 5, 1, builtin_dassl, |
|
|
225 "solve DAEs using Petzold's DASSL. Usage:\n\ |
|
|
226 \n\ |
|
|
227 dassl ('function_name', x_0, xdot_0, t_out)\n\ |
|
|
228 dassl ('function_name', x_0, xdot_0, t_out, t_crit)\n\ |
|
|
229 \n\ |
|
|
230 The first argument is the name of the function to call to\n\ |
|
|
231 compute the vector of residuals. It must have the form\n\ |
|
|
232 \n\ |
|
|
233 res = f (x, xdot, t)\n\ |
|
|
234 \n\ |
|
|
235 where x, xdot, and res are vectors, and t is a scalar.\n\n", }, |
|
|
236 |
|
|
237 { "date", 1, 0, builtin_date, |
|
|
238 "return current date in a string\n", }, |
|
|
239 |
|
|
240 { "det", 2, 1, builtin_det, |
|
|
241 "det(X): determinant of a square matrix\n", }, |
|
|
242 |
|
|
243 { "diag", 3, 1, builtin_diag, |
|
|
244 "diag(X [,k]): form/extract diagonals\n", }, |
|
|
245 |
|
|
246 { "disp", 3, 1, builtin_disp, |
|
|
247 "disp(X): display value\n", }, |
|
|
248 |
|
|
249 { "eig", 2, 1, builtin_eig, |
|
|
250 "eig (x): compute eigenvalues and eigenvectors of x\n", }, |
|
|
251 |
|
|
252 { "error", 2, 1, builtin_error, |
|
|
253 "print message and jump to top level\n", }, |
|
|
254 |
|
|
255 { "eval", 2, 1, builtin_eval, |
|
|
256 "evaluate text as octave source\n", }, |
|
|
257 |
|
|
258 { "exist", 2, 1, builtin_exist, |
|
|
259 "check if variable or file exists\n", }, |
|
|
260 |
|
|
261 { "exit", 1, 0, builtin_quit, |
|
|
262 "exit Octave gracefully\n", }, |
|
|
263 |
|
|
264 { "expm", 2, 1, builtin_expm, |
|
|
265 "Matrix exponential, e^A\n", }, |
|
|
266 |
|
|
267 { "eye", 3, 1, builtin_eye, |
|
|
268 "create an identity matrix\n", }, |
|
|
269 |
|
|
270 { "fclose", 2, 1, builtin_fclose, |
|
|
271 "fclose('filename' or filenum): close a file\n", }, |
|
|
272 |
|
|
273 { "feval", -1, 1, builtin_feval, |
|
|
274 "evaluate argument as function\n", }, |
|
|
275 |
|
|
276 { "fflush", 2, 1, builtin_fflush, |
|
|
277 "fflush('filename' or filenum): flush buffered data to output file\n", }, |
|
|
278 |
|
|
279 { "fft", 2, 1, builtin_fft, |
|
|
280 "fft(X): fast fourier transform of a vector\n", }, |
|
|
281 |
|
|
282 { "fgets",3, 2, builtin_fgets, |
|
|
283 "[string, length] = fgets('filename' or filenum, length): read a string from a file\n", }, |
|
|
284 |
|
|
285 { "find", -1, 1, builtin_find, |
|
|
286 "find (x): return vector of indices of nonzero elements\n", }, |
|
|
287 |
|
|
288 { "flops", 2, 1, builtin_flops, |
|
|
289 "count floating point operations\n", }, |
|
|
290 |
|
|
291 { "fopen", 3, 1, builtin_fopen, |
|
|
292 "filenum = fopen('filename','mode'): open a file\n", }, |
|
|
293 |
|
|
294 { "fprintf", -1, 1, builtin_fprintf, |
|
|
295 "fprintf ('file', 'fmt', ...)\n", }, |
|
|
296 |
|
|
297 { "freport", 1, 1, builtin_freport, |
|
|
298 "freport: list open files and their status\n", }, |
|
|
299 |
|
|
300 { "frewind", 2, 1, builtin_frewind, |
|
|
301 "frewind('filename' or filenum): set file position at beginning of file\n", }, |
|
|
302 |
|
|
303 { "fscanf", 3, -1, builtin_fscanf, |
|
|
304 "[a,b,c...] = fscanf ('file', 'fmt')\n", }, |
|
|
305 |
|
|
306 { "fseek", 4, 1, builtin_fseek, |
|
|
307 "fseek('filename' or filenum): set file position for reading or writing\n", }, |
|
|
308 |
|
|
309 { "fsolve", 5, 1, builtin_fsolve, |
|
|
310 "Solve nonlinear equations using Minpack. Usage:\n\ |
|
|
311 \n\ |
|
|
312 [x, info] = fsolve ('f', x0)\n\ |
|
|
313 \n\ |
|
|
314 Where the first argument is the name of the function to call to\n\ |
|
|
315 compute the vector of function values. It must have the form\n\ |
|
|
316 \n\ |
|
|
317 y = f (x) |
|
|
318 \n\ |
|
|
319 where y and x are vectors.\n\n", }, |
|
|
320 |
|
|
321 { "fsqp", 11, 3, builtin_fsqp, |
|
|
322 "solve NLPs\n", }, |
|
|
323 |
|
|
324 { "ftell", 2, 1, builtin_ftell, |
|
|
325 "position = ftell ('filename' or filenum): returns the current file position\n", }, |
|
|
326 |
|
|
327 { "getenv", 2, 1, builtin_getenv, |
|
|
328 "get environment variable values\n", }, |
|
|
329 |
|
|
330 { "hess", 2, 2, builtin_hess, |
|
|
331 "Hessenburg decomposition\n",}, |
|
|
332 |
|
|
333 { "home", 1, 0, builtin_clc, |
|
|
334 "clear screen\n", }, |
|
|
335 |
|
|
336 { "input", 3, 1, builtin_input, |
|
|
337 "input('prompt' [,'s']): prompt user for [string] input\n", }, |
|
|
338 |
|
|
339 { "ifft", 2, 1, builtin_ifft, |
|
|
340 "ifft(X): inverse fast fourier transform of a vector\n", }, |
|
|
341 |
|
|
342 { "inv", 2, 1, builtin_inv, |
|
|
343 "inv(X): inverse of a square matrix\n", }, |
|
|
344 |
|
|
345 { "inverse", 2, 1, builtin_inv, |
|
|
346 "inverse(X): inverse of a square matrix\n", }, |
|
|
347 |
|
|
348 { "isstr", 2, 1, builtin_isstr, |
|
|
349 "isstr(X): return 1 if X is a string\n", }, |
|
|
350 |
|
|
351 { "keyboard", 2, 1, builtin_keyboard, |
|
|
352 "maybe help in debugging M-files\n", }, |
|
|
353 |
|
|
354 { "logm", 2, 1, builtin_logm, |
|
|
355 "Matrix logarithm, log (A)\n", }, |
|
|
356 |
|
|
357 { "lpsolve", 11, 3, builtin_lpsolve, |
|
|
358 "Solve linear programs using lp_solve.\n", }, |
|
|
359 |
|
|
360 { "lsode", 6, 1, builtin_lsode, |
|
|
361 "solve ODEs using Hindmarsh's LSODE. Usage:\n\ |
|
|
362 \n\ |
|
|
363 lsode ('function_name', x0, t_out\n\ |
|
|
364 lsode ('function_name', x0, t_out, t_crit)\n\ |
|
|
365 \n\ |
|
|
366 The first argument is the name of the function to call to\n\ |
|
|
367 compute the vector of right hand sides. It must have the form\n\ |
|
|
368 \n\ |
|
|
369 xdot = f (x, t)\n\ |
|
|
370 \n\ |
|
|
371 where xdot and x are vectors and t is a scalar.\n\n", }, |
|
|
372 |
|
|
373 { "lu", 2, 3, builtin_lu, |
|
|
374 "[L, U, P] = lu (A) -- LU factorization\n", }, |
|
|
375 |
|
|
376 { "max", 3, 2, builtin_max, |
|
|
377 "maximum value(s) of a vector (matrix)\n", }, |
|
|
378 |
|
|
379 { "min", 3, 2, builtin_min, |
|
|
380 "minimum value(s) of a vector (matrix)\n", }, |
|
|
381 |
|
|
382 { "npsol", 11, 3, builtin_npsol, |
|
|
383 "Solve nonlinear programs using Gill and Murray's NPSOL. Usage:\n\ |
|
|
384 \n\ |
|
|
385 [x, obj, info, lambda] = npsol (x, 'phi' [, lb, ub] [, lb, A, ub] [, lb, 'g', ub])\n\n\ |
|
|
386 Groups of arguments surrounded in `[]' are optional, but\n\ |
|
|
387 must appear in the same relative order shown above.\n\ |
|
|
388 \n\ |
|
|
389 The second argument is a string containing the name of the objective\n\ |
|
|
390 function to call. The objective function must be of the form\n\ |
|
|
391 \n\ |
|
|
392 y = phi (x)\n\ |
|
|
393 \n\ |
|
|
394 where x is a vector and y is a scalar.\n\n", }, |
|
|
395 |
|
|
396 { "ones", 3, 1, builtin_ones, |
|
|
397 "create a matrix of all ones\n", }, |
|
|
398 |
|
|
399 { "pause", 1, 0, builtin_pause, |
|
|
400 "suspend program execution\n", }, |
|
|
401 |
|
|
402 { "purge_tmp_files", 5, 1, builtin_purge_tmp_files, |
|
|
403 "delete temporary data files used for plotting\n", }, |
|
|
404 |
|
|
405 { "printf", -1, 1, builtin_printf, |
|
|
406 "printf ('fmt', ...)\n", }, |
|
|
407 |
|
|
408 { "prod", 2, 1, builtin_prod, |
|
|
409 "prod (X): products\n", }, |
|
|
410 |
|
|
411 { "pwd", 1, 0, builtin_pwd, |
|
|
412 "print current working directory\n", }, |
|
|
413 |
|
|
414 { "qpsol", 9, 3, builtin_qpsol, |
|
|
415 "Solve nonlinear programs using Gill and Murray's QPSOL. Usage:\n\ |
|
|
416 \n\ |
|
|
417 [x, obj, info, lambda] = qpsol (x, H, c [, lb, ub] [, lb, A, ub])\n\ |
|
|
418 \n\ |
|
|
419 Groups of arguments surrounded in `[]' are optional, but\n\ |
|
|
420 must appear in the same relative order shown above.", }, |
|
|
421 |
|
|
422 { "qr", 2, 2, builtin_qr, |
|
|
423 "[q, r] = qr (X): form QR factorization of X\n", }, |
|
|
424 |
|
|
425 { "quad", 6, 3, builtin_quad, |
|
|
426 "Integrate a nonlinear function of one variable using Quadpack.\n\ |
|
|
427 Usage:\n\ |
|
|
428 \n\ |
|
|
429 [v, ier, nfun] = quad ('f', a, b [, tol] [, sing])\n\ |
|
|
430 \n\ |
|
|
431 Where the first argument is the name of the function to call to\n\ |
|
|
432 compute the value of the integrand. It must have the form\n\ |
|
|
433 \n\ |
|
|
434 y = f (x) |
|
|
435 \n\ |
|
|
436 where y and x are scalars.\n\ |
|
|
437 \n\ |
|
|
438 The second and third arguments are limits of integration. Either or\n\ |
|
|
439 both may be infinite. The optional argument tol specifies the desired\n\ |
|
|
440 accuracy of the result. The optional argument sing is a vector of\n\ |
|
|
441 at which the integrand is singular.\n\n", }, |
|
|
442 |
|
|
443 { "quit", 1, 0, builtin_quit, |
|
|
444 "exit Octave gracefully\n", }, |
|
|
445 |
|
|
446 { "rand", 2, 1, builtin_rand, |
|
|
447 "matrices with random elements\n", }, |
|
|
448 |
|
|
449 { "replot", 1, 0, builtin_replot, |
|
|
450 "redisplay current plot\n", }, |
|
|
451 |
|
|
452 { "scanf", 2, -1, builtin_scanf, |
|
|
453 "[a,b,c...] = scanf ('fmt')\n", }, |
|
|
454 |
|
|
455 { "setstr", 2, 1, builtin_setstr, |
|
|
456 "setstr (v): convert a vector to a string\n", }, |
|
|
457 |
|
|
458 { "shell_cmd", 2, 1, builtin_shell_command, |
|
|
459 "shell_cmd (string [, return_output]): execute shell commands\n", }, |
|
|
460 |
|
|
461 { "schur", 3, 2, builtin_schur, |
|
|
462 "returns the Schur (straight or ordered) decomposition of matrix\n", }, |
|
|
463 |
|
|
464 { "size", 2, 1, builtin_size, |
|
|
465 "size(X): return rows and columns of X\n", }, |
|
|
466 |
|
|
467 { "sort", 2, 2, builtin_sort, |
|
|
468 "[s,i] = sort(x): sort the columns of x, optionally return sort index\n", }, |
|
|
469 |
|
|
470 { "sqrtm", 2, 1, builtin_sqrtm, |
|
|
471 "Matrix sqrt, sqrt (A)\n", }, |
|
|
472 |
|
|
473 { "sprintf", -1, 1, builtin_sprintf, |
|
|
474 "s = sprintf ('fmt', ...)\n", }, |
|
|
475 |
|
|
476 { "sscanf", 3, -1, builtin_sscanf, |
|
|
477 "[a,b,c...] = sscanf (string, 'fmt')\n", }, |
|
|
478 |
|
|
479 { "sum", 2, 1, builtin_sum, |
|
|
480 "sum (X): sum of elements\n", }, |
|
|
481 |
|
|
482 { "sumsq", 2, 1, builtin_sumsq, |
|
|
483 "sumsq (X): sum of squares of elements\n", }, |
|
|
484 |
|
|
485 { "svd", 2, 3, builtin_svd, |
|
|
486 "[U,S,V] = svd(X): return SVD of X\n", }, |
|
|
487 |
|
|
488 { "warranty", 1, 0, builtin_warranty, |
|
|
489 "describe copying conditions\n", }, |
|
|
490 |
|
|
491 { "zeros", 3, 1, builtin_zeros, |
|
|
492 "create a matrix of all zeros\n", }, |
|
|
493 |
|
|
494 { NULL, -1, -1, NULL, NULL, }, |
|
|
495 }; |
|
|
496 |
|
|
497 // This is a lie. Some of these get reassigned to be numeric |
|
|
498 // variables. See below. |
|
|
499 |
|
|
500 static builtin_string_variables string_variables[] = |
|
|
501 { |
|
|
502 { "I", "??", NULL, |
|
|
503 "sqrt (-1)\n", }, |
|
|
504 |
|
|
505 { "Inf", "??", NULL, |
|
|
506 "infinity\n", }, |
|
|
507 |
|
|
508 { "J", "??", NULL, |
|
|
509 "sqrt (-1)\n", }, |
|
|
510 |
|
|
511 #if defined (HAVE_ISNAN) |
|
|
512 { "NaN", "??", NULL, |
|
|
513 "not a number\n", }, |
|
|
514 #endif |
|
|
515 |
|
|
516 { "LOADPATH", "??", sv_loadpath, |
|
|
517 "colon separated list of directories to search for scripts\n", }, |
|
|
518 |
|
|
519 { "PAGER", "??", sv_pager_binary, |
|
|
520 "path to pager binary\n", }, |
|
|
521 |
|
|
522 { "PS1", "\\s:\\#> ", sv_ps1, |
|
|
523 "primary prompt string\n", }, |
|
|
524 |
|
|
525 { "PS2", "> ", sv_ps2, |
|
|
526 "secondary prompt string\n", }, |
|
|
527 |
|
|
528 { "PWD", "??PWD??", sv_pwd, |
|
|
529 "current working directory\n", }, |
|
|
530 |
|
|
531 { "SEEK_SET", "??", NULL, |
|
|
532 "used with fseek to position file relative to the beginning\n", }, |
|
|
533 |
|
|
534 { "SEEK_CUR", "??", NULL, |
|
|
535 "used with fseek to position file relative to the current position\n", }, |
|
|
536 |
|
|
537 { "SEEK_END", "??", NULL, |
|
|
538 "used with fseek to position file relative to the end\n", }, |
|
|
539 |
|
|
540 { "do_fortran_indexing", "false", do_fortran_indexing, |
|
|
541 "allow single indices for matrices\n", }, |
|
|
542 |
|
|
543 { "empty_list_elements_ok", "warn", empty_list_elements_ok, |
|
|
544 "ignore the empty element in expressions like `a = [[], 1]'\n", }, |
|
|
545 |
|
|
546 { "eps", "??", NULL, |
|
|
547 "machine precision\n", }, |
|
|
548 |
|
|
549 { "gnuplot_binary", "gnuplot", sv_gnuplot_binary, |
|
|
550 "path to gnuplot binary\n", }, |
|
|
551 |
|
|
552 { "i", "??", NULL, |
|
|
553 "sqrt (-1)\n", }, |
|
|
554 |
|
|
555 { "implicit_str_to_num_ok", "false", implicit_str_to_num_ok, |
|
|
556 "allow implicit string to number conversion\n", }, |
|
|
557 |
|
|
558 { "inf", "??", NULL, |
|
|
559 "infinity\n", }, |
|
|
560 |
|
|
561 { "j", "??", NULL, |
|
|
562 "sqrt (-1)\n", }, |
|
|
563 |
|
|
564 #if defined (HAVE_ISNAN) |
|
|
565 { "nan", "??", NULL, |
|
|
566 "not a number\n", }, |
|
|
567 #endif |
|
|
568 |
|
|
569 { "ok_to_lose_imaginary_part", "warn", ok_to_lose_imaginary_part, |
|
|
570 "silently convert from complex to real by dropping imaginary part\n", }, |
|
|
571 |
|
|
572 { "output_max_field_width", "??", set_output_max_field_width, |
|
|
573 "maximum width of an output field for numeric output\n", }, |
|
|
574 |
|
|
575 { "output_precision", "??", set_output_precision, |
|
|
576 "number of significant figures to display for numeric output\n", }, |
|
|
577 |
|
|
578 { "page_screen_output", "true", page_screen_output, |
|
|
579 "if possible, send output intended for the screen through the pager\n", }, |
|
|
580 |
|
|
581 { "pi", "??", NULL, |
|
|
582 "ratio of the circumference of a circle to its diameter\n", }, |
|
|
583 |
|
|
584 { "prefer_column_vectors", "true", prefer_column_vectors, |
|
|
585 "prefer column/row vectors\n", }, |
|
|
586 |
|
|
587 { "prefer_zero_one_indexing", "false", prefer_zero_one_indexing, |
|
|
588 "when there is a conflict, prefer zero-one style indexing\n", }, |
|
|
589 |
|
|
590 { "print_answer_id_name", "true", print_answer_id_name, |
|
|
591 "set output style to print `var_name = ...'\n", }, |
|
|
592 |
|
|
593 { "print_empty_dimensions", "true", print_empty_dimensions, |
|
|
594 "also print dimensions of empty matrices\n", }, |
|
|
595 |
|
|
596 { "propagate_empty_matrices", "true", propagate_empty_matrices, |
|
|
597 "operations on empty matrices return an empty matrix, not an error\n", }, |
|
|
598 |
|
|
599 { "resize_on_range_error", "true", resize_on_range_error, |
|
|
600 "enlarge matrices on assignment\n", }, |
|
|
601 |
|
|
602 { "return_last_computed_value", "false", return_last_computed_value, |
|
|
603 "if a function does not return any values explicitly, return the\n\ |
|
|
604 last computed value\n", }, |
|
|
605 |
|
|
606 { "silent_functions", "false", silent_functions, |
|
|
607 "suppress printing results in called functions\n", }, |
|
|
608 |
|
|
609 { "split_long_rows", "true", split_long_rows, |
|
|
610 "split long matrix rows instead of wrapping\n", }, |
|
|
611 |
|
|
612 { "stdin", "??", NULL, |
|
|
613 "file number of the standard input stream\n", }, |
|
|
614 |
|
|
615 { "stdout", "??", NULL, |
|
|
616 "file number of the standard output stream\n", }, |
|
|
617 |
|
|
618 { "stderr", "??", NULL, |
|
|
619 "file number of the standard error stream\n", }, |
|
|
620 |
|
|
621 { "treat_neg_dim_as_zero", "false", treat_neg_dim_as_zero, |
|
|
622 "convert negative dimensions to zero\n", }, |
|
|
623 |
|
|
624 { "warn_assign_as_truth_value", "true", warn_assign_as_truth_value, |
|
|
625 "produce warning for assignments used as truth values\n", }, |
|
|
626 |
|
|
627 { "warn_comma_in_global_decl", "true", warn_comma_in_global_decl, |
|
|
628 "produce warning for commas in global declarations\n", }, |
|
|
629 |
|
|
630 { "warn_divide_by_zero", "true", warn_divide_by_zero, |
|
|
631 "on IEEE machines, allow divide by zero errors to be suppressed\n", }, |
|
|
632 |
|
|
633 { NULL, NULL, NULL, NULL, }, |
|
|
634 }; |
|
|
635 |
|
|
636 void |
|
|
637 make_eternal (char *s) |
|
|
638 { |
|
|
639 symbol_record *sym_rec = curr_sym_tab->lookup (s, 0, 0); |
|
|
640 if (sym_rec != (symbol_record *) NULL) |
|
|
641 sym_rec->make_eternal (); |
|
|
642 } |
|
|
643 |
|
|
644 void |
|
|
645 install_builtins (void) |
|
|
646 { |
|
|
647 symbol_record *sym_rec; |
|
|
648 |
|
|
649 tree_builtin *tb_tmp; |
|
|
650 |
|
|
651 // So that the clear function can't delete other builtin variables and |
|
|
652 // functions, they are given eternal life. |
|
|
653 |
|
|
654 builtin_mapper_functions *mfptr = mapper_functions; |
|
|
655 while (mfptr->name != (char *) NULL) |
|
|
656 { |
|
|
657 sym_rec = curr_sym_tab->lookup (mfptr->name, 1); |
|
|
658 sym_rec->unprotect (); |
|
|
659 |
|
|
660 Mapper_fcn mfcn; |
|
|
661 mfcn.neg_arg_complex = mfptr->neg_arg_complex; |
|
|
662 mfcn.d_d_mapper = mfptr->d_d_mapper; |
|
|
663 mfcn.d_c_mapper = mfptr->d_c_mapper; |
|
|
664 mfcn.c_c_mapper = mfptr->c_c_mapper; |
|
|
665 |
|
|
666 tb_tmp = new tree_builtin (mfptr->nargin_max, mfptr->nargout_max, |
|
|
667 mfcn, sym_rec); |
|
|
668 |
|
|
669 sym_rec->define (tb_tmp); |
|
|
670 sym_rec->document (mfptr->help_string); |
|
|
671 sym_rec->make_eternal (); |
|
|
672 sym_rec->protect (); |
|
|
673 mfptr++; |
|
|
674 } |
|
|
675 |
|
|
676 builtin_text_functions *tfptr = text_functions; |
|
|
677 while (tfptr->name != (char *) NULL) |
|
|
678 { |
|
|
679 sym_rec = curr_sym_tab->lookup (tfptr->name, 1); |
|
|
680 sym_rec->unprotect (); |
|
|
681 |
|
|
682 tb_tmp = new tree_builtin (tfptr->nargin_max, 1, |
|
|
683 tfptr->text_fcn, sym_rec); |
|
|
684 |
|
|
685 sym_rec->define (tb_tmp); |
|
|
686 sym_rec->document (tfptr->help_string); |
|
|
687 sym_rec->make_eternal (); |
|
|
688 sym_rec->protect (); |
|
|
689 tfptr++; |
|
|
690 } |
|
|
691 |
|
|
692 builtin_general_functions *gfptr = general_functions; |
|
|
693 while (gfptr->name != (char *) NULL) |
|
|
694 { |
|
|
695 sym_rec = curr_sym_tab->lookup (gfptr->name, 1); |
|
|
696 sym_rec->unprotect (); |
|
|
697 |
|
|
698 tb_tmp = new tree_builtin (gfptr->nargin_max, gfptr->nargout_max, |
|
|
699 gfptr->general_fcn, sym_rec); |
|
|
700 |
|
|
701 sym_rec->define (tb_tmp); |
|
|
702 sym_rec->document (gfptr->help_string); |
|
|
703 sym_rec->make_eternal (); |
|
|
704 sym_rec->protect (); |
|
|
705 gfptr++; |
|
|
706 } |
|
|
707 |
|
|
708 // Most built-in variables are not protected because the user should |
|
|
709 // be able to redefine them. |
|
|
710 |
|
|
711 builtin_string_variables *svptr = string_variables; |
|
|
712 while (svptr->name != (char *) NULL) |
|
|
713 { |
|
|
714 sym_rec = curr_sym_tab->lookup (svptr->name, 1); |
|
|
715 sym_rec->unprotect (); |
|
|
716 |
|
|
717 tree_constant *tmp = new tree_constant (svptr->value); |
|
|
718 |
|
|
719 sym_rec->set_sv_function (svptr->sv_function); |
|
|
720 sym_rec->define (tmp); |
|
|
721 sym_rec->document (svptr->help_string); |
|
|
722 sym_rec->make_eternal (); |
|
|
723 svptr++; |
|
|
724 } |
|
|
725 |
|
|
726 // XXX FIXME XXX -- Need a convenient way to document these variables. |
|
|
727 |
|
|
728 // IMPORTANT: Always create a new tree_constant for each variable. |
|
|
729 |
|
|
730 tree_constant *tmp = NULL_TREE_CONST; |
|
|
731 bind_variable ("ans", tmp); |
|
|
732 |
|
|
733 Complex ctmp (0.0, 1.0); |
|
|
734 tmp = new tree_constant (ctmp); |
|
|
735 bind_protected_variable ("I", tmp); |
|
|
736 make_eternal ("I"); |
|
|
737 |
|
|
738 tmp = new tree_constant (ctmp); |
|
|
739 bind_protected_variable ("J", tmp); |
|
|
740 make_eternal ("J"); |
|
|
741 |
|
|
742 // Let i and j be functions so they can be redefined without being |
|
|
743 // wiped out. |
|
|
744 |
|
|
745 char *tmp_help; |
|
|
746 |
|
|
747 tmp = new tree_constant (ctmp); |
|
|
748 sym_rec = curr_sym_tab->lookup ("i", 1); |
|
|
749 tmp_help = sym_rec->help (); |
|
|
750 sym_rec->define_as_fcn (tmp); |
|
|
751 sym_rec->document (tmp_help); |
|
|
752 sym_rec->protect (); |
|
|
753 sym_rec->make_eternal (); |
|
|
754 |
|
|
755 tmp = new tree_constant (ctmp); |
|
|
756 sym_rec = curr_sym_tab->lookup ("j", 1); |
|
|
757 tmp_help = sym_rec->help (); |
|
|
758 sym_rec->define_as_fcn (tmp); |
|
|
759 sym_rec->document (tmp_help); |
|
|
760 sym_rec->protect (); |
|
|
761 sym_rec->make_eternal (); |
|
|
762 |
|
|
763 tmp = new tree_constant (get_working_directory ("initialize_globals")); |
|
|
764 bind_protected_variable ("PWD", tmp); |
|
|
765 make_eternal ("PWD"); |
|
|
766 |
|
|
767 tmp = new tree_constant (load_path); |
|
|
768 bind_variable ("LOADPATH", tmp); |
|
|
769 make_eternal ("LOADPATH"); |
|
|
770 |
|
|
771 tmp = new tree_constant (default_pager ()); |
|
|
772 bind_variable ("PAGER", tmp); |
|
|
773 make_eternal ("PAGER"); |
|
|
774 |
|
|
775 tmp = new tree_constant (0.0); |
|
|
776 bind_variable ("SEEK_SET", tmp); |
|
|
777 make_eternal ("SEEK_SET"); |
|
|
778 |
|
|
779 tmp = new tree_constant (1.0); |
|
|
780 bind_variable ("SEEK_CUR", tmp); |
|
|
781 make_eternal ("SEEK_CUR"); |
|
|
782 |
|
|
783 tmp = new tree_constant (2.0); |
|
|
784 bind_variable ("SEEK_END", tmp); |
|
|
785 make_eternal ("SEEK_END"); |
|
|
786 |
|
|
787 tmp = new tree_constant (DBL_EPSILON); |
|
|
788 bind_protected_variable ("eps", tmp); |
|
|
789 make_eternal ("eps"); |
|
|
790 |
|
|
791 tmp = new tree_constant (10.0); |
|
|
792 bind_variable ("output_max_field_width", tmp); |
|
|
793 make_eternal ("output_max_field_width"); |
|
|
794 |
|
|
795 tmp = new tree_constant (5.0); |
|
|
796 bind_variable ("output_precision", tmp); |
|
|
797 make_eternal ("output_precision"); |
|
|
798 |
|
|
799 tmp = new tree_constant (4.0 * atan (1.0)); |
|
|
800 bind_protected_variable ("pi", tmp); |
|
|
801 make_eternal ("pi"); |
|
|
802 |
|
|
803 tmp = new tree_constant (0.0); |
|
|
804 bind_protected_variable ("stdin", tmp); |
|
|
805 make_eternal ("stdin"); |
|
|
806 |
|
|
807 tmp = new tree_constant (1.0); |
|
|
808 bind_protected_variable ("stdout", tmp); |
|
|
809 make_eternal ("stdout"); |
|
|
810 |
|
|
811 tmp = new tree_constant (2.0); |
|
|
812 bind_protected_variable ("stderr", tmp); |
|
|
813 make_eternal ("stderr"); |
|
|
814 |
|
|
815 #if defined (HAVE_ISINF) || defined (HAVE_FINITE) |
|
|
816 #ifdef linux |
|
|
817 tmp = new tree_constant (HUGE_VAL); |
|
|
818 #else |
|
|
819 tmp = new tree_constant (1.0/0.0); |
|
|
820 #endif |
|
|
821 bind_protected_variable ("Inf", tmp); |
|
|
822 make_eternal ("Inf"); |
|
|
823 |
|
|
824 #ifdef linux |
|
|
825 tmp = new tree_constant (HUGE_VAL); |
|
|
826 #else |
|
|
827 tmp = new tree_constant (1.0/0.0); |
|
|
828 #endif |
|
|
829 bind_protected_variable ("inf", tmp); |
|
|
830 make_eternal ("inf"); |
|
|
831 |
|
|
832 #else |
|
|
833 |
|
|
834 // This is sort of cheesy, but what can we do, other than blowing it |
|
|
835 // off completely, or writing an entire IEEE emulation package? |
|
|
836 |
|
|
837 tmp = new tree_constant (DBL_MAX); |
|
|
838 bind_protected_variable ("Inf", tmp); |
|
|
839 make_eternal ("Inf"); |
|
|
840 |
|
|
841 tmp = new tree_constant (DBL_MAX); |
|
|
842 bind_protected_variable ("inf", tmp); |
|
|
843 make_eternal ("inf"); |
|
|
844 #endif |
|
|
845 |
|
|
846 #if defined (HAVE_ISNAN) |
|
|
847 #ifdef linux |
|
|
848 tmp = new tree_constant (NAN); |
|
|
849 #else |
|
|
850 tmp = new tree_constant (0.0/0.0); |
|
|
851 #endif |
|
|
852 bind_protected_variable ("NaN", tmp); |
|
|
853 make_eternal ("NaN"); |
|
|
854 |
|
|
855 #ifdef linux |
|
|
856 tmp = new tree_constant (NAN); |
|
|
857 #else |
|
|
858 tmp = new tree_constant (0.0/0.0); |
|
|
859 #endif |
|
|
860 bind_protected_variable ("nan", tmp); |
|
|
861 make_eternal ("nan"); |
|
|
862 #endif |
|
|
863 } |
|
|
864 |
|
|
865 int |
|
|
866 is_text_function_name (char *s) |
|
|
867 { |
|
|
868 int retval = 0; |
|
|
869 |
|
|
870 builtin_text_functions *tfptr = text_functions; |
|
|
871 while (tfptr->name != (char *) NULL) |
|
|
872 { |
|
|
873 if (strcmp (tfptr->name, s) == 0) |
|
|
874 { |
|
|
875 retval = 1; |
|
|
876 break; |
|
|
877 } |
|
|
878 tfptr++; |
|
|
879 } |
|
|
880 |
|
|
881 return retval; |
|
|
882 } |
|
|
883 |
|
|
884 help_list * |
|
|
885 builtin_mapper_functions_help (void) |
|
|
886 { |
|
|
887 int count = 0; |
|
|
888 builtin_mapper_functions *mfptr; |
|
|
889 |
|
|
890 mfptr = mapper_functions; |
|
|
891 while (mfptr->name != (char *) NULL) |
|
|
892 { |
|
|
893 count++; |
|
|
894 mfptr++; |
|
|
895 } |
|
|
896 |
|
|
897 if (count == 0) |
|
|
898 return (help_list *) NULL; |
|
|
899 |
|
|
900 help_list *hl = new help_list [count+1]; |
|
|
901 |
|
|
902 int i = 0; |
|
|
903 mfptr = mapper_functions; |
|
|
904 while (mfptr->name != (char *) NULL) |
|
|
905 { |
|
|
906 hl[i].name = mfptr->name; |
|
|
907 hl[i].help = mfptr->help_string; |
|
|
908 i++; |
|
|
909 mfptr++; |
|
|
910 } |
|
|
911 |
|
|
912 hl[count].name = (char *) NULL; |
|
|
913 hl[count].help = (char *) NULL; |
|
|
914 |
|
|
915 return hl; |
|
|
916 } |
|
|
917 |
|
|
918 help_list * |
|
|
919 builtin_general_functions_help (void) |
|
|
920 { |
|
|
921 int count = 0; |
|
|
922 builtin_general_functions *gfptr; |
|
|
923 |
|
|
924 gfptr = general_functions; |
|
|
925 while (gfptr->name != (char *) NULL) |
|
|
926 { |
|
|
927 count++; |
|
|
928 gfptr++; |
|
|
929 } |
|
|
930 |
|
|
931 if (count == 0) |
|
|
932 return (help_list *) NULL; |
|
|
933 |
|
|
934 help_list *hl = new help_list [count+1]; |
|
|
935 |
|
|
936 int i = 0; |
|
|
937 gfptr = general_functions; |
|
|
938 while (gfptr->name != (char *) NULL) |
|
|
939 { |
|
|
940 hl[i].name = gfptr->name; |
|
|
941 hl[i].help = gfptr->help_string; |
|
|
942 i++; |
|
|
943 gfptr++; |
|
|
944 } |
|
|
945 |
|
|
946 hl[count].name = (char *) NULL; |
|
|
947 hl[count].help = (char *) NULL; |
|
|
948 |
|
|
949 return hl; |
|
|
950 } |
|
|
951 |
|
|
952 help_list * |
|
|
953 builtin_text_functions_help (void) |
|
|
954 { |
|
|
955 int count = 0; |
|
|
956 builtin_text_functions *tfptr; |
|
|
957 |
|
|
958 tfptr = text_functions; |
|
|
959 while (tfptr->name != (char *) NULL) |
|
|
960 { |
|
|
961 count++; |
|
|
962 tfptr++; |
|
|
963 } |
|
|
964 |
|
|
965 if (count == 0) |
|
|
966 return (help_list *) NULL; |
|
|
967 |
|
|
968 help_list *hl = new help_list [count+1]; |
|
|
969 |
|
|
970 int i = 0; |
|
|
971 tfptr = text_functions; |
|
|
972 while (tfptr->name != (char *) NULL) |
|
|
973 { |
|
|
974 hl[i].name = tfptr->name; |
|
|
975 hl[i].help = tfptr->help_string; |
|
|
976 i++; |
|
|
977 tfptr++; |
|
|
978 } |
|
|
979 |
|
|
980 hl[count].name = (char *) NULL; |
|
|
981 hl[count].help = (char *) NULL; |
|
|
982 |
|
|
983 return hl; |
|
|
984 } |
|
|
985 |
|
|
986 help_list * |
|
|
987 builtin_variables_help (void) |
|
|
988 { |
|
|
989 int count = 0; |
|
|
990 builtin_string_variables *svptr; |
|
|
991 |
|
|
992 svptr = string_variables; |
|
|
993 while (svptr->name != (char *) NULL) |
|
|
994 { |
|
|
995 count++; |
|
|
996 svptr++; |
|
|
997 } |
|
|
998 |
|
|
999 if (count == 0) |
|
|
1000 return (help_list *) NULL; |
|
|
1001 |
|
|
1002 help_list *hl = new help_list [count+1]; |
|
|
1003 |
|
|
1004 int i = 0; |
|
|
1005 svptr = string_variables; |
|
|
1006 while (svptr->name != (char *) NULL) |
|
|
1007 { |
|
|
1008 hl[i].name = svptr->name; |
|
|
1009 hl[i].help = svptr->help_string; |
|
|
1010 i++; |
|
|
1011 svptr++; |
|
|
1012 } |
|
|
1013 |
|
|
1014 hl[count].name = (char *) NULL; |
|
|
1015 hl[count].help = (char *) NULL; |
|
|
1016 |
|
|
1017 return hl; |
|
|
1018 } |
|
|
1019 |
|
|
1020 /* |
|
|
1021 ;;; Local Variables: *** |
|
|
1022 ;;; mode: C++ *** |
|
|
1023 ;;; page-delimiter: "^/\\*" *** |
|
|
1024 ;;; End: *** |
|
|
1025 */ |
