|
523
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
523
|
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 |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
523
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
523
|
25 #endif |
|
|
26 |
|
2184
|
27 #include <cfloat> |
|
|
28 #include <cmath> |
|
|
29 |
|
1728
|
30 #include <string> |
|
|
31 |
|
2184
|
32 #include "lo-ieee.h" |
|
1755
|
33 #include "str-vec.h" |
|
|
34 |
|
1352
|
35 #include "defun.h" |
|
|
36 #include "error.h" |
|
|
37 #include "gripes.h" |
|
|
38 #include "oct-map.h" |
|
2366
|
39 #include "ov.h" |
|
|
40 #include "variables.h" |
|
1742
|
41 #include "oct-obj.h" |
|
523
|
42 #include "utils.h" |
|
|
43 |
|
|
44 #ifndef MIN |
|
|
45 #define MIN(a,b) ((a) < (b) ? (a) : (b)) |
|
|
46 #endif |
|
|
47 |
|
767
|
48 #ifndef ABS |
|
|
49 #define ABS(x) (((x) < 0) ? (-x) : (x)) |
|
|
50 #endif |
|
|
51 |
|
2188
|
52 // Should expressions like ones (-1, 5) result in an empty matrix or |
|
|
53 // an error? A positive value means yes. A negative value means |
|
|
54 // yes, but print a warning message. Zero means it should be |
|
|
55 // considered an error. |
|
|
56 static int Vtreat_neg_dim_as_zero; |
|
|
57 |
|
1957
|
58 DEFUN (all, args, , |
|
523
|
59 "all (X): are all elements of X nonzero?") |
|
|
60 { |
|
2086
|
61 octave_value_list retval; |
|
523
|
62 |
|
|
63 int nargin = args.length (); |
|
|
64 |
|
712
|
65 if (nargin == 1 && args(0).is_defined ()) |
|
|
66 retval = args(0).all (); |
|
|
67 else |
|
523
|
68 print_usage ("all"); |
|
|
69 |
|
|
70 return retval; |
|
|
71 } |
|
|
72 |
|
1957
|
73 DEFUN (any, args, , |
|
523
|
74 "any (X): are any elements of X nonzero?") |
|
|
75 { |
|
2086
|
76 octave_value_list retval; |
|
523
|
77 |
|
|
78 int nargin = args.length (); |
|
|
79 |
|
712
|
80 if (nargin == 1 && args(0).is_defined ()) |
|
|
81 retval = args(0).any (); |
|
|
82 else |
|
523
|
83 print_usage ("any"); |
|
|
84 |
|
|
85 return retval; |
|
|
86 } |
|
|
87 |
|
649
|
88 // These mapping functions may also be useful in other places, eh? |
|
|
89 |
|
|
90 typedef double (*d_dd_fcn) (double, double); |
|
|
91 |
|
|
92 static Matrix |
|
2672
|
93 map_d_m (d_dd_fcn f, double x, const Matrix& y) |
|
649
|
94 { |
|
|
95 int nr = y.rows (); |
|
|
96 int nc = y.columns (); |
|
|
97 |
|
|
98 Matrix retval (nr, nc); |
|
|
99 |
|
|
100 for (int j = 0; j < nc; j++) |
|
|
101 for (int i = 0; i < nr; i++) |
|
2305
|
102 retval (i, j) = f (x, y (i, j)); |
|
649
|
103 |
|
|
104 return retval; |
|
|
105 } |
|
|
106 |
|
|
107 static Matrix |
|
2672
|
108 map_m_d (d_dd_fcn f, const Matrix& x, double y) |
|
649
|
109 { |
|
|
110 int nr = x.rows (); |
|
|
111 int nc = x.columns (); |
|
|
112 |
|
|
113 Matrix retval (nr, nc); |
|
|
114 |
|
|
115 for (int j = 0; j < nc; j++) |
|
|
116 for (int i = 0; i < nr; i++) |
|
2305
|
117 retval (i, j) = f (x (i, j), y); |
|
649
|
118 |
|
|
119 return retval; |
|
|
120 } |
|
|
121 |
|
|
122 static Matrix |
|
2672
|
123 map_m_m (d_dd_fcn f, const Matrix& x, const Matrix& y) |
|
649
|
124 { |
|
|
125 int x_nr = x.rows (); |
|
|
126 int x_nc = x.columns (); |
|
|
127 |
|
|
128 int y_nr = y.rows (); |
|
|
129 int y_nc = y.columns (); |
|
|
130 |
|
719
|
131 assert (x_nr == y_nr && x_nc == y_nc); |
|
649
|
132 |
|
|
133 Matrix retval (x_nr, x_nc); |
|
|
134 |
|
|
135 for (int j = 0; j < x_nc; j++) |
|
|
136 for (int i = 0; i < x_nr; i++) |
|
2305
|
137 retval (i, j) = f (x (i, j), y (i, j)); |
|
649
|
138 |
|
|
139 return retval; |
|
|
140 } |
|
|
141 |
|
1957
|
142 DEFUN (atan2, args, , |
|
649
|
143 "atan2 (Y, X): atan (Y / X) in range -pi to pi") |
|
|
144 { |
|
2086
|
145 octave_value_list retval; |
|
649
|
146 |
|
712
|
147 int nargin = args.length (); |
|
|
148 |
|
|
149 if (nargin == 2 && args(0).is_defined () && args(1).is_defined ()) |
|
649
|
150 { |
|
2086
|
151 octave_value arg_y = args(0); |
|
|
152 octave_value arg_x = args(1); |
|
649
|
153 |
|
|
154 int y_nr = arg_y.rows (); |
|
|
155 int y_nc = arg_y.columns (); |
|
|
156 |
|
|
157 int x_nr = arg_x.rows (); |
|
|
158 int x_nc = arg_x.columns (); |
|
|
159 |
|
|
160 int arg_y_empty = empty_arg ("atan2", y_nr, y_nc); |
|
|
161 int arg_x_empty = empty_arg ("atan2", x_nr, x_nc); |
|
|
162 |
|
719
|
163 if (arg_y_empty > 0 && arg_x_empty > 0) |
|
|
164 return Matrix (); |
|
|
165 else if (arg_y_empty || arg_x_empty) |
|
649
|
166 return retval; |
|
|
167 |
|
|
168 int y_is_scalar = (y_nr == 1 && y_nc == 1); |
|
|
169 int x_is_scalar = (x_nr == 1 && x_nc == 1); |
|
|
170 |
|
|
171 if (y_is_scalar && x_is_scalar) |
|
|
172 { |
|
|
173 double y = arg_y.double_value (); |
|
|
174 |
|
|
175 if (! error_state) |
|
|
176 { |
|
|
177 double x = arg_x.double_value (); |
|
|
178 |
|
|
179 if (! error_state) |
|
|
180 retval = atan2 (y, x); |
|
|
181 } |
|
|
182 } |
|
|
183 else if (y_is_scalar) |
|
|
184 { |
|
|
185 double y = arg_y.double_value (); |
|
|
186 |
|
|
187 if (! error_state) |
|
|
188 { |
|
|
189 Matrix x = arg_x.matrix_value (); |
|
|
190 |
|
|
191 if (! error_state) |
|
2672
|
192 retval = map_d_m (atan2, y, x); |
|
649
|
193 } |
|
|
194 } |
|
|
195 else if (x_is_scalar) |
|
|
196 { |
|
|
197 Matrix y = arg_y.matrix_value (); |
|
|
198 |
|
|
199 if (! error_state) |
|
|
200 { |
|
|
201 double x = arg_x.double_value (); |
|
|
202 |
|
|
203 if (! error_state) |
|
2672
|
204 retval = map_m_d (atan2, y, x); |
|
649
|
205 } |
|
|
206 } |
|
|
207 else if (y_nr == x_nr && y_nc == x_nc) |
|
|
208 { |
|
|
209 Matrix y = arg_y.matrix_value (); |
|
|
210 |
|
|
211 if (! error_state) |
|
|
212 { |
|
|
213 Matrix x = arg_x.matrix_value (); |
|
|
214 |
|
|
215 if (! error_state) |
|
2672
|
216 retval = map_m_m (atan2, y, x); |
|
649
|
217 } |
|
|
218 } |
|
|
219 else |
|
|
220 error ("atan2: nonconformant matrices"); |
|
|
221 } |
|
712
|
222 else |
|
|
223 print_usage ("atan2"); |
|
649
|
224 |
|
|
225 return retval; |
|
|
226 } |
|
|
227 |
|
1957
|
228 DEFUN (cumprod, args, , |
|
523
|
229 "cumprod (X): cumulative products") |
|
|
230 { |
|
2086
|
231 octave_value_list retval; |
|
523
|
232 |
|
|
233 int nargin = args.length (); |
|
|
234 |
|
760
|
235 if (nargin == 1) |
|
|
236 { |
|
2086
|
237 octave_value arg = args(0); |
|
760
|
238 |
|
|
239 if (arg.is_real_type ()) |
|
|
240 { |
|
|
241 Matrix tmp = arg.matrix_value (); |
|
|
242 |
|
|
243 if (! error_state) |
|
|
244 retval(0) = tmp.cumprod (); |
|
|
245 } |
|
|
246 else if (arg.is_complex_type ()) |
|
|
247 { |
|
|
248 ComplexMatrix tmp = arg.complex_matrix_value (); |
|
|
249 |
|
|
250 if (! error_state) |
|
|
251 retval(0) = tmp.cumprod (); |
|
|
252 } |
|
|
253 else |
|
|
254 { |
|
|
255 gripe_wrong_type_arg ("cumprod", arg); |
|
|
256 return retval; |
|
|
257 } |
|
|
258 } |
|
712
|
259 else |
|
523
|
260 print_usage ("cumprod"); |
|
|
261 |
|
|
262 return retval; |
|
|
263 } |
|
|
264 |
|
1957
|
265 DEFUN (cumsum, args, , |
|
523
|
266 "cumsum (X): cumulative sums") |
|
|
267 { |
|
2086
|
268 octave_value_list retval; |
|
523
|
269 |
|
|
270 int nargin = args.length (); |
|
|
271 |
|
760
|
272 if (nargin == 1) |
|
|
273 { |
|
2086
|
274 octave_value arg = args(0); |
|
760
|
275 |
|
|
276 if (arg.is_real_type ()) |
|
|
277 { |
|
|
278 Matrix tmp = arg.matrix_value (); |
|
|
279 |
|
|
280 if (! error_state) |
|
|
281 retval(0) = tmp.cumsum (); |
|
|
282 } |
|
|
283 else if (arg.is_complex_type ()) |
|
|
284 { |
|
|
285 ComplexMatrix tmp = arg.complex_matrix_value (); |
|
|
286 |
|
|
287 if (! error_state) |
|
|
288 retval(0) = tmp.cumsum (); |
|
|
289 } |
|
|
290 else |
|
|
291 { |
|
|
292 gripe_wrong_type_arg ("cumsum", arg); |
|
|
293 return retval; |
|
|
294 } |
|
|
295 } |
|
712
|
296 else |
|
523
|
297 print_usage ("cumsum"); |
|
|
298 |
|
|
299 return retval; |
|
|
300 } |
|
|
301 |
|
2086
|
302 static octave_value |
|
767
|
303 make_diag (const Matrix& v, int k) |
|
|
304 { |
|
|
305 int nr = v.rows (); |
|
|
306 int nc = v.columns (); |
|
|
307 assert (nc == 1 || nr == 1); |
|
|
308 |
|
2086
|
309 octave_value retval; |
|
767
|
310 |
|
|
311 int roff = 0; |
|
|
312 int coff = 0; |
|
|
313 if (k > 0) |
|
|
314 { |
|
|
315 roff = 0; |
|
|
316 coff = k; |
|
|
317 } |
|
|
318 else if (k < 0) |
|
|
319 { |
|
|
320 roff = -k; |
|
|
321 coff = 0; |
|
|
322 } |
|
|
323 |
|
|
324 if (nr == 1) |
|
|
325 { |
|
|
326 int n = nc + ABS (k); |
|
|
327 Matrix m (n, n, 0.0); |
|
|
328 for (int i = 0; i < nc; i++) |
|
2305
|
329 m (i+roff, i+coff) = v (0, i); |
|
2086
|
330 retval = octave_value (m); |
|
767
|
331 } |
|
|
332 else |
|
|
333 { |
|
|
334 int n = nr + ABS (k); |
|
|
335 Matrix m (n, n, 0.0); |
|
|
336 for (int i = 0; i < nr; i++) |
|
2305
|
337 m (i+roff, i+coff) = v (i, 0); |
|
2086
|
338 retval = octave_value (m); |
|
767
|
339 } |
|
|
340 |
|
|
341 return retval; |
|
|
342 } |
|
|
343 |
|
2086
|
344 static octave_value |
|
767
|
345 make_diag (const ComplexMatrix& v, int k) |
|
|
346 { |
|
|
347 int nr = v.rows (); |
|
|
348 int nc = v.columns (); |
|
|
349 assert (nc == 1 || nr == 1); |
|
|
350 |
|
2086
|
351 octave_value retval; |
|
767
|
352 |
|
|
353 int roff = 0; |
|
|
354 int coff = 0; |
|
|
355 if (k > 0) |
|
|
356 { |
|
|
357 roff = 0; |
|
|
358 coff = k; |
|
|
359 } |
|
|
360 else if (k < 0) |
|
|
361 { |
|
|
362 roff = -k; |
|
|
363 coff = 0; |
|
|
364 } |
|
|
365 |
|
|
366 if (nr == 1) |
|
|
367 { |
|
|
368 int n = nc + ABS (k); |
|
|
369 ComplexMatrix m (n, n, 0.0); |
|
|
370 for (int i = 0; i < nc; i++) |
|
2305
|
371 m (i+roff, i+coff) = v (0, i); |
|
2086
|
372 retval = octave_value (m); |
|
767
|
373 } |
|
|
374 else |
|
|
375 { |
|
|
376 int n = nr + ABS (k); |
|
|
377 ComplexMatrix m (n, n, 0.0); |
|
|
378 for (int i = 0; i < nr; i++) |
|
2305
|
379 m (i+roff, i+coff) = v (i, 0); |
|
2086
|
380 retval = octave_value (m); |
|
767
|
381 } |
|
|
382 |
|
|
383 return retval; |
|
|
384 } |
|
|
385 |
|
2086
|
386 static octave_value |
|
|
387 make_diag (const octave_value& arg) |
|
767
|
388 { |
|
2086
|
389 octave_value retval; |
|
767
|
390 |
|
|
391 if (arg.is_real_type ()) |
|
|
392 { |
|
|
393 Matrix m = arg.matrix_value (); |
|
|
394 |
|
|
395 if (! error_state) |
|
|
396 { |
|
|
397 int nr = m.rows (); |
|
|
398 int nc = m.columns (); |
|
|
399 |
|
|
400 if (nr == 0 || nc == 0) |
|
|
401 retval = Matrix (); |
|
|
402 else if (nr == 1 || nc == 1) |
|
|
403 retval = make_diag (m, 0); |
|
|
404 else |
|
|
405 { |
|
|
406 ColumnVector v = m.diag (); |
|
|
407 if (v.capacity () > 0) |
|
|
408 retval = v; |
|
|
409 } |
|
|
410 } |
|
|
411 else |
|
|
412 gripe_wrong_type_arg ("diag", arg); |
|
|
413 } |
|
|
414 else if (arg.is_complex_type ()) |
|
|
415 { |
|
|
416 ComplexMatrix cm = arg.complex_matrix_value (); |
|
|
417 |
|
|
418 if (! error_state) |
|
|
419 { |
|
|
420 int nr = cm.rows (); |
|
|
421 int nc = cm.columns (); |
|
|
422 |
|
|
423 if (nr == 0 || nc == 0) |
|
|
424 retval = Matrix (); |
|
|
425 else if (nr == 1 || nc == 1) |
|
|
426 retval = make_diag (cm, 0); |
|
|
427 else |
|
|
428 { |
|
|
429 ComplexColumnVector v = cm.diag (); |
|
|
430 if (v.capacity () > 0) |
|
|
431 retval = v; |
|
|
432 } |
|
|
433 } |
|
|
434 else |
|
|
435 gripe_wrong_type_arg ("diag", arg); |
|
|
436 } |
|
|
437 else |
|
|
438 gripe_wrong_type_arg ("diag", arg); |
|
|
439 |
|
|
440 return retval; |
|
|
441 } |
|
|
442 |
|
2086
|
443 static octave_value |
|
|
444 make_diag (const octave_value& a, const octave_value& b) |
|
767
|
445 { |
|
2086
|
446 octave_value retval; |
|
767
|
447 |
|
3202
|
448 int k = b.nint_value (); |
|
767
|
449 |
|
|
450 if (error_state) |
|
|
451 { |
|
|
452 error ("diag: invalid second argument"); |
|
|
453 return retval; |
|
|
454 } |
|
|
455 |
|
|
456 if (a.is_real_type ()) |
|
|
457 { |
|
3307
|
458 Matrix m = a.matrix_value (); |
|
767
|
459 |
|
3307
|
460 if (! error_state) |
|
767
|
461 { |
|
|
462 int nr = m.rows (); |
|
|
463 int nc = m.columns (); |
|
|
464 |
|
|
465 if (nr == 0 || nc == 0) |
|
|
466 retval = Matrix (); |
|
|
467 else if (nr == 1 || nc == 1) |
|
|
468 retval = make_diag (m, k); |
|
|
469 else |
|
|
470 { |
|
|
471 ColumnVector d = m.diag (k); |
|
|
472 retval = d; |
|
|
473 } |
|
|
474 } |
|
|
475 } |
|
|
476 else if (a.is_complex_type ()) |
|
|
477 { |
|
3307
|
478 ComplexMatrix cm = a.complex_matrix_value (); |
|
767
|
479 |
|
3307
|
480 if (! error_state) |
|
767
|
481 { |
|
|
482 int nr = cm.rows (); |
|
|
483 int nc = cm.columns (); |
|
|
484 |
|
|
485 if (nr == 0 || nc == 0) |
|
|
486 retval = Matrix (); |
|
|
487 else if (nr == 1 || nc == 1) |
|
|
488 retval = make_diag (cm, k); |
|
|
489 else |
|
|
490 { |
|
|
491 ComplexColumnVector d = cm.diag (k); |
|
|
492 retval = d; |
|
|
493 } |
|
|
494 } |
|
|
495 } |
|
|
496 else |
|
|
497 gripe_wrong_type_arg ("diag", a); |
|
|
498 |
|
|
499 return retval; |
|
|
500 } |
|
|
501 |
|
1957
|
502 DEFUN (diag, args, , |
|
523
|
503 "diag (X [,k]): form/extract diagonals") |
|
|
504 { |
|
2086
|
505 octave_value_list retval; |
|
523
|
506 |
|
|
507 int nargin = args.length (); |
|
|
508 |
|
712
|
509 if (nargin == 1 && args(0).is_defined ()) |
|
767
|
510 retval = make_diag (args(0)); |
|
712
|
511 else if (nargin == 2 && args(0).is_defined () && args(1).is_defined ()) |
|
767
|
512 retval = make_diag (args(0), args(1)); |
|
523
|
513 else |
|
|
514 print_usage ("diag"); |
|
|
515 |
|
|
516 return retval; |
|
|
517 } |
|
|
518 |
|
1957
|
519 DEFUN (prod, args, , |
|
523
|
520 "prod (X): products") |
|
|
521 { |
|
2086
|
522 octave_value_list retval; |
|
523
|
523 |
|
|
524 int nargin = args.length (); |
|
|
525 |
|
760
|
526 if (nargin == 1) |
|
|
527 { |
|
2086
|
528 octave_value arg = args(0); |
|
760
|
529 |
|
|
530 if (arg.is_real_type ()) |
|
|
531 { |
|
|
532 Matrix tmp = arg.matrix_value (); |
|
|
533 |
|
|
534 if (! error_state) |
|
|
535 retval(0) = tmp.prod (); |
|
|
536 } |
|
|
537 else if (arg.is_complex_type ()) |
|
|
538 { |
|
|
539 ComplexMatrix tmp = arg.complex_matrix_value (); |
|
|
540 |
|
|
541 if (! error_state) |
|
|
542 retval(0) = tmp.prod (); |
|
|
543 } |
|
|
544 else |
|
|
545 { |
|
|
546 gripe_wrong_type_arg ("prod", arg); |
|
|
547 return retval; |
|
|
548 } |
|
|
549 } |
|
712
|
550 else |
|
523
|
551 print_usage ("prod"); |
|
|
552 |
|
|
553 return retval; |
|
|
554 } |
|
|
555 |
|
3195
|
556 DEFUN (length, args, , |
|
|
557 "length (x): return the `length' of the object X\n\ |
|
|
558 \n\ |
|
|
559 For matrix objects, the length is the number of rows or columns,\n\ |
|
|
560 whichever is greater (this odd definition is used for compatibility\n\ |
|
|
561 with Matlab).\n\ |
|
|
562 \n\ |
|
|
563 See also: size, rows, columns, is_scalar, is_vector, is_matrix") |
|
|
564 { |
|
|
565 octave_value retval; |
|
|
566 |
|
|
567 if (args.length () == 1) |
|
|
568 { |
|
|
569 int len = args(0).length (); |
|
|
570 |
|
|
571 if (! error_state) |
|
|
572 retval = static_cast<double> (len); |
|
|
573 } |
|
|
574 else |
|
|
575 print_usage ("length"); |
|
|
576 |
|
|
577 return retval; |
|
|
578 } |
|
|
579 |
|
1957
|
580 DEFUN (size, args, nargout, |
|
1032
|
581 "[m, n] = size (x): return rows and columns of X\n\ |
|
1031
|
582 \n\ |
|
|
583 d = size (x): return number of rows and columns of x as a row vector\n\ |
|
|
584 \n\ |
|
|
585 m = size (x, 1): return number of rows in x\n\ |
|
|
586 m = size (x, 2): return number of columns in x") |
|
523
|
587 { |
|
2086
|
588 octave_value_list retval; |
|
523
|
589 |
|
|
590 int nargin = args.length (); |
|
|
591 |
|
1031
|
592 if (nargin == 1 && nargout < 3) |
|
523
|
593 { |
|
712
|
594 int nr = args(0).rows (); |
|
|
595 int nc = args(0).columns (); |
|
1031
|
596 |
|
712
|
597 if (nargout == 0 || nargout == 1) |
|
523
|
598 { |
|
712
|
599 Matrix m (1, 2); |
|
2305
|
600 m (0, 0) = nr; |
|
|
601 m (0, 1) = nc; |
|
712
|
602 retval = m; |
|
523
|
603 } |
|
712
|
604 else if (nargout == 2) |
|
|
605 { |
|
2800
|
606 retval(1) = static_cast<double> (nc); |
|
|
607 retval(0) = static_cast<double> (nr); |
|
712
|
608 } |
|
1031
|
609 } |
|
|
610 else if (nargin == 2 && nargout < 2) |
|
|
611 { |
|
3202
|
612 int nd = args(1).nint_value (); |
|
1031
|
613 |
|
|
614 if (error_state) |
|
|
615 error ("size: expecting scalar as second argument"); |
|
712
|
616 else |
|
1031
|
617 { |
|
|
618 if (nd == 1) |
|
2800
|
619 retval(0) = static_cast<double> (args(0).rows ()); |
|
1031
|
620 else if (nd == 2) |
|
2800
|
621 retval(0) = static_cast<double> (args(0).columns ()); |
|
1031
|
622 else |
|
|
623 error ("size: invalid second argument -- expecting 1 or 2"); |
|
|
624 } |
|
523
|
625 } |
|
712
|
626 else |
|
|
627 print_usage ("size"); |
|
523
|
628 |
|
|
629 return retval; |
|
|
630 } |
|
|
631 |
|
1957
|
632 DEFUN (sum, args, , |
|
523
|
633 "sum (X): sum of elements") |
|
|
634 { |
|
2086
|
635 octave_value_list retval; |
|
523
|
636 |
|
|
637 int nargin = args.length (); |
|
|
638 |
|
760
|
639 if (nargin == 1) |
|
|
640 { |
|
2086
|
641 octave_value arg = args(0); |
|
760
|
642 |
|
|
643 if (arg.is_real_type ()) |
|
|
644 { |
|
|
645 Matrix tmp = arg.matrix_value (); |
|
|
646 |
|
|
647 if (! error_state) |
|
|
648 retval(0) = tmp.sum (); |
|
|
649 } |
|
|
650 else if (arg.is_complex_type ()) |
|
|
651 { |
|
|
652 ComplexMatrix tmp = arg.complex_matrix_value (); |
|
|
653 |
|
|
654 if (! error_state) |
|
|
655 retval(0) = tmp.sum (); |
|
|
656 } |
|
|
657 else |
|
|
658 { |
|
|
659 gripe_wrong_type_arg ("sum", arg); |
|
|
660 return retval; |
|
|
661 } |
|
|
662 } |
|
523
|
663 else |
|
712
|
664 print_usage ("sum"); |
|
523
|
665 |
|
|
666 return retval; |
|
|
667 } |
|
|
668 |
|
1957
|
669 DEFUN (sumsq, args, , |
|
3095
|
670 "sumsq (X): sum of squares of elements.\n\ |
|
|
671 \n\ |
|
|
672 This function is equivalent to computing\n\ |
|
|
673 \n\ |
|
|
674 sum (X .* conj (X))\n\ |
|
|
675 \n\ |
|
|
676 but it uses less memory and avoids calling conj if X is real.") |
|
523
|
677 { |
|
2086
|
678 octave_value_list retval; |
|
523
|
679 |
|
|
680 int nargin = args.length (); |
|
|
681 |
|
760
|
682 if (nargin == 1) |
|
|
683 { |
|
2086
|
684 octave_value arg = args(0); |
|
760
|
685 |
|
|
686 if (arg.is_real_type ()) |
|
|
687 { |
|
|
688 Matrix tmp = arg.matrix_value (); |
|
|
689 |
|
|
690 if (! error_state) |
|
|
691 retval(0) = tmp.sumsq (); |
|
|
692 } |
|
|
693 else if (arg.is_complex_type ()) |
|
|
694 { |
|
|
695 ComplexMatrix tmp = arg.complex_matrix_value (); |
|
|
696 |
|
|
697 if (! error_state) |
|
|
698 retval(0) = tmp.sumsq (); |
|
|
699 } |
|
|
700 else |
|
|
701 { |
|
|
702 gripe_wrong_type_arg ("sumsq", arg); |
|
|
703 return retval; |
|
|
704 } |
|
|
705 } |
|
712
|
706 else |
|
523
|
707 print_usage ("sumsq"); |
|
|
708 |
|
|
709 return retval; |
|
|
710 } |
|
|
711 |
|
3209
|
712 DEFUN (is_bool, args, , |
|
|
713 "is_bool (x): return nonzero if x is a boolean object") |
|
|
714 { |
|
|
715 octave_value retval; |
|
|
716 |
|
|
717 if (args.length () == 1) |
|
3258
|
718 retval = args(0).is_bool_type (); |
|
3209
|
719 else |
|
|
720 print_usage ("is_bool"); |
|
|
721 |
|
|
722 return retval; |
|
|
723 } |
|
|
724 |
|
|
725 DEFALIAS (islogical, is_bool); |
|
|
726 |
|
3186
|
727 DEFUN (is_complex, args, , |
|
3258
|
728 "is_complex (x): return nonzero if x is a complex-valued numeric object") |
|
3186
|
729 { |
|
|
730 octave_value retval; |
|
|
731 |
|
|
732 if (args.length () == 1) |
|
3258
|
733 retval = args(0).is_complex_type (); |
|
3186
|
734 else |
|
|
735 print_usage ("is_complex"); |
|
|
736 |
|
|
737 return retval; |
|
|
738 } |
|
|
739 |
|
3258
|
740 DEFUN (isreal, args, , |
|
|
741 "isreal (x): return nonzero if x is a real-valued numeric object") |
|
|
742 { |
|
|
743 octave_value retval; |
|
|
744 |
|
|
745 if (args.length () == 1) |
|
|
746 retval = args(0).is_real_type (); |
|
|
747 else |
|
|
748 print_usage ("isreal"); |
|
|
749 |
|
|
750 return retval; |
|
|
751 } |
|
|
752 |
|
3202
|
753 DEFUN (isempty, args, , |
|
3215
|
754 "isempty (x): return nonzero if x is an empty matrix, string, or list") |
|
3202
|
755 { |
|
|
756 double retval = 0.0; |
|
|
757 |
|
|
758 if (args.length () == 1) |
|
|
759 { |
|
|
760 octave_value arg = args(0); |
|
|
761 |
|
|
762 if (arg.is_matrix_type ()) |
|
|
763 retval = static_cast<double> (arg.rows () == 0 || arg.columns () == 0); |
|
3215
|
764 else if (arg.is_list () || arg.is_string ()) |
|
3202
|
765 retval = static_cast<double> (arg.length () == 0); |
|
|
766 } |
|
|
767 else |
|
|
768 print_usage ("isempty"); |
|
|
769 |
|
|
770 return retval; |
|
|
771 } |
|
|
772 |
|
3206
|
773 DEFUN (isnumeric, args, , |
|
|
774 "isnumeric (x): return nonzero if x is a numeric object") |
|
|
775 { |
|
|
776 octave_value retval; |
|
|
777 |
|
|
778 if (args.length () == 1) |
|
3258
|
779 retval = args(0).is_numeric_type (); |
|
3206
|
780 else |
|
3238
|
781 print_usage ("isnumeric"); |
|
3206
|
782 |
|
|
783 return retval; |
|
|
784 } |
|
|
785 |
|
3204
|
786 DEFUN (is_list, args, , |
|
|
787 "is_list (x): return nonzero if x is a list") |
|
|
788 { |
|
|
789 octave_value retval; |
|
|
790 |
|
|
791 if (args.length () == 1) |
|
3258
|
792 retval = args(0).is_list (); |
|
3204
|
793 else |
|
|
794 print_usage ("is_list"); |
|
|
795 |
|
|
796 return retval; |
|
|
797 } |
|
|
798 |
|
3202
|
799 DEFUN (is_matrix, args, , |
|
3321
|
800 "-*- texinfo -*-\n\ |
|
|
801 @deftypefn {Usage} {} is_matrix (@var{a})\n\ |
|
|
802 Return 1 if @var{a} is a matrix. Otherwise, return 0.\n\ |
|
3333
|
803 @end deftypefn") |
|
3202
|
804 { |
|
|
805 double retval = 0.0; |
|
|
806 |
|
|
807 if (args.length () == 1) |
|
|
808 { |
|
|
809 octave_value arg = args(0); |
|
|
810 |
|
3212
|
811 if (arg.is_scalar_type () || arg.is_range ()) |
|
3202
|
812 retval = 1.0; |
|
|
813 else if (arg.is_matrix_type ()) |
|
|
814 retval = static_cast<double> (arg.rows () >= 1 && arg.columns () >= 1); |
|
|
815 } |
|
|
816 else |
|
|
817 print_usage ("is_matrix"); |
|
|
818 |
|
|
819 return retval; |
|
|
820 } |
|
|
821 |
|
1957
|
822 DEFUN (is_struct, args, , |
|
939
|
823 "is_struct (x): return nonzero if x is a structure") |
|
|
824 { |
|
3186
|
825 octave_value retval; |
|
939
|
826 |
|
3186
|
827 if (args.length () == 1) |
|
3258
|
828 retval = args(0).is_map (); |
|
939
|
829 else |
|
|
830 print_usage ("is_struct"); |
|
|
831 |
|
|
832 return retval; |
|
|
833 } |
|
|
834 |
|
1957
|
835 DEFUN (struct_elements, args, , |
|
1402
|
836 "struct_elements (S)\n\ |
|
|
837 \n\ |
|
|
838 Return a list of the names of the elements of the structure S.") |
|
|
839 { |
|
2086
|
840 octave_value_list retval; |
|
1402
|
841 |
|
|
842 int nargin = args.length (); |
|
|
843 |
|
|
844 if (nargin == 1) |
|
|
845 { |
|
|
846 if (args (0).is_map ()) |
|
|
847 { |
|
|
848 Octave_map m = args(0).map_value (); |
|
1755
|
849 retval(0) = m.make_name_list (); |
|
1402
|
850 } |
|
|
851 else |
|
|
852 gripe_wrong_type_arg ("struct_elements", args (0)); |
|
|
853 } |
|
|
854 else |
|
|
855 print_usage ("struct_elements"); |
|
|
856 |
|
|
857 return retval; |
|
|
858 } |
|
|
859 |
|
1957
|
860 DEFUN (struct_contains, args, , |
|
1216
|
861 "struct_contains (S, NAME)\n\ |
|
|
862 \n\ |
|
2420
|
863 Return nonzero if S is a structure with element NAME.\n\ |
|
|
864 S must be a structure and NAME must be a string.") |
|
1216
|
865 { |
|
2086
|
866 octave_value_list retval; |
|
1216
|
867 |
|
|
868 int nargin = args.length (); |
|
|
869 |
|
|
870 if (nargin == 2) |
|
|
871 { |
|
|
872 retval = 0.0; |
|
2420
|
873 |
|
2963
|
874 // XXX FIXME XXX -- should this work for all types that can do |
|
|
875 // structure reference operations? |
|
|
876 |
|
1277
|
877 if (args(0).is_map () && args(1).is_string ()) |
|
1216
|
878 { |
|
1755
|
879 string s = args(1).string_value (); |
|
2963
|
880 octave_value tmp = args(0).do_struct_elt_index_op (s, true); |
|
2800
|
881 retval = static_cast<double> (tmp.is_defined ()); |
|
1216
|
882 } |
|
2420
|
883 else |
|
|
884 print_usage ("struct_contains"); |
|
1216
|
885 } |
|
|
886 else |
|
|
887 print_usage ("struct_contains"); |
|
|
888 |
|
|
889 return retval; |
|
|
890 } |
|
|
891 |
|
523
|
892 static void |
|
|
893 check_dimensions (int& nr, int& nc, const char *warnfor) |
|
|
894 { |
|
|
895 if (nr < 0 || nc < 0) |
|
|
896 { |
|
2188
|
897 if (Vtreat_neg_dim_as_zero) |
|
597
|
898 { |
|
|
899 nr = (nr < 0) ? 0 : nr; |
|
|
900 nc = (nc < 0) ? 0 : nc; |
|
1129
|
901 |
|
2188
|
902 if (Vtreat_neg_dim_as_zero < 0) |
|
1129
|
903 warning ("%s: converting negative dimension to zero", |
|
|
904 warnfor); |
|
597
|
905 } |
|
523
|
906 else |
|
|
907 error ("%s: can't create a matrix with negative dimensions", |
|
|
908 warnfor); |
|
|
909 } |
|
|
910 } |
|
|
911 |
|
|
912 static void |
|
2086
|
913 get_dimensions (const octave_value& a, const char *warn_for, |
|
523
|
914 int& nr, int& nc) |
|
|
915 { |
|
634
|
916 if (a.is_scalar_type ()) |
|
523
|
917 { |
|
3202
|
918 nr = nc = a.nint_value (); |
|
523
|
919 } |
|
|
920 else |
|
|
921 { |
|
634
|
922 nr = a.rows (); |
|
|
923 nc = a.columns (); |
|
523
|
924 |
|
|
925 if ((nr == 1 && nc == 2) || (nr == 2 && nc == 1)) |
|
|
926 { |
|
634
|
927 ColumnVector v = a.vector_value (); |
|
523
|
928 |
|
633
|
929 if (error_state) |
|
|
930 return; |
|
|
931 |
|
2305
|
932 nr = NINT (v (0)); |
|
|
933 nc = NINT (v (1)); |
|
523
|
934 } |
|
|
935 else |
|
|
936 warning ("%s (A): use %s (size (A)) instead", warn_for, warn_for); |
|
|
937 } |
|
|
938 |
|
|
939 check_dimensions (nr, nc, warn_for); // May set error_state. |
|
|
940 } |
|
|
941 |
|
|
942 static void |
|
2086
|
943 get_dimensions (const octave_value& a, const octave_value& b, |
|
523
|
944 const char *warn_for, int& nr, int& nc) |
|
|
945 { |
|
3202
|
946 nr = a.is_empty () ? 0 : a.nint_value (); |
|
|
947 nc = b.is_empty () ? 0 : b.nint_value (); |
|
523
|
948 |
|
634
|
949 if (error_state) |
|
|
950 error ("%s: expecting two scalar arguments", warn_for); |
|
523
|
951 else |
|
634
|
952 check_dimensions (nr, nc, warn_for); // May set error_state. |
|
523
|
953 } |
|
|
954 |
|
2086
|
955 static octave_value |
|
|
956 fill_matrix (const octave_value& a, double val, const char *warn_for) |
|
523
|
957 { |
|
|
958 int nr, nc; |
|
|
959 get_dimensions (a, warn_for, nr, nc); |
|
|
960 |
|
|
961 if (error_state) |
|
2086
|
962 return octave_value (); |
|
523
|
963 |
|
|
964 Matrix m (nr, nc, val); |
|
|
965 |
|
|
966 return m; |
|
|
967 } |
|
|
968 |
|
2086
|
969 static octave_value |
|
|
970 fill_matrix (const octave_value& a, const octave_value& b, |
|
523
|
971 double val, const char *warn_for) |
|
|
972 { |
|
|
973 int nr, nc; |
|
|
974 get_dimensions (a, b, warn_for, nr, nc); // May set error_state. |
|
|
975 |
|
|
976 if (error_state) |
|
2086
|
977 return octave_value (); |
|
523
|
978 |
|
|
979 Matrix m (nr, nc, val); |
|
|
980 |
|
|
981 return m; |
|
|
982 } |
|
|
983 |
|
1957
|
984 DEFUN (ones, args, , |
|
523
|
985 "ones (N), ones (N, M), ones (X): create a matrix of all ones") |
|
|
986 { |
|
2086
|
987 octave_value_list retval; |
|
523
|
988 |
|
|
989 int nargin = args.length (); |
|
|
990 |
|
|
991 switch (nargin) |
|
|
992 { |
|
712
|
993 case 0: |
|
|
994 retval = 1.0; |
|
|
995 break; |
|
777
|
996 |
|
610
|
997 case 1: |
|
712
|
998 retval = fill_matrix (args(0), 1.0, "ones"); |
|
610
|
999 break; |
|
777
|
1000 |
|
523
|
1001 case 2: |
|
712
|
1002 retval = fill_matrix (args(0), args(1), 1.0, "ones"); |
|
523
|
1003 break; |
|
777
|
1004 |
|
523
|
1005 default: |
|
|
1006 print_usage ("ones"); |
|
|
1007 break; |
|
|
1008 } |
|
|
1009 |
|
|
1010 return retval; |
|
|
1011 } |
|
|
1012 |
|
1957
|
1013 DEFUN (zeros, args, , |
|
523
|
1014 "zeros (N), zeros (N, M), zeros (X): create a matrix of all zeros") |
|
|
1015 { |
|
2086
|
1016 octave_value_list retval; |
|
523
|
1017 |
|
|
1018 int nargin = args.length (); |
|
|
1019 |
|
|
1020 switch (nargin) |
|
|
1021 { |
|
712
|
1022 case 0: |
|
|
1023 retval = 0.0; |
|
|
1024 break; |
|
777
|
1025 |
|
610
|
1026 case 1: |
|
712
|
1027 retval = fill_matrix (args(0), 0.0, "zeros"); |
|
610
|
1028 break; |
|
777
|
1029 |
|
523
|
1030 case 2: |
|
712
|
1031 retval = fill_matrix (args(0), args(1), 0.0, "zeros"); |
|
523
|
1032 break; |
|
777
|
1033 |
|
523
|
1034 default: |
|
|
1035 print_usage ("zeros"); |
|
|
1036 break; |
|
|
1037 } |
|
|
1038 |
|
|
1039 return retval; |
|
|
1040 } |
|
|
1041 |
|
2086
|
1042 static octave_value |
|
|
1043 identity_matrix (const octave_value& a) |
|
523
|
1044 { |
|
|
1045 int nr, nc; |
|
|
1046 get_dimensions (a, "eye", nr, nc); // May set error_state. |
|
|
1047 |
|
|
1048 if (error_state) |
|
2086
|
1049 return octave_value (); |
|
523
|
1050 |
|
|
1051 Matrix m (nr, nc, 0.0); |
|
|
1052 |
|
|
1053 if (nr > 0 && nc > 0) |
|
|
1054 { |
|
|
1055 int n = MIN (nr, nc); |
|
|
1056 for (int i = 0; i < n; i++) |
|
2305
|
1057 m (i, i) = 1.0; |
|
523
|
1058 } |
|
|
1059 |
|
|
1060 return m; |
|
|
1061 } |
|
|
1062 |
|
2086
|
1063 static octave_value |
|
|
1064 identity_matrix (const octave_value& a, const octave_value& b) |
|
523
|
1065 { |
|
|
1066 int nr, nc; |
|
|
1067 get_dimensions (a, b, "eye", nr, nc); // May set error_state. |
|
|
1068 |
|
|
1069 if (error_state) |
|
2086
|
1070 return octave_value (); |
|
523
|
1071 |
|
|
1072 Matrix m (nr, nc, 0.0); |
|
|
1073 |
|
|
1074 if (nr > 0 && nc > 0) |
|
|
1075 { |
|
|
1076 int n = MIN (nr, nc); |
|
|
1077 for (int i = 0; i < n; i++) |
|
2305
|
1078 m (i, i) = 1.0; |
|
523
|
1079 } |
|
|
1080 |
|
|
1081 return m; |
|
|
1082 } |
|
|
1083 |
|
1957
|
1084 DEFUN (eye, args, , |
|
523
|
1085 "eye (N), eye (N, M), eye (X): create an identity matrix") |
|
|
1086 { |
|
2086
|
1087 octave_value_list retval; |
|
523
|
1088 |
|
|
1089 int nargin = args.length (); |
|
|
1090 |
|
|
1091 switch (nargin) |
|
|
1092 { |
|
712
|
1093 case 0: |
|
|
1094 retval = 1.0; |
|
|
1095 break; |
|
777
|
1096 |
|
610
|
1097 case 1: |
|
712
|
1098 retval = identity_matrix (args(0)); |
|
610
|
1099 break; |
|
777
|
1100 |
|
523
|
1101 case 2: |
|
712
|
1102 retval = identity_matrix (args(0), args(1)); |
|
523
|
1103 break; |
|
777
|
1104 |
|
523
|
1105 default: |
|
|
1106 print_usage ("eye"); |
|
|
1107 break; |
|
|
1108 } |
|
|
1109 |
|
|
1110 return retval; |
|
|
1111 } |
|
|
1112 |
|
1957
|
1113 DEFUN (linspace, args, , |
|
1100
|
1114 "usage: linspace (x1, x2, n)\n\ |
|
|
1115 \n\ |
|
|
1116 Return a vector of n equally spaced points between x1 and x2\n\ |
|
|
1117 inclusive.\n\ |
|
|
1118 \n\ |
|
|
1119 If the final argument is omitted, n = 100 is assumed.\n\ |
|
|
1120 \n\ |
|
|
1121 All three arguments must be scalars.\n\ |
|
|
1122 \n\ |
|
|
1123 See also: logspace") |
|
|
1124 { |
|
2086
|
1125 octave_value_list retval; |
|
1100
|
1126 |
|
|
1127 int nargin = args.length (); |
|
|
1128 |
|
|
1129 int npoints = 100; |
|
|
1130 |
|
1940
|
1131 if (nargin != 2 && nargin != 3) |
|
|
1132 { |
|
|
1133 print_usage ("linspace"); |
|
|
1134 return retval; |
|
|
1135 } |
|
|
1136 |
|
1100
|
1137 if (nargin == 3) |
|
3202
|
1138 npoints = args(2).nint_value (); |
|
1100
|
1139 |
|
|
1140 if (! error_state) |
|
|
1141 { |
|
3322
|
1142 octave_value arg_1 = args(0); |
|
|
1143 octave_value arg_2 = args(1); |
|
1100
|
1144 |
|
3322
|
1145 if (arg_1.is_complex_type () || arg_2.is_complex_type ()) |
|
|
1146 { |
|
|
1147 Complex x1 = arg_1.complex_value (); |
|
|
1148 Complex x2 = arg_2.complex_value (); |
|
|
1149 |
|
|
1150 if (! error_state) |
|
1100
|
1151 { |
|
3322
|
1152 ComplexRowVector rv = linspace (x1, x2, npoints); |
|
1100
|
1153 |
|
|
1154 if (! error_state) |
|
3322
|
1155 retval (0) = octave_value (rv, 0); |
|
1100
|
1156 } |
|
|
1157 } |
|
|
1158 else |
|
3322
|
1159 { |
|
|
1160 double x1 = arg_1.double_value (); |
|
|
1161 double x2 = arg_2.double_value (); |
|
|
1162 |
|
|
1163 if (! error_state) |
|
|
1164 { |
|
|
1165 RowVector rv = linspace (x1, x2, npoints); |
|
|
1166 |
|
|
1167 if (! error_state) |
|
|
1168 retval (0) = octave_value (rv, 0); |
|
|
1169 } |
|
|
1170 } |
|
1100
|
1171 } |
|
|
1172 |
|
|
1173 return retval; |
|
|
1174 } |
|
|
1175 |
|
2188
|
1176 static int |
|
|
1177 treat_neg_dim_as_zero (void) |
|
|
1178 { |
|
|
1179 Vtreat_neg_dim_as_zero = check_preference ("treat_neg_dim_as_zero"); |
|
|
1180 |
|
|
1181 return 0; |
|
|
1182 } |
|
|
1183 |
|
2184
|
1184 void |
|
|
1185 symbols_of_data (void) |
|
|
1186 { |
|
3321
|
1187 |
|
|
1188 #define IMAGINARY_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1189 @defvr {Built-in Variable} I\n\ |
|
|
1190 @defvrx {Built-in Variable} J\n\ |
|
|
1191 @defvrx {Built-in Variable} i\n\ |
|
|
1192 @defvrx {Built-in Variable} j\n\ |
|
|
1193 A pure imaginary number, defined as\n\ |
|
|
1194 @iftex\n\ |
|
|
1195 @tex\n\ |
|
|
1196 $\\sqrt{-1}$.\n\ |
|
|
1197 @end tex\n\ |
|
|
1198 @end iftex\n\ |
|
|
1199 @ifinfo\n\ |
|
|
1200 @code{sqrt (-1)}.\n\ |
|
|
1201 @end ifinfo\n\ |
|
|
1202 The @code{I} and @code{J} forms are true constants, and cannot be\n\ |
|
|
1203 modified. The @code{i} and @code{j} forms are like ordinary variables,\n\ |
|
|
1204 and may be used for other purposes. However, unlike other variables,\n\ |
|
|
1205 they once again assume their special predefined values if they are\n\ |
|
|
1206 cleared @xref{Status of Variables}.\n\ |
|
|
1207 @end defvr" |
|
|
1208 |
|
|
1209 #define INFINITY_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1210 @defvr {Built-in Variable} Inf\n\ |
|
|
1211 @defvrx {Built-in Variable} inf\n\ |
|
|
1212 Infinity. This is the result of an operation like 1/0, or an operation\n\ |
|
|
1213 that results in a floating point overflow.\n\ |
|
|
1214 @end defvr" |
|
|
1215 |
|
|
1216 #define NAN_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1217 @defvr {Built-in Variable} NaN\n\ |
|
|
1218 @defvrx {Built-in Variable} nan\n\ |
|
|
1219 Not a number. This is the result of an operation like\n\ |
|
|
1220 @iftex\n\ |
|
|
1221 @tex\n\ |
|
|
1222 $0/0$, or $\\infty - \\infty$,\n\ |
|
|
1223 @end tex\n\ |
|
|
1224 @end iftex\n\ |
|
|
1225 @ifinfo\n\ |
|
|
1226 0/0, or @samp{Inf - Inf},\n\ |
|
|
1227 @end ifinfo\n\ |
|
|
1228 or any operation with a NaN.\n\ |
|
|
1229 \n\ |
|
|
1230 Note that NaN always compares not equal to NaN. This behavior is\n\ |
|
|
1231 specified by the IEEE standard for floating point arithmetic. To\n\ |
|
|
1232 find NaN values, you must use the @code{isnan} function.\n\ |
|
|
1233 @end defvr" |
|
|
1234 |
|
3141
|
1235 DEFCONST (I, Complex (0.0, 1.0), |
|
3321
|
1236 IMAGINARY_DOC_STRING); |
|
2184
|
1237 |
|
3141
|
1238 DEFCONST (Inf, octave_Inf, |
|
3321
|
1239 INFINITY_DOC_STRING); |
|
2184
|
1240 |
|
3141
|
1241 DEFCONST (J, Complex (0.0, 1.0), |
|
3321
|
1242 IMAGINARY_DOC_STRING); |
|
2184
|
1243 |
|
3141
|
1244 DEFCONST (NaN, octave_NaN, |
|
3321
|
1245 NAN_DOC_STRING); |
|
2184
|
1246 |
|
|
1247 #if defined (M_E) |
|
|
1248 double e_val = M_E; |
|
|
1249 #else |
|
|
1250 double e_val = exp (1.0); |
|
|
1251 #endif |
|
|
1252 |
|
3141
|
1253 DEFCONST (e, e_val, |
|
3321
|
1254 "-*- texinfo -*-\n\ |
|
|
1255 @defvr {Built-in Variable} e\n\ |
|
|
1256 The base of natural logarithms. The constant\n\ |
|
|
1257 @iftex\n\ |
|
|
1258 @tex\n\ |
|
|
1259 $e$\n\ |
|
|
1260 @end tex\n\ |
|
|
1261 @end iftex\n\ |
|
|
1262 @ifinfo\n\ |
|
|
1263 @var{e}\n\ |
|
|
1264 @end ifinfo\n\ |
|
|
1265 satisfies the equation\n\ |
|
|
1266 @iftex\n\ |
|
|
1267 @tex\n\ |
|
|
1268 $\\log (e) = 1$.\n\ |
|
|
1269 @end tex\n\ |
|
|
1270 @end iftex\n\ |
|
|
1271 @ifinfo\n\ |
|
|
1272 @code{log} (@var{e}) = 1.\n\ |
|
|
1273 @end ifinfo\n\ |
|
|
1274 @end defvr"); |
|
2184
|
1275 |
|
3141
|
1276 DEFCONST (eps, DBL_EPSILON, |
|
3321
|
1277 "-*- texinfo -*-\n\ |
|
|
1278 @defvr {Built-in Variable} eps\n\ |
|
|
1279 The machine precision. More precisely, @code{eps} is the largest\n\ |
|
|
1280 relative spacing between any two adjacent numbers in the machine's\n\ |
|
|
1281 floating point system. This number is obviously system-dependent. On\n\ |
|
|
1282 machines that support 64 bit IEEE floating point arithmetic, @code{eps}\n\ |
|
|
1283 is approximately\n\ |
|
|
1284 @ifinfo\n\ |
|
|
1285 2.2204e-16.\n\ |
|
|
1286 @end ifinfo\n\ |
|
|
1287 @iftex\n\ |
|
|
1288 @tex\n\ |
|
|
1289 $2.2204\\times10^{-16}$.\n\ |
|
|
1290 @end tex\n\ |
|
|
1291 @end iftex\n\ |
|
|
1292 @end defvr"); |
|
2184
|
1293 |
|
3258
|
1294 DEFCONST (false, false, |
|
|
1295 "logical false value"); |
|
|
1296 |
|
3141
|
1297 DEFCONST (i, Complex (0.0, 1.0), |
|
3321
|
1298 IMAGINARY_DOC_STRING); |
|
2184
|
1299 |
|
3141
|
1300 DEFCONST (inf, octave_Inf, |
|
3321
|
1301 INFINITY_DOC_STRING); |
|
2184
|
1302 |
|
3141
|
1303 DEFCONST (j, Complex (0.0, 1.0), |
|
3321
|
1304 IMAGINARY_DOC_STRING); |
|
2184
|
1305 |
|
3141
|
1306 DEFCONST (nan, octave_NaN, |
|
3321
|
1307 NAN_DOC_STRING); |
|
2184
|
1308 |
|
|
1309 #if defined (M_PI) |
|
|
1310 double pi_val = M_PI; |
|
|
1311 #else |
|
|
1312 double pi_val = 4.0 * atan (1.0); |
|
|
1313 #endif |
|
|
1314 |
|
3141
|
1315 DEFCONST (pi, pi_val, |
|
3321
|
1316 "-*- texinfo -*-\n\ |
|
|
1317 @defvr {Built-in Variable} pi\n\ |
|
|
1318 The ratio of the circumference of a circle to its diameter.\n\ |
|
|
1319 Internally, @code{pi} is computed as @samp{4.0 * atan (1.0)}.\n\ |
|
|
1320 @end defvr"); |
|
2184
|
1321 |
|
3141
|
1322 DEFCONST (realmax, DBL_MAX, |
|
3321
|
1323 "-*- texinfo -*-\n\ |
|
|
1324 @defvr {Built-in Variable} realmax\n\ |
|
|
1325 The largest floating point number that is representable. The actual\n\ |
|
|
1326 value is system-dependent. On machines that support 64 bit IEEE\n\ |
|
|
1327 floating point arithmetic, @code{realmax} is approximately\n\ |
|
|
1328 @ifinfo\n\ |
|
|
1329 1.7977e+308\n\ |
|
|
1330 @end ifinfo\n\ |
|
|
1331 @iftex\n\ |
|
|
1332 @tex\n\ |
|
|
1333 $1.7977\\times10^{308}$.\n\ |
|
|
1334 @end tex\n\ |
|
|
1335 @end iftex\n\ |
|
|
1336 @end defvr"); |
|
2184
|
1337 |
|
3141
|
1338 DEFCONST (realmin, DBL_MIN, |
|
3321
|
1339 "-*- texinfo -*-\n\ |
|
|
1340 @defvr {Built-in Variable} realmin\n\ |
|
|
1341 The smallest floating point number that is representable. The actual\n\ |
|
|
1342 value is system-dependent. On machines that support 64 bit IEEE\n\ |
|
|
1343 floating point arithmetic, @code{realmin} is approximately\n\ |
|
|
1344 @ifinfo\n\ |
|
|
1345 2.2251e-308\n\ |
|
|
1346 @end ifinfo\n\ |
|
|
1347 @iftex\n\ |
|
|
1348 @tex\n\ |
|
|
1349 $2.2251\\times10^{-308}$.\n\ |
|
|
1350 @end tex\n\ |
|
|
1351 @end iftex\n\ |
|
|
1352 @end defvr"); |
|
2188
|
1353 |
|
3258
|
1354 DEFVAR (treat_neg_dim_as_zero, 0.0, treat_neg_dim_as_zero, |
|
2188
|
1355 "convert negative dimensions to zero"); |
|
3258
|
1356 |
|
|
1357 DEFCONST (true, true, |
|
|
1358 "logical true value"); |
|
2184
|
1359 } |
|
|
1360 |
|
523
|
1361 /* |
|
|
1362 ;;; Local Variables: *** |
|
|
1363 ;;; mode: C++ *** |
|
|
1364 ;;; End: *** |
|
|
1365 */ |
