|
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" |
|
4153
|
34 #include "quit.h" |
|
1755
|
35 |
|
1352
|
36 #include "defun.h" |
|
|
37 #include "error.h" |
|
|
38 #include "gripes.h" |
|
2366
|
39 #include "ov.h" |
|
|
40 #include "variables.h" |
|
1742
|
41 #include "oct-obj.h" |
|
523
|
42 #include "utils.h" |
|
4806
|
43 #include "Cell.h" |
|
|
44 #include "oct-map.h" |
|
4915
|
45 #include "pt-mat.h" |
|
523
|
46 |
|
4015
|
47 #define ANY_ALL(FCN) \ |
|
|
48 \ |
|
4233
|
49 octave_value retval; \ |
|
4015
|
50 \ |
|
|
51 int nargin = args.length (); \ |
|
|
52 \ |
|
4021
|
53 if (nargin == 1 || nargin == 2) \ |
|
4015
|
54 { \ |
|
4021
|
55 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \ |
|
|
56 \ |
|
|
57 if (! error_state) \ |
|
|
58 { \ |
|
4556
|
59 if (dim >= -1) \ |
|
4015
|
60 retval = args(0).FCN (dim); \ |
|
4021
|
61 else \ |
|
|
62 error (#FCN ": invalid dimension argument = %d", dim + 1); \ |
|
|
63 } \ |
|
4015
|
64 else \ |
|
4021
|
65 error (#FCN ": expecting dimension argument to be an integer"); \ |
|
4015
|
66 } \ |
|
4021
|
67 else \ |
|
|
68 print_usage (#FCN); \ |
|
4015
|
69 \ |
|
|
70 return retval |
|
|
71 |
|
1957
|
72 DEFUN (all, args, , |
|
3369
|
73 "-*- texinfo -*-\n\ |
|
4015
|
74 @deftypefn {Built-in Function} {} all (@var{x}, @var{dim})\n\ |
|
3369
|
75 The function @code{all} behaves like the function @code{any}, except\n\ |
|
|
76 that it returns true only if all the elements of a vector, or all the\n\ |
|
4015
|
77 elements along dimension @var{dim} of a matrix, are nonzero.\n\ |
|
3369
|
78 @end deftypefn") |
|
523
|
79 { |
|
4015
|
80 ANY_ALL (all); |
|
523
|
81 } |
|
|
82 |
|
1957
|
83 DEFUN (any, args, , |
|
3369
|
84 "-*- texinfo -*-\n\ |
|
4015
|
85 @deftypefn {Built-in Function} {} any (@var{x}, @var{dim})\n\ |
|
3369
|
86 For a vector argument, return 1 if any element of the vector is\n\ |
|
|
87 nonzero.\n\ |
|
|
88 \n\ |
|
|
89 For a matrix argument, return a row vector of ones and\n\ |
|
|
90 zeros with each element indicating whether any of the elements of the\n\ |
|
|
91 corresponding column of the matrix are nonzero. For example,\n\ |
|
|
92 \n\ |
|
|
93 @example\n\ |
|
|
94 @group\n\ |
|
|
95 any (eye (2, 4))\n\ |
|
|
96 @result{} [ 1, 1, 0, 0 ]\n\ |
|
|
97 @end group\n\ |
|
|
98 @end example\n\ |
|
|
99 \n\ |
|
4015
|
100 If the optional argument @var{dim} is supplied, work along dimension\n\ |
|
|
101 @var{dim}. For example,\n\ |
|
3369
|
102 \n\ |
|
|
103 @example\n\ |
|
4015
|
104 @group\n\ |
|
|
105 any (eye (2, 4), 2)\n\ |
|
|
106 @result{} [ 1; 1 ]\n\ |
|
|
107 @end group\n\ |
|
3369
|
108 @end example\n\ |
|
|
109 @end deftypefn") |
|
523
|
110 { |
|
4015
|
111 ANY_ALL (any); |
|
523
|
112 } |
|
|
113 |
|
649
|
114 // These mapping functions may also be useful in other places, eh? |
|
|
115 |
|
|
116 typedef double (*d_dd_fcn) (double, double); |
|
|
117 |
|
|
118 static Matrix |
|
2672
|
119 map_d_m (d_dd_fcn f, double x, const Matrix& y) |
|
649
|
120 { |
|
|
121 int nr = y.rows (); |
|
|
122 int nc = y.columns (); |
|
|
123 |
|
|
124 Matrix retval (nr, nc); |
|
|
125 |
|
|
126 for (int j = 0; j < nc; j++) |
|
|
127 for (int i = 0; i < nr; i++) |
|
4153
|
128 { |
|
|
129 OCTAVE_QUIT; |
|
|
130 retval (i, j) = f (x, y (i, j)); |
|
|
131 } |
|
649
|
132 |
|
|
133 return retval; |
|
|
134 } |
|
|
135 |
|
|
136 static Matrix |
|
2672
|
137 map_m_d (d_dd_fcn f, const Matrix& x, double y) |
|
649
|
138 { |
|
|
139 int nr = x.rows (); |
|
|
140 int nc = x.columns (); |
|
|
141 |
|
|
142 Matrix retval (nr, nc); |
|
|
143 |
|
|
144 for (int j = 0; j < nc; j++) |
|
|
145 for (int i = 0; i < nr; i++) |
|
4153
|
146 { |
|
|
147 OCTAVE_QUIT; |
|
|
148 retval (i, j) = f (x (i, j), y); |
|
|
149 } |
|
649
|
150 |
|
|
151 return retval; |
|
|
152 } |
|
|
153 |
|
|
154 static Matrix |
|
2672
|
155 map_m_m (d_dd_fcn f, const Matrix& x, const Matrix& y) |
|
649
|
156 { |
|
|
157 int x_nr = x.rows (); |
|
|
158 int x_nc = x.columns (); |
|
|
159 |
|
|
160 int y_nr = y.rows (); |
|
|
161 int y_nc = y.columns (); |
|
|
162 |
|
719
|
163 assert (x_nr == y_nr && x_nc == y_nc); |
|
649
|
164 |
|
|
165 Matrix retval (x_nr, x_nc); |
|
|
166 |
|
|
167 for (int j = 0; j < x_nc; j++) |
|
|
168 for (int i = 0; i < x_nr; i++) |
|
4153
|
169 { |
|
|
170 OCTAVE_QUIT; |
|
|
171 retval (i, j) = f (x (i, j), y (i, j)); |
|
|
172 } |
|
649
|
173 |
|
|
174 return retval; |
|
|
175 } |
|
|
176 |
|
1957
|
177 DEFUN (atan2, args, , |
|
3428
|
178 "-*- texinfo -*-\n\ |
|
|
179 @deftypefn {Mapping Function} {} atan2 (@var{y}, @var{x})\n\ |
|
|
180 Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\ |
|
|
181 and @var{x}. The result is in range -pi to pi.\n\ |
|
3439
|
182 @end deftypefn") |
|
649
|
183 { |
|
4233
|
184 octave_value retval; |
|
649
|
185 |
|
712
|
186 int nargin = args.length (); |
|
|
187 |
|
|
188 if (nargin == 2 && args(0).is_defined () && args(1).is_defined ()) |
|
649
|
189 { |
|
2086
|
190 octave_value arg_y = args(0); |
|
|
191 octave_value arg_x = args(1); |
|
649
|
192 |
|
|
193 int y_nr = arg_y.rows (); |
|
|
194 int y_nc = arg_y.columns (); |
|
|
195 |
|
|
196 int x_nr = arg_x.rows (); |
|
|
197 int x_nc = arg_x.columns (); |
|
|
198 |
|
|
199 int arg_y_empty = empty_arg ("atan2", y_nr, y_nc); |
|
|
200 int arg_x_empty = empty_arg ("atan2", x_nr, x_nc); |
|
|
201 |
|
719
|
202 if (arg_y_empty > 0 && arg_x_empty > 0) |
|
4233
|
203 return octave_value (Matrix ()); |
|
719
|
204 else if (arg_y_empty || arg_x_empty) |
|
649
|
205 return retval; |
|
|
206 |
|
|
207 int y_is_scalar = (y_nr == 1 && y_nc == 1); |
|
|
208 int x_is_scalar = (x_nr == 1 && x_nc == 1); |
|
|
209 |
|
|
210 if (y_is_scalar && x_is_scalar) |
|
|
211 { |
|
|
212 double y = arg_y.double_value (); |
|
|
213 |
|
|
214 if (! error_state) |
|
|
215 { |
|
|
216 double x = arg_x.double_value (); |
|
|
217 |
|
|
218 if (! error_state) |
|
|
219 retval = atan2 (y, x); |
|
|
220 } |
|
|
221 } |
|
|
222 else if (y_is_scalar) |
|
|
223 { |
|
|
224 double y = arg_y.double_value (); |
|
|
225 |
|
|
226 if (! error_state) |
|
|
227 { |
|
|
228 Matrix x = arg_x.matrix_value (); |
|
|
229 |
|
|
230 if (! error_state) |
|
2672
|
231 retval = map_d_m (atan2, y, x); |
|
649
|
232 } |
|
|
233 } |
|
|
234 else if (x_is_scalar) |
|
|
235 { |
|
|
236 Matrix y = arg_y.matrix_value (); |
|
|
237 |
|
|
238 if (! error_state) |
|
|
239 { |
|
|
240 double x = arg_x.double_value (); |
|
|
241 |
|
|
242 if (! error_state) |
|
2672
|
243 retval = map_m_d (atan2, y, x); |
|
649
|
244 } |
|
|
245 } |
|
|
246 else if (y_nr == x_nr && y_nc == x_nc) |
|
|
247 { |
|
|
248 Matrix y = arg_y.matrix_value (); |
|
|
249 |
|
|
250 if (! error_state) |
|
|
251 { |
|
|
252 Matrix x = arg_x.matrix_value (); |
|
|
253 |
|
|
254 if (! error_state) |
|
2672
|
255 retval = map_m_m (atan2, y, x); |
|
649
|
256 } |
|
|
257 } |
|
|
258 else |
|
|
259 error ("atan2: nonconformant matrices"); |
|
|
260 } |
|
712
|
261 else |
|
|
262 print_usage ("atan2"); |
|
649
|
263 |
|
|
264 return retval; |
|
|
265 } |
|
|
266 |
|
4311
|
267 DEFUN (fmod, args, , |
|
|
268 "-*- texinfo -*-\n\ |
|
|
269 @deftypefn {Mapping Function} {} fmod (@var{x}, @var{y})\n\ |
|
4685
|
270 Compute the floating point remainder of dividing @var{x} by @var{y}\n\ |
|
|
271 using the C library function @code{fmod}. The result has the same\n\ |
|
|
272 sign as @var{x}. If @var{y} is zero, the result implementation-defined.\n\ |
|
4311
|
273 @end deftypefn") |
|
|
274 { |
|
|
275 octave_value retval; |
|
|
276 |
|
|
277 int nargin = args.length (); |
|
|
278 |
|
|
279 if (nargin == 2 && args(0).is_defined () && args(1).is_defined ()) |
|
|
280 { |
|
|
281 octave_value arg_x = args(0); |
|
|
282 octave_value arg_y = args(1); |
|
|
283 |
|
|
284 int y_nr = arg_y.rows (); |
|
|
285 int y_nc = arg_y.columns (); |
|
|
286 |
|
|
287 int x_nr = arg_x.rows (); |
|
|
288 int x_nc = arg_x.columns (); |
|
|
289 |
|
|
290 int arg_y_empty = empty_arg ("fmod", y_nr, y_nc); |
|
|
291 int arg_x_empty = empty_arg ("fmod", x_nr, x_nc); |
|
|
292 |
|
|
293 if (arg_y_empty > 0 && arg_x_empty > 0) |
|
|
294 return octave_value (Matrix ()); |
|
|
295 else if (arg_y_empty || arg_x_empty) |
|
|
296 return retval; |
|
|
297 |
|
|
298 int y_is_scalar = (y_nr == 1 && y_nc == 1); |
|
|
299 int x_is_scalar = (x_nr == 1 && x_nc == 1); |
|
|
300 |
|
|
301 if (y_is_scalar && x_is_scalar) |
|
|
302 { |
|
|
303 double y = arg_y.double_value (); |
|
|
304 |
|
|
305 if (! error_state) |
|
|
306 { |
|
|
307 double x = arg_x.double_value (); |
|
|
308 |
|
|
309 if (! error_state) |
|
|
310 retval = fmod (x, y); |
|
|
311 } |
|
|
312 } |
|
|
313 else if (y_is_scalar) |
|
|
314 { |
|
|
315 double y = arg_y.double_value (); |
|
|
316 |
|
|
317 if (! error_state) |
|
|
318 { |
|
|
319 Matrix x = arg_x.matrix_value (); |
|
|
320 |
|
|
321 if (! error_state) |
|
|
322 retval = map_m_d (fmod, x, y); |
|
|
323 } |
|
|
324 } |
|
|
325 else if (x_is_scalar) |
|
|
326 { |
|
|
327 Matrix y = arg_y.matrix_value (); |
|
|
328 |
|
|
329 if (! error_state) |
|
|
330 { |
|
|
331 double x = arg_x.double_value (); |
|
|
332 |
|
|
333 if (! error_state) |
|
|
334 retval = map_d_m (fmod, x, y); |
|
|
335 } |
|
|
336 } |
|
|
337 else if (y_nr == x_nr && y_nc == x_nc) |
|
|
338 { |
|
|
339 Matrix y = arg_y.matrix_value (); |
|
|
340 |
|
|
341 if (! error_state) |
|
|
342 { |
|
|
343 Matrix x = arg_x.matrix_value (); |
|
|
344 |
|
|
345 if (! error_state) |
|
|
346 retval = map_m_m (fmod, x, y); |
|
|
347 } |
|
|
348 } |
|
|
349 else |
|
|
350 error ("fmod: nonconformant matrices"); |
|
|
351 } |
|
|
352 else |
|
|
353 print_usage ("fmod"); |
|
|
354 |
|
|
355 return retval; |
|
|
356 } |
|
|
357 |
|
3723
|
358 #define DATA_REDUCTION(FCN) \ |
|
|
359 \ |
|
4233
|
360 octave_value retval; \ |
|
3723
|
361 \ |
|
|
362 int nargin = args.length (); \ |
|
|
363 \ |
|
|
364 if (nargin == 1 || nargin == 2) \ |
|
|
365 { \ |
|
|
366 octave_value arg = args(0); \ |
|
|
367 \ |
|
3864
|
368 int dim = (nargin == 1 ? -1 : args(1).int_value (true) - 1); \ |
|
3723
|
369 \ |
|
|
370 if (! error_state) \ |
|
|
371 { \ |
|
4556
|
372 if (dim >= -1) \ |
|
3723
|
373 { \ |
|
|
374 if (arg.is_real_type ()) \ |
|
|
375 { \ |
|
4569
|
376 NDArray tmp = arg.array_value (); \ |
|
3723
|
377 \ |
|
|
378 if (! error_state) \ |
|
4233
|
379 retval = tmp.FCN (dim); \ |
|
3723
|
380 } \ |
|
|
381 else if (arg.is_complex_type ()) \ |
|
|
382 { \ |
|
4569
|
383 ComplexNDArray tmp = arg.complex_array_value (); \ |
|
3723
|
384 \ |
|
|
385 if (! error_state) \ |
|
4233
|
386 retval = tmp.FCN (dim); \ |
|
3723
|
387 } \ |
|
|
388 else \ |
|
|
389 { \ |
|
|
390 gripe_wrong_type_arg (#FCN, arg); \ |
|
|
391 return retval; \ |
|
|
392 } \ |
|
|
393 } \ |
|
|
394 else \ |
|
|
395 error (#FCN ": invalid dimension argument = %d", dim + 1); \ |
|
|
396 } \ |
|
|
397 } \ |
|
|
398 else \ |
|
|
399 print_usage (#FCN); \ |
|
|
400 \ |
|
|
401 return retval |
|
|
402 |
|
1957
|
403 DEFUN (cumprod, args, , |
|
3428
|
404 "-*- texinfo -*-\n\ |
|
3723
|
405 @deftypefn {Built-in Function} {} cumprod (@var{x}, @var{dim})\n\ |
|
|
406 Cumulative product of elements along dimension @var{dim}. If\n\ |
|
|
407 @var{dim} is omitted, it defaults to 1 (column-wise cumulative\n\ |
|
|
408 products).\n\ |
|
5061
|
409 \n\ |
|
|
410 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\ |
|
|
411 return the cumulative product of the elements as a vector with the\n\ |
|
|
412 same orientation as @var{x}.\n\ |
|
3428
|
413 @end deftypefn") |
|
523
|
414 { |
|
3723
|
415 DATA_REDUCTION (cumprod); |
|
523
|
416 } |
|
|
417 |
|
1957
|
418 DEFUN (cumsum, args, , |
|
3428
|
419 "-*- texinfo -*-\n\ |
|
3723
|
420 @deftypefn {Built-in Function} {} cumsum (@var{x}, @var{dim})\n\ |
|
|
421 Cumulative sum of elements along dimension @var{dim}. If @var{dim}\n\ |
|
|
422 is omitted, it defaults to 1 (column-wise cumulative sums).\n\ |
|
5061
|
423 \n\ |
|
|
424 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\ |
|
|
425 return the cumulative sum of the elements as a vector with the\n\ |
|
|
426 same orientation as @var{x}.\n\ |
|
3428
|
427 @end deftypefn") |
|
523
|
428 { |
|
3723
|
429 DATA_REDUCTION (cumsum); |
|
523
|
430 } |
|
|
431 |
|
3972
|
432 // XXX FIXME XXX -- we could eliminate some duplicate code here with |
|
|
433 // some template functions or macros. |
|
|
434 |
|
2086
|
435 static octave_value |
|
767
|
436 make_diag (const Matrix& v, int k) |
|
|
437 { |
|
|
438 int nr = v.rows (); |
|
|
439 int nc = v.columns (); |
|
|
440 assert (nc == 1 || nr == 1); |
|
|
441 |
|
2086
|
442 octave_value retval; |
|
767
|
443 |
|
|
444 int roff = 0; |
|
|
445 int coff = 0; |
|
|
446 if (k > 0) |
|
|
447 { |
|
|
448 roff = 0; |
|
|
449 coff = k; |
|
|
450 } |
|
|
451 else if (k < 0) |
|
|
452 { |
|
|
453 roff = -k; |
|
|
454 coff = 0; |
|
|
455 } |
|
|
456 |
|
|
457 if (nr == 1) |
|
|
458 { |
|
4479
|
459 int n = nc + std::abs (k); |
|
767
|
460 Matrix m (n, n, 0.0); |
|
|
461 for (int i = 0; i < nc; i++) |
|
2305
|
462 m (i+roff, i+coff) = v (0, i); |
|
4233
|
463 retval = m; |
|
767
|
464 } |
|
|
465 else |
|
|
466 { |
|
4479
|
467 int n = nr + std::abs (k); |
|
767
|
468 Matrix m (n, n, 0.0); |
|
|
469 for (int i = 0; i < nr; i++) |
|
2305
|
470 m (i+roff, i+coff) = v (i, 0); |
|
4233
|
471 retval = m; |
|
767
|
472 } |
|
|
473 |
|
|
474 return retval; |
|
|
475 } |
|
|
476 |
|
2086
|
477 static octave_value |
|
767
|
478 make_diag (const ComplexMatrix& v, int k) |
|
|
479 { |
|
|
480 int nr = v.rows (); |
|
|
481 int nc = v.columns (); |
|
|
482 assert (nc == 1 || nr == 1); |
|
|
483 |
|
2086
|
484 octave_value retval; |
|
767
|
485 |
|
|
486 int roff = 0; |
|
|
487 int coff = 0; |
|
|
488 if (k > 0) |
|
|
489 { |
|
|
490 roff = 0; |
|
|
491 coff = k; |
|
|
492 } |
|
|
493 else if (k < 0) |
|
|
494 { |
|
|
495 roff = -k; |
|
|
496 coff = 0; |
|
|
497 } |
|
|
498 |
|
|
499 if (nr == 1) |
|
|
500 { |
|
4479
|
501 int n = nc + std::abs (k); |
|
767
|
502 ComplexMatrix m (n, n, 0.0); |
|
|
503 for (int i = 0; i < nc; i++) |
|
2305
|
504 m (i+roff, i+coff) = v (0, i); |
|
4233
|
505 retval = m; |
|
767
|
506 } |
|
|
507 else |
|
|
508 { |
|
4479
|
509 int n = nr + std::abs (k); |
|
767
|
510 ComplexMatrix m (n, n, 0.0); |
|
|
511 for (int i = 0; i < nr; i++) |
|
2305
|
512 m (i+roff, i+coff) = v (i, 0); |
|
4233
|
513 retval = m; |
|
767
|
514 } |
|
|
515 |
|
|
516 return retval; |
|
|
517 } |
|
|
518 |
|
2086
|
519 static octave_value |
|
|
520 make_diag (const octave_value& arg) |
|
767
|
521 { |
|
2086
|
522 octave_value retval; |
|
767
|
523 |
|
|
524 if (arg.is_real_type ()) |
|
|
525 { |
|
|
526 Matrix m = arg.matrix_value (); |
|
|
527 |
|
|
528 if (! error_state) |
|
|
529 { |
|
|
530 int nr = m.rows (); |
|
|
531 int nc = m.columns (); |
|
|
532 |
|
|
533 if (nr == 0 || nc == 0) |
|
|
534 retval = Matrix (); |
|
|
535 else if (nr == 1 || nc == 1) |
|
|
536 retval = make_diag (m, 0); |
|
|
537 else |
|
|
538 { |
|
|
539 ColumnVector v = m.diag (); |
|
|
540 if (v.capacity () > 0) |
|
|
541 retval = v; |
|
|
542 } |
|
|
543 } |
|
|
544 else |
|
|
545 gripe_wrong_type_arg ("diag", arg); |
|
|
546 } |
|
|
547 else if (arg.is_complex_type ()) |
|
|
548 { |
|
|
549 ComplexMatrix cm = arg.complex_matrix_value (); |
|
|
550 |
|
|
551 if (! error_state) |
|
|
552 { |
|
|
553 int nr = cm.rows (); |
|
|
554 int nc = cm.columns (); |
|
|
555 |
|
|
556 if (nr == 0 || nc == 0) |
|
|
557 retval = Matrix (); |
|
|
558 else if (nr == 1 || nc == 1) |
|
|
559 retval = make_diag (cm, 0); |
|
|
560 else |
|
|
561 { |
|
|
562 ComplexColumnVector v = cm.diag (); |
|
|
563 if (v.capacity () > 0) |
|
|
564 retval = v; |
|
|
565 } |
|
|
566 } |
|
|
567 else |
|
|
568 gripe_wrong_type_arg ("diag", arg); |
|
|
569 } |
|
|
570 else |
|
|
571 gripe_wrong_type_arg ("diag", arg); |
|
|
572 |
|
|
573 return retval; |
|
|
574 } |
|
|
575 |
|
2086
|
576 static octave_value |
|
|
577 make_diag (const octave_value& a, const octave_value& b) |
|
767
|
578 { |
|
2086
|
579 octave_value retval; |
|
767
|
580 |
|
4732
|
581 int k = b.int_value (); |
|
767
|
582 |
|
|
583 if (error_state) |
|
|
584 { |
|
|
585 error ("diag: invalid second argument"); |
|
|
586 return retval; |
|
|
587 } |
|
|
588 |
|
|
589 if (a.is_real_type ()) |
|
|
590 { |
|
3307
|
591 Matrix m = a.matrix_value (); |
|
767
|
592 |
|
3307
|
593 if (! error_state) |
|
767
|
594 { |
|
|
595 int nr = m.rows (); |
|
|
596 int nc = m.columns (); |
|
|
597 |
|
3972
|
598 if (nr == 1 || nc == 1) |
|
|
599 retval = make_diag (m, k); |
|
|
600 else if (nr == 0 || nc == 0) |
|
767
|
601 retval = Matrix (); |
|
|
602 else |
|
|
603 { |
|
|
604 ColumnVector d = m.diag (k); |
|
|
605 retval = d; |
|
|
606 } |
|
|
607 } |
|
|
608 } |
|
|
609 else if (a.is_complex_type ()) |
|
|
610 { |
|
3307
|
611 ComplexMatrix cm = a.complex_matrix_value (); |
|
767
|
612 |
|
3307
|
613 if (! error_state) |
|
767
|
614 { |
|
|
615 int nr = cm.rows (); |
|
|
616 int nc = cm.columns (); |
|
|
617 |
|
3972
|
618 if (nr == 1 || nc == 1) |
|
|
619 retval = make_diag (cm, k); |
|
|
620 else if (nr == 0 || nc == 0) |
|
767
|
621 retval = Matrix (); |
|
|
622 else |
|
|
623 { |
|
|
624 ComplexColumnVector d = cm.diag (k); |
|
|
625 retval = d; |
|
|
626 } |
|
|
627 } |
|
|
628 } |
|
|
629 else |
|
|
630 gripe_wrong_type_arg ("diag", a); |
|
|
631 |
|
|
632 return retval; |
|
|
633 } |
|
|
634 |
|
1957
|
635 DEFUN (diag, args, , |
|
3369
|
636 "-*- texinfo -*-\n\ |
|
|
637 @deftypefn {Built-in Function} {} diag (@var{v}, @var{k})\n\ |
|
|
638 Return a diagonal matrix with vector @var{v} on diagonal @var{k}. The\n\ |
|
|
639 second argument is optional. If it is positive, the vector is placed on\n\ |
|
|
640 the @var{k}-th super-diagonal. If it is negative, it is placed on the\n\ |
|
|
641 @var{-k}-th sub-diagonal. The default value of @var{k} is 0, and the\n\ |
|
|
642 vector is placed on the main diagonal. For example,\n\ |
|
|
643 \n\ |
|
|
644 @example\n\ |
|
|
645 @group\n\ |
|
|
646 diag ([1, 2, 3], 1)\n\ |
|
|
647 @result{} 0 1 0 0\n\ |
|
|
648 0 0 2 0\n\ |
|
|
649 0 0 0 3\n\ |
|
|
650 0 0 0 0\n\ |
|
|
651 @end group\n\ |
|
|
652 @end example\n\ |
|
|
653 @end deftypefn") |
|
523
|
654 { |
|
4233
|
655 octave_value retval; |
|
523
|
656 |
|
|
657 int nargin = args.length (); |
|
|
658 |
|
712
|
659 if (nargin == 1 && args(0).is_defined ()) |
|
767
|
660 retval = make_diag (args(0)); |
|
712
|
661 else if (nargin == 2 && args(0).is_defined () && args(1).is_defined ()) |
|
767
|
662 retval = make_diag (args(0), args(1)); |
|
523
|
663 else |
|
|
664 print_usage ("diag"); |
|
|
665 |
|
|
666 return retval; |
|
|
667 } |
|
|
668 |
|
1957
|
669 DEFUN (prod, args, , |
|
3428
|
670 "-*- texinfo -*-\n\ |
|
3723
|
671 @deftypefn {Built-in Function} {} prod (@var{x}, @var{dim})\n\ |
|
|
672 Product of elements along dimension @var{dim}. If @var{dim} is\n\ |
|
|
673 omitted, it defaults to 1 (column-wise products).\n\ |
|
5061
|
674 \n\ |
|
|
675 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\ |
|
|
676 return the product of the elements.\n\ |
|
3428
|
677 @end deftypefn") |
|
523
|
678 { |
|
3723
|
679 DATA_REDUCTION (prod); |
|
523
|
680 } |
|
|
681 |
|
4824
|
682 static octave_value |
|
|
683 do_cat (const octave_value_list& args, std::string fname) |
|
4806
|
684 { |
|
|
685 octave_value retval; |
|
|
686 |
|
4824
|
687 int n_args = args.length (); |
|
4806
|
688 |
|
4824
|
689 if (n_args > 2) |
|
|
690 { |
|
|
691 int dim = args(0).int_value () - 1; |
|
4806
|
692 |
|
4824
|
693 if (error_state) |
|
4806
|
694 { |
|
4824
|
695 error ("cat: expecting first argument to be a integer"); |
|
4806
|
696 return retval; |
|
|
697 } |
|
|
698 |
|
4824
|
699 if (dim >= 0) |
|
|
700 { |
|
4915
|
701 |
|
|
702 dim_vector dv = args(1).dims (); |
|
4824
|
703 |
|
4915
|
704 for (int i = 2; i < args.length (); i++) |
|
|
705 { |
|
|
706 // add_dims constructs a dimension vector which holds the |
|
4824
|
707 // dimensions of the final array after concatenation. |
|
4806
|
708 |
|
4915
|
709 if (! dv.concat (args(i).dims (), dim)) |
|
4806
|
710 { |
|
4824
|
711 // Dimensions do not match. |
|
4915
|
712 error ("cat: dimension mismatch"); |
|
4806
|
713 return retval; |
|
|
714 } |
|
4824
|
715 } |
|
|
716 |
|
4915
|
717 // The lines below might seem crazy, since we take a copy |
|
|
718 // of the first argument, resize it to be empty and then resize |
|
|
719 // it to be full. This is done since it means that there is no |
|
|
720 // recopying of data, as would happen if we used a single resize. |
|
|
721 // It should be noted that resize operation is also significantly |
|
|
722 // slower than the do_cat_op function, so it makes sense to have an |
|
|
723 // empty matrix and copy all data. |
|
4824
|
724 // |
|
4915
|
725 // We might also start with a empty octave_value using |
|
|
726 // tmp = octave_value_typeinfo::lookup_type (args(1).type_name()); |
|
|
727 // and then directly resize. However, for some types there might be |
|
|
728 // some additional setup needed, and so this should be avoided. |
|
|
729 octave_value tmp; |
|
|
730 bool any_strings = false; |
|
|
731 bool all_strings = true; |
|
|
732 for (int i = 1; i < n_args; i++) |
|
|
733 if (args(i).is_string ()) |
|
|
734 any_strings = true; |
|
|
735 else |
|
|
736 all_strings = false; |
|
4806
|
737 |
|
4915
|
738 if (all_strings) |
|
|
739 tmp = octave_value (charNDArray (dv, Vstring_fill_char), true); |
|
|
740 else |
|
|
741 tmp = args(1).resize (dim_vector (0,0)).resize (dv); |
|
4824
|
742 |
|
4915
|
743 if (error_state) |
|
|
744 return retval; |
|
4824
|
745 |
|
4915
|
746 Array<int> ra_idx (dv.length (), 0); |
|
|
747 for (int i = 1; i < n_args; i++) |
|
|
748 { |
|
|
749 tmp = do_cat_op (tmp, args (i), ra_idx); |
|
4824
|
750 |
|
4915
|
751 if (error_state) |
|
|
752 return retval; |
|
4806
|
753 |
|
4915
|
754 dim_vector dv_tmp = args (i).dims (); |
|
|
755 ra_idx (dim) += (dim < dv_tmp.length () ? dv_tmp (dim) : 1); |
|
|
756 } |
|
4806
|
757 |
|
4915
|
758 if (any_strings && !all_strings) |
|
|
759 retval = tmp.convert_to_str (); |
|
|
760 else |
|
|
761 retval = tmp; |
|
4806
|
762 } |
|
4824
|
763 else print_usage (fname); |
|
4806
|
764 } |
|
|
765 else |
|
4824
|
766 print_usage (fname); |
|
4806
|
767 |
|
|
768 return retval; |
|
|
769 } |
|
|
770 |
|
|
771 DEFUN (horzcat, args, , |
|
4824
|
772 "-*- texinfo -*-\n\ |
|
4806
|
773 @deftypefn {Built-in Function} {} horzcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\ |
|
|
774 Return the horizontal concatenation of N-d array objects, @var{array1},\n\ |
|
|
775 @var{array2}, @dots{}, @var{arrayN} along dimension 2.\n\ |
|
|
776 @end deftypefn\n\ |
|
|
777 @seealso{cat and vertcat}") |
|
|
778 { |
|
|
779 octave_value_list args_tmp = args; |
|
|
780 |
|
|
781 int dim = 2; |
|
|
782 |
|
|
783 octave_value d (dim); |
|
|
784 |
|
|
785 args_tmp.prepend (d); |
|
|
786 |
|
4824
|
787 return do_cat (args_tmp, "horzcat"); |
|
4806
|
788 } |
|
|
789 |
|
|
790 DEFUN (vertcat, args, , |
|
|
791 "-*- texinfo -*-\n\ |
|
|
792 @deftypefn {Built-in Function} {} vertcat (@var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\ |
|
|
793 Return the vertical concatenation of N-d array objects, @var{array1},\n\ |
|
|
794 @var{array2}, @dots{}, @var{arrayN} along dimension 1.\n\ |
|
|
795 @end deftypefn\n\ |
|
|
796 @seealso{cat and horzcat}") |
|
|
797 { |
|
|
798 octave_value_list args_tmp = args; |
|
|
799 |
|
|
800 int dim = 1; |
|
|
801 |
|
|
802 octave_value d (dim); |
|
|
803 |
|
|
804 args_tmp.prepend (d); |
|
|
805 |
|
4824
|
806 return do_cat (args_tmp, "vertcat"); |
|
4806
|
807 } |
|
|
808 |
|
4758
|
809 DEFUN (cat, args, , |
|
|
810 "-*- texinfo -*-\n\ |
|
|
811 @deftypefn {Built-in Function} {} cat (@var{dim}, @var{array1}, @var{array2}, @dots{}, @var{arrayN})\n\ |
|
4806
|
812 Return the concatenation of N-d array objects, @var{array1},\n\ |
|
|
813 @var{array2}, @dots{}, @var{arrayN} along dimension @var{dim}.\n\ |
|
4758
|
814 \n\ |
|
|
815 @example\n\ |
|
|
816 @group\n\ |
|
|
817 A = ones (2, 2);\n\ |
|
|
818 B = zeros (2, 2);\n\ |
|
|
819 cat (2, A, B)\n\ |
|
|
820 @result{} ans =\n\ |
|
|
821 \n\ |
|
|
822 1 1 0 0\n\ |
|
|
823 1 1 0 0\n\ |
|
|
824 @end group\n\ |
|
|
825 @end example\n\ |
|
|
826 \n\ |
|
|
827 Alternatively, we can concatenate @var{A} and @var{B} along the\n\ |
|
|
828 second dimension the following way:\n\ |
|
|
829 \n\ |
|
|
830 @example\n\ |
|
|
831 @group\n\ |
|
|
832 [A, B].\n\ |
|
|
833 @end group\n\ |
|
|
834 @end example\n\ |
|
|
835 \n\ |
|
|
836 @var{dim} can be larger than the dimensions of the N-d array objects\n\ |
|
|
837 and the result will thus have @var{dim} dimensions as the\n\ |
|
|
838 following example shows:\n\ |
|
|
839 @example\n\ |
|
|
840 @group\n\ |
|
|
841 cat (4, ones(2, 2), zeros (2, 2))\n\ |
|
|
842 @result{} ans =\n\ |
|
|
843 \n\ |
|
|
844 ans(:,:,1,1) =\n\ |
|
|
845 \n\ |
|
|
846 1 1\n\ |
|
|
847 1 1\n\ |
|
|
848 \n\ |
|
|
849 ans(:,:,1,2) =\n\ |
|
|
850 0 0\n\ |
|
|
851 0 0\n\ |
|
|
852 @end group\n\ |
|
|
853 @end example\n\ |
|
|
854 \n\ |
|
4806
|
855 @end deftypefn\n\ |
|
|
856 @seealso{horzcat and vertcat}") |
|
4758
|
857 { |
|
4824
|
858 return do_cat (args, "cat"); |
|
4758
|
859 } |
|
|
860 |
|
4593
|
861 static octave_value |
|
|
862 do_permute (const octave_value_list& args, bool inv, const std::string& fname) |
|
|
863 { |
|
|
864 octave_value retval; |
|
|
865 |
|
|
866 if (args.length () == 2 && args(1).length () == args(0).dims ().length ()) |
|
|
867 { |
|
|
868 Array<int> vec = args(1).int_vector_value (); |
|
|
869 |
|
|
870 octave_value ret = args(0).permute (vec, inv); |
|
|
871 |
|
|
872 if (! error_state) |
|
|
873 retval = ret; |
|
|
874 } |
|
|
875 else |
|
|
876 print_usage (fname); |
|
|
877 |
|
|
878 return retval; |
|
|
879 } |
|
|
880 |
|
|
881 DEFUN (permute, args, , |
|
|
882 "-*- texinfo -*-\n\ |
|
|
883 @deftypefn {Built-in Function} {} permute (@var{a}, @var{perm})\n\ |
|
|
884 Return the generalized transpose for an N-d array object @var{a}.\n\ |
|
|
885 The permutation vector @var{perm} must contain the elements\n\ |
|
|
886 @code{1:ndims(a)} (in any order, but each element must appear just once).\n\ |
|
|
887 \n\ |
|
|
888 @end deftypefn\n\ |
|
|
889 @seealso{ipermute}") |
|
|
890 { |
|
|
891 return do_permute (args, false, "permute"); |
|
|
892 } |
|
|
893 |
|
|
894 DEFUN (ipermute, args, , |
|
|
895 "-*- texinfo -*-\n\ |
|
|
896 @deftypefn {Built-in Function} {} ipermute (@var{a}, @var{iperm})\n\ |
|
|
897 The inverse of the @code{permute} function. The expression\n\ |
|
|
898 \n\ |
|
|
899 @example\n\ |
|
|
900 ipermute (permute (a, perm), perm)\n\ |
|
|
901 @end example\n\ |
|
|
902 returns the original array @var{a}.\n\ |
|
|
903 \n\ |
|
|
904 @end deftypefn\n\ |
|
|
905 @seealso{permute}") |
|
|
906 { |
|
|
907 return do_permute (args, true, "ipermute"); |
|
|
908 } |
|
|
909 |
|
3195
|
910 DEFUN (length, args, , |
|
3373
|
911 "-*- texinfo -*-\n\ |
|
|
912 @deftypefn {Built-in Function} {} length (@var{a})\n\ |
|
4176
|
913 Return the `length' of the object @var{a}. For matrix objects, the\n\ |
|
3373
|
914 length is the number of rows or columns, whichever is greater (this\n\ |
|
|
915 odd definition is used for compatibility with Matlab).\n\ |
|
|
916 @end deftypefn") |
|
3195
|
917 { |
|
|
918 octave_value retval; |
|
|
919 |
|
|
920 if (args.length () == 1) |
|
|
921 { |
|
|
922 int len = args(0).length (); |
|
|
923 |
|
|
924 if (! error_state) |
|
4233
|
925 retval = len; |
|
3195
|
926 } |
|
|
927 else |
|
|
928 print_usage ("length"); |
|
|
929 |
|
|
930 return retval; |
|
|
931 } |
|
|
932 |
|
4554
|
933 DEFUN (ndims, args, , |
|
|
934 "-*- texinfo -*-\n\ |
|
|
935 @deftypefn {Built-in Function} {} ndims (@var{a})\n\ |
|
|
936 Returns the number of dimensions of array @var{a}.\n\ |
|
|
937 For any array, the result will always be larger than or equal to 2.\n\ |
|
|
938 Trailing singleton dimensions are not counted.\n\ |
|
|
939 @end deftypefn") |
|
|
940 { |
|
|
941 octave_value retval; |
|
|
942 |
|
|
943 if (args.length () == 1) |
|
|
944 { |
|
|
945 int n_dims = args(0).ndims (); |
|
|
946 |
|
|
947 if (! error_state) |
|
|
948 retval = n_dims; |
|
|
949 } |
|
|
950 else |
|
|
951 print_usage ("ndims"); |
|
|
952 |
|
|
953 return retval; |
|
|
954 } |
|
|
955 |
|
4559
|
956 DEFUN (numel, args, , |
|
|
957 "-*- texinfo -*-\n\ |
|
|
958 @deftypefn {Built-in Function} {} numel (@var{a})\n\ |
|
|
959 Returns the number of elements in the object @var{a}.\n\ |
|
|
960 @end deftypefn") |
|
|
961 { |
|
|
962 octave_value retval; |
|
|
963 |
|
|
964 if (args.length () == 1) |
|
|
965 { |
|
|
966 int numel = args(0).numel (); |
|
|
967 |
|
|
968 if (! error_state) |
|
|
969 { |
|
|
970 if (numel < 0) |
|
|
971 numel = 0; |
|
|
972 |
|
|
973 retval = numel; |
|
|
974 } |
|
|
975 } |
|
|
976 else |
|
|
977 print_usage ("numel"); |
|
|
978 |
|
|
979 return retval; |
|
|
980 } |
|
|
981 |
|
1957
|
982 DEFUN (size, args, nargout, |
|
3373
|
983 "-*- texinfo -*-\n\ |
|
|
984 @deftypefn {Built-in Function} {} size (@var{a}, @var{n})\n\ |
|
|
985 Return the number rows and columns of @var{a}.\n\ |
|
|
986 \n\ |
|
|
987 With one input argument and one output argument, the result is returned\n\ |
|
4741
|
988 in a row vector. If there are multiple output arguments, the number of\n\ |
|
|
989 rows is assigned to the first, and the number of columns to the second,\n\ |
|
|
990 etc. For example,\n\ |
|
3373
|
991 \n\ |
|
|
992 @example\n\ |
|
|
993 @group\n\ |
|
|
994 size ([1, 2; 3, 4; 5, 6])\n\ |
|
|
995 @result{} [ 3, 2 ]\n\ |
|
1031
|
996 \n\ |
|
3373
|
997 [nr, nc] = size ([1, 2; 3, 4; 5, 6])\n\ |
|
|
998 @result{} nr = 3\n\ |
|
|
999 @result{} nc = 2\n\ |
|
|
1000 @end group\n\ |
|
|
1001 @end example\n\ |
|
|
1002 \n\ |
|
4741
|
1003 If given a second argument, @code{size} will return the size of the\n\ |
|
|
1004 corresponding dimension. For example\n\ |
|
1031
|
1005 \n\ |
|
3373
|
1006 @example\n\ |
|
|
1007 size ([1, 2; 3, 4; 5, 6], 2)\n\ |
|
|
1008 @result{} 2\n\ |
|
|
1009 @end example\n\ |
|
|
1010 \n\ |
|
|
1011 @noindent\n\ |
|
|
1012 returns the number of columns in the given matrix.\n\ |
|
|
1013 @end deftypefn") |
|
523
|
1014 { |
|
2086
|
1015 octave_value_list retval; |
|
523
|
1016 |
|
|
1017 int nargin = args.length (); |
|
|
1018 |
|
4513
|
1019 if (nargin == 1) |
|
523
|
1020 { |
|
4513
|
1021 dim_vector dimensions = args(0).dims (); |
|
|
1022 |
|
|
1023 int ndims = dimensions.length (); |
|
1031
|
1024 |
|
4513
|
1025 Matrix m (1, ndims); |
|
|
1026 |
|
|
1027 if (nargout > 1) |
|
523
|
1028 { |
|
4513
|
1029 while (ndims--) |
|
|
1030 retval(ndims) = dimensions(ndims); |
|
523
|
1031 } |
|
4513
|
1032 else |
|
712
|
1033 { |
|
4513
|
1034 for (int i = 0; i < ndims; i++) |
|
|
1035 m(0, i) = dimensions(i); |
|
|
1036 |
|
|
1037 retval(0) = m; |
|
712
|
1038 } |
|
1031
|
1039 } |
|
|
1040 else if (nargin == 2 && nargout < 2) |
|
|
1041 { |
|
4732
|
1042 int nd = args(1).int_value (true); |
|
1031
|
1043 |
|
|
1044 if (error_state) |
|
|
1045 error ("size: expecting scalar as second argument"); |
|
712
|
1046 else |
|
1031
|
1047 { |
|
4741
|
1048 dim_vector dv = args(0).dims (); |
|
|
1049 |
|
4911
|
1050 if (nd > 0) |
|
|
1051 { |
|
|
1052 if (nd <= dv.length ()) |
|
|
1053 retval(0) = dv(nd-1); |
|
|
1054 else |
|
|
1055 retval(0) = 1; |
|
|
1056 } |
|
1031
|
1057 else |
|
4741
|
1058 error ("size: requested dimension (= %d) out of range", nd); |
|
1031
|
1059 } |
|
523
|
1060 } |
|
712
|
1061 else |
|
|
1062 print_usage ("size"); |
|
523
|
1063 |
|
|
1064 return retval; |
|
|
1065 } |
|
|
1066 |
|
1957
|
1067 DEFUN (sum, args, , |
|
3428
|
1068 "-*- texinfo -*-\n\ |
|
3723
|
1069 @deftypefn {Built-in Function} {} sum (@var{x}, @var{dim})\n\ |
|
|
1070 Sum of elements along dimension @var{dim}. If @var{dim} is\n\ |
|
|
1071 omitted, it defaults to 1 (column-wise sum).\n\ |
|
5061
|
1072 \n\ |
|
|
1073 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\ |
|
|
1074 return the sum of the elements.\n\ |
|
3428
|
1075 @end deftypefn") |
|
523
|
1076 { |
|
3723
|
1077 DATA_REDUCTION (sum); |
|
523
|
1078 } |
|
|
1079 |
|
1957
|
1080 DEFUN (sumsq, args, , |
|
3428
|
1081 "-*- texinfo -*-\n\ |
|
3723
|
1082 @deftypefn {Built-in Function} {} sumsq (@var{x}, @var{dim})\n\ |
|
|
1083 Sum of squares of elements along dimension @var{dim}. If @var{dim}\n\ |
|
|
1084 is omitted, it defaults to 1 (column-wise sum of squares).\n\ |
|
3095
|
1085 \n\ |
|
5061
|
1086 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\ |
|
|
1087 return the sum of squares of the elements.\n\ |
|
|
1088 \n\ |
|
|
1089 This function is conceptually equivalent to computing\n\ |
|
3723
|
1090 @example\n\ |
|
|
1091 sum (x .* conj (x), dim)\n\ |
|
|
1092 @end example\n\ |
|
|
1093 but it uses less memory and avoids calling conj if @var{x} is real.\n\ |
|
3428
|
1094 @end deftypefn") |
|
523
|
1095 { |
|
3723
|
1096 DATA_REDUCTION (sumsq); |
|
523
|
1097 } |
|
|
1098 |
|
4028
|
1099 DEFUN (isbool, args, , |
|
3428
|
1100 "-*- texinfo -*-\n\ |
|
4028
|
1101 @deftypefn {Built-in Functio} {} isbool (@var{x})\n\ |
|
3428
|
1102 Return true if @var{x} is a boolean object.\n\ |
|
3439
|
1103 @end deftypefn") |
|
3209
|
1104 { |
|
|
1105 octave_value retval; |
|
|
1106 |
|
|
1107 if (args.length () == 1) |
|
3258
|
1108 retval = args(0).is_bool_type (); |
|
3209
|
1109 else |
|
4028
|
1110 print_usage ("isbool"); |
|
3209
|
1111 |
|
|
1112 return retval; |
|
|
1113 } |
|
|
1114 |
|
4028
|
1115 DEFALIAS (islogical, isbool); |
|
3209
|
1116 |
|
4028
|
1117 DEFUN (iscomplex, args, , |
|
3428
|
1118 "-*- texinfo -*-\n\ |
|
4028
|
1119 @deftypefn {Built-in Function} {} iscomplex (@var{x})\n\ |
|
3428
|
1120 Return true if @var{x} is a complex-valued numeric object.\n\ |
|
|
1121 @end deftypefn") |
|
3186
|
1122 { |
|
|
1123 octave_value retval; |
|
|
1124 |
|
|
1125 if (args.length () == 1) |
|
3258
|
1126 retval = args(0).is_complex_type (); |
|
3186
|
1127 else |
|
4028
|
1128 print_usage ("iscomplex"); |
|
3186
|
1129 |
|
|
1130 return retval; |
|
|
1131 } |
|
|
1132 |
|
3258
|
1133 DEFUN (isreal, args, , |
|
3428
|
1134 "-*- texinfo -*-\n\ |
|
|
1135 @deftypefn {Built-in Function} {} isreal (@var{x})\n\ |
|
|
1136 Return true if @var{x} is a real-valued numeric object.\n\ |
|
|
1137 @end deftypefn") |
|
3258
|
1138 { |
|
|
1139 octave_value retval; |
|
|
1140 |
|
|
1141 if (args.length () == 1) |
|
|
1142 retval = args(0).is_real_type (); |
|
|
1143 else |
|
|
1144 print_usage ("isreal"); |
|
|
1145 |
|
|
1146 return retval; |
|
|
1147 } |
|
|
1148 |
|
3202
|
1149 DEFUN (isempty, args, , |
|
3373
|
1150 "-*- texinfo -*-\n\ |
|
|
1151 @deftypefn {Built-in Function} {} isempty (@var{a})\n\ |
|
|
1152 Return 1 if @var{a} is an empty matrix (either the number of rows, or\n\ |
|
|
1153 the number of columns, or both are zero). Otherwise, return 0.\n\ |
|
|
1154 @end deftypefn") |
|
3202
|
1155 { |
|
4233
|
1156 octave_value retval = false; |
|
3202
|
1157 |
|
|
1158 if (args.length () == 1) |
|
4559
|
1159 retval = args(0).is_empty (); |
|
3202
|
1160 else |
|
|
1161 print_usage ("isempty"); |
|
|
1162 |
|
|
1163 return retval; |
|
|
1164 } |
|
|
1165 |
|
3206
|
1166 DEFUN (isnumeric, args, , |
|
3428
|
1167 "-*- texinfo -*-\n\ |
|
|
1168 @deftypefn {Built-in Function} {} isnumeric (@var{x})\n\ |
|
|
1169 Return nonzero if @var{x} is a numeric object.\n\ |
|
|
1170 @end deftypefn") |
|
3206
|
1171 { |
|
|
1172 octave_value retval; |
|
|
1173 |
|
|
1174 if (args.length () == 1) |
|
3258
|
1175 retval = args(0).is_numeric_type (); |
|
3206
|
1176 else |
|
3238
|
1177 print_usage ("isnumeric"); |
|
3206
|
1178 |
|
|
1179 return retval; |
|
|
1180 } |
|
|
1181 |
|
4028
|
1182 DEFUN (islist, args, , |
|
3526
|
1183 "-*- texinfo -*-\n\ |
|
4028
|
1184 @deftypefn {Built-in Function} {} islist (@var{x})\n\ |
|
3428
|
1185 Return nonzero if @var{x} is a list.\n\ |
|
|
1186 @end deftypefn") |
|
3204
|
1187 { |
|
|
1188 octave_value retval; |
|
|
1189 |
|
|
1190 if (args.length () == 1) |
|
3258
|
1191 retval = args(0).is_list (); |
|
3204
|
1192 else |
|
4028
|
1193 print_usage ("islist"); |
|
3204
|
1194 |
|
|
1195 return retval; |
|
|
1196 } |
|
|
1197 |
|
4028
|
1198 DEFUN (ismatrix, args, , |
|
3321
|
1199 "-*- texinfo -*-\n\ |
|
4028
|
1200 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\ |
|
3321
|
1201 Return 1 if @var{a} is a matrix. Otherwise, return 0.\n\ |
|
3333
|
1202 @end deftypefn") |
|
3202
|
1203 { |
|
4233
|
1204 octave_value retval = false; |
|
3202
|
1205 |
|
|
1206 if (args.length () == 1) |
|
|
1207 { |
|
|
1208 octave_value arg = args(0); |
|
|
1209 |
|
3212
|
1210 if (arg.is_scalar_type () || arg.is_range ()) |
|
4233
|
1211 retval = true; |
|
3202
|
1212 else if (arg.is_matrix_type ()) |
|
4233
|
1213 retval = (arg.rows () >= 1 && arg.columns () >= 1); |
|
3202
|
1214 } |
|
|
1215 else |
|
4028
|
1216 print_usage ("ismatrix"); |
|
3202
|
1217 |
|
|
1218 return retval; |
|
|
1219 } |
|
|
1220 |
|
3354
|
1221 static octave_value |
|
|
1222 fill_matrix (const octave_value_list& args, double val, const char *fcn) |
|
523
|
1223 { |
|
3354
|
1224 octave_value retval; |
|
523
|
1225 |
|
|
1226 int nargin = args.length (); |
|
|
1227 |
|
4946
|
1228 oct_data_conv::data_type dt = oct_data_conv::dt_double; |
|
4481
|
1229 |
|
4946
|
1230 dim_vector dims (1, 1); |
|
4481
|
1231 |
|
|
1232 if (nargin > 0 && args(nargin-1).is_string ()) |
|
|
1233 { |
|
4946
|
1234 std::string nm = args(nargin-1).string_value (); |
|
4481
|
1235 nargin--; |
|
|
1236 |
|
4946
|
1237 dt = oct_data_conv::string_to_data_type (nm); |
|
|
1238 |
|
|
1239 if (error_state) |
|
|
1240 return retval; |
|
4481
|
1241 } |
|
|
1242 |
|
523
|
1243 switch (nargin) |
|
|
1244 { |
|
712
|
1245 case 0: |
|
|
1246 break; |
|
777
|
1247 |
|
610
|
1248 case 1: |
|
4481
|
1249 get_dimensions (args(0), fcn, dims); |
|
610
|
1250 break; |
|
777
|
1251 |
|
4563
|
1252 default: |
|
|
1253 { |
|
|
1254 dims.resize (nargin); |
|
4481
|
1255 |
|
4563
|
1256 for (int i = 0; i < nargin; i++) |
|
|
1257 { |
|
4732
|
1258 dims(i) = args(i).is_empty () ? 0 : args(i).int_value (); |
|
4481
|
1259 |
|
4563
|
1260 if (error_state) |
|
|
1261 { |
|
4732
|
1262 error ("%s: expecting scalar integer arguments", fcn); |
|
4563
|
1263 break; |
|
|
1264 } |
|
|
1265 } |
|
|
1266 } |
|
|
1267 break; |
|
4481
|
1268 } |
|
|
1269 |
|
|
1270 if (! error_state) |
|
|
1271 { |
|
4946
|
1272 dims.chop_trailing_singletons (); |
|
4565
|
1273 |
|
4481
|
1274 check_dimensions (dims, fcn); |
|
3354
|
1275 |
|
4946
|
1276 // XXX FIXME XXX -- perhaps this should be made extensible by |
|
|
1277 // using the class name to lookup a function to call to create |
|
|
1278 // the new value. |
|
|
1279 |
|
|
1280 // Note that automatic narrowing will handle conversion from |
|
|
1281 // NDArray to scalar. |
|
|
1282 |
|
4481
|
1283 if (! error_state) |
|
|
1284 { |
|
4946
|
1285 switch (dt) |
|
|
1286 { |
|
|
1287 case oct_data_conv::dt_int8: |
|
|
1288 retval = int8NDArray (dims, val); |
|
|
1289 break; |
|
4481
|
1290 |
|
4946
|
1291 case oct_data_conv::dt_uint8: |
|
|
1292 retval = uint8NDArray (dims, val); |
|
|
1293 break; |
|
|
1294 |
|
|
1295 case oct_data_conv::dt_int16: |
|
|
1296 retval = int16NDArray (dims, val); |
|
|
1297 break; |
|
|
1298 |
|
|
1299 case oct_data_conv::dt_uint16: |
|
|
1300 retval = uint16NDArray (dims, val); |
|
|
1301 break; |
|
|
1302 |
|
|
1303 case oct_data_conv::dt_int32: |
|
|
1304 retval = int32NDArray (dims, val); |
|
|
1305 break; |
|
777
|
1306 |
|
4946
|
1307 case oct_data_conv::dt_uint32: |
|
|
1308 retval = uint32NDArray (dims, val); |
|
|
1309 break; |
|
|
1310 |
|
|
1311 case oct_data_conv::dt_int64: |
|
|
1312 retval = int64NDArray (dims, val); |
|
|
1313 break; |
|
4481
|
1314 |
|
4946
|
1315 case oct_data_conv::dt_uint64: |
|
|
1316 retval = uint64NDArray (dims, val); |
|
|
1317 break; |
|
4481
|
1318 |
|
4946
|
1319 case oct_data_conv::dt_single: // XXX FIXME XXX |
|
|
1320 case oct_data_conv::dt_double: |
|
|
1321 retval = NDArray (dims, val); |
|
|
1322 break; |
|
|
1323 |
|
4986
|
1324 case oct_data_conv::dt_logical: |
|
|
1325 retval = boolNDArray (dims, val); |
|
|
1326 break; |
|
|
1327 |
|
4946
|
1328 default: |
|
|
1329 error ("%s: invalid class name", fcn); |
|
|
1330 break; |
|
4481
|
1331 } |
|
|
1332 } |
|
523
|
1333 } |
|
|
1334 |
|
|
1335 return retval; |
|
|
1336 } |
|
|
1337 |
|
3354
|
1338 DEFUN (ones, args, , |
|
3369
|
1339 "-*- texinfo -*-\n\ |
|
|
1340 @deftypefn {Built-in Function} {} ones (@var{x})\n\ |
|
|
1341 @deftypefnx {Built-in Function} {} ones (@var{n}, @var{m})\n\ |
|
4948
|
1342 @deftypefnx {Built-in Function} {} ones (@var{n}, @var{m}, @var{k}, @dots{})\n\ |
|
|
1343 @deftypefnx {Built-in Function} {} ones (@dots{}, @var{class})\n\ |
|
4481
|
1344 Return a matrix or N-dimensional array whose elements are all 1.\n\ |
|
|
1345 The arguments are handled the same as the arguments for @code{eye}.\n\ |
|
3369
|
1346 \n\ |
|
|
1347 If you need to create a matrix whose values are all the same, you should\n\ |
|
|
1348 use an expression like\n\ |
|
|
1349 \n\ |
|
|
1350 @example\n\ |
|
|
1351 val_matrix = val * ones (n, m)\n\ |
|
|
1352 @end example\n\ |
|
4945
|
1353 \n\ |
|
|
1354 The optional argument @var{class}, allows @code{ones} to return an array of\n\ |
|
|
1355 the specified type, like\n\ |
|
|
1356 \n\ |
|
|
1357 @example\n\ |
|
|
1358 val = ones (n,m, \"uint8\")\n\ |
|
|
1359 @end example\n\ |
|
3369
|
1360 @end deftypefn") |
|
523
|
1361 { |
|
3354
|
1362 return fill_matrix (args, 1.0, "ones"); |
|
523
|
1363 } |
|
|
1364 |
|
3354
|
1365 DEFUN (zeros, args, , |
|
3369
|
1366 "-*- texinfo -*-\n\ |
|
|
1367 @deftypefn {Built-in Function} {} zeros (@var{x})\n\ |
|
|
1368 @deftypefnx {Built-in Function} {} zeros (@var{n}, @var{m})\n\ |
|
4948
|
1369 @deftypefnx {Built-in Function} {} zeros (@var{n}, @var{m}, @var{k}, @dots{})\n\ |
|
|
1370 @deftypefnx {Built-in Function} {} zeros (@dots{}, @var{class})\n\ |
|
4481
|
1371 Return a matrix or N-dimensional array whose elements are all 0.\n\ |
|
|
1372 The arguments are handled the same as the arguments for @code{eye}.\n\ |
|
4945
|
1373 \n\ |
|
|
1374 The optional argument @var{class}, allows @code{zeros} to return an array of\n\ |
|
|
1375 the specified type, like\n\ |
|
|
1376 \n\ |
|
|
1377 @example\n\ |
|
|
1378 val = zeros (n,m, \"uint8\")\n\ |
|
|
1379 @end example\n\ |
|
3369
|
1380 @end deftypefn") |
|
523
|
1381 { |
|
3354
|
1382 return fill_matrix (args, 0.0, "zeros"); |
|
|
1383 } |
|
523
|
1384 |
|
4946
|
1385 template <class MT> |
|
|
1386 octave_value |
|
|
1387 identity_matrix (int nr, int nc) |
|
|
1388 { |
|
|
1389 octave_value retval; |
|
|
1390 |
|
|
1391 typename octave_array_type_traits<MT>::element_type one (1); |
|
|
1392 |
|
|
1393 if (nr == 1 && nc == 1) |
|
|
1394 retval = one; |
|
|
1395 else |
|
|
1396 { |
|
|
1397 dim_vector dims (nr, nc); |
|
|
1398 |
|
|
1399 typename octave_array_type_traits<MT>::element_type zero (0); |
|
|
1400 |
|
|
1401 MT m (dims, zero); |
|
|
1402 |
|
|
1403 if (nr > 0 && nc > 0) |
|
|
1404 { |
|
|
1405 int n = std::min (nr, nc); |
|
|
1406 |
|
|
1407 for (int i = 0; i < n; i++) |
|
|
1408 m(i,i) = one; |
|
|
1409 } |
|
|
1410 |
|
|
1411 retval = m; |
|
|
1412 } |
|
|
1413 |
|
|
1414 return retval; |
|
|
1415 } |
|
|
1416 |
|
5058
|
1417 #define INSTANTIATE_EYE(T) \ |
|
|
1418 template octave_value identity_matrix<T> (int, int) |
|
|
1419 |
|
|
1420 INSTANTIATE_EYE (int8NDArray); |
|
|
1421 INSTANTIATE_EYE (uint8NDArray); |
|
|
1422 INSTANTIATE_EYE (int16NDArray); |
|
|
1423 INSTANTIATE_EYE (uint16NDArray); |
|
|
1424 INSTANTIATE_EYE (int32NDArray); |
|
|
1425 INSTANTIATE_EYE (uint32NDArray); |
|
|
1426 INSTANTIATE_EYE (int64NDArray); |
|
|
1427 INSTANTIATE_EYE (uint64NDArray); |
|
|
1428 INSTANTIATE_EYE (NDArray); |
|
|
1429 INSTANTIATE_EYE (boolNDArray); |
|
|
1430 |
|
4945
|
1431 static octave_value |
|
4948
|
1432 identity_matrix (int nr, int nc, oct_data_conv::data_type dt) |
|
4945
|
1433 { |
|
|
1434 octave_value retval; |
|
|
1435 |
|
4946
|
1436 // XXX FIXME XXX -- perhaps this should be made extensible by using |
|
|
1437 // the class name to lookup a function to call to create the new |
|
|
1438 // value. |
|
|
1439 |
|
|
1440 if (! error_state) |
|
|
1441 { |
|
|
1442 switch (dt) |
|
|
1443 { |
|
|
1444 case oct_data_conv::dt_int8: |
|
|
1445 retval = identity_matrix<int8NDArray> (nr, nc); |
|
|
1446 break; |
|
|
1447 |
|
|
1448 case oct_data_conv::dt_uint8: |
|
|
1449 retval = identity_matrix<uint8NDArray> (nr, nc); |
|
|
1450 break; |
|
|
1451 |
|
|
1452 case oct_data_conv::dt_int16: |
|
|
1453 retval = identity_matrix<int16NDArray> (nr, nc); |
|
|
1454 break; |
|
4945
|
1455 |
|
4946
|
1456 case oct_data_conv::dt_uint16: |
|
|
1457 retval = identity_matrix<uint16NDArray> (nr, nc); |
|
|
1458 break; |
|
|
1459 |
|
|
1460 case oct_data_conv::dt_int32: |
|
|
1461 retval = identity_matrix<int32NDArray> (nr, nc); |
|
|
1462 break; |
|
|
1463 |
|
|
1464 case oct_data_conv::dt_uint32: |
|
|
1465 retval = identity_matrix<uint32NDArray> (nr, nc); |
|
|
1466 break; |
|
4945
|
1467 |
|
4946
|
1468 case oct_data_conv::dt_int64: |
|
|
1469 retval = identity_matrix<int64NDArray> (nr, nc); |
|
|
1470 break; |
|
|
1471 |
|
|
1472 case oct_data_conv::dt_uint64: |
|
|
1473 retval = identity_matrix<uint64NDArray> (nr, nc); |
|
|
1474 break; |
|
4945
|
1475 |
|
4946
|
1476 case oct_data_conv::dt_single: // XXX FIXME XXX |
|
|
1477 case oct_data_conv::dt_double: |
|
|
1478 retval = identity_matrix<NDArray> (nr, nc); |
|
|
1479 break; |
|
4945
|
1480 |
|
4986
|
1481 case oct_data_conv::dt_logical: |
|
|
1482 retval = identity_matrix<boolNDArray> (nr, nc); |
|
|
1483 break; |
|
|
1484 |
|
4946
|
1485 default: |
|
|
1486 error ("eye: invalid class name"); |
|
|
1487 break; |
|
4945
|
1488 } |
|
|
1489 } |
|
|
1490 |
|
|
1491 return retval; |
|
|
1492 } |
|
|
1493 |
|
4946
|
1494 #undef INT_EYE_MATRIX |
|
|
1495 |
|
1957
|
1496 DEFUN (eye, args, , |
|
3369
|
1497 "-*- texinfo -*-\n\ |
|
|
1498 @deftypefn {Built-in Function} {} eye (@var{x})\n\ |
|
|
1499 @deftypefnx {Built-in Function} {} eye (@var{n}, @var{m})\n\ |
|
4948
|
1500 @deftypefnx {Built-in Function} {} eye (@dots{}, @var{class})\n\ |
|
3369
|
1501 Return an identity matrix. If invoked with a single scalar argument,\n\ |
|
|
1502 @code{eye} returns a square matrix with the dimension specified. If you\n\ |
|
|
1503 supply two scalar arguments, @code{eye} takes them to be the number of\n\ |
|
|
1504 rows and columns. If given a vector with two elements, @code{eye} uses\n\ |
|
|
1505 the values of the elements as the number of rows and columns,\n\ |
|
|
1506 respectively. For example,\n\ |
|
|
1507 \n\ |
|
|
1508 @example\n\ |
|
|
1509 @group\n\ |
|
|
1510 eye (3)\n\ |
|
|
1511 @result{} 1 0 0\n\ |
|
|
1512 0 1 0\n\ |
|
|
1513 0 0 1\n\ |
|
|
1514 @end group\n\ |
|
|
1515 @end example\n\ |
|
|
1516 \n\ |
|
|
1517 The following expressions all produce the same result:\n\ |
|
|
1518 \n\ |
|
|
1519 @example\n\ |
|
|
1520 @group\n\ |
|
|
1521 eye (2)\n\ |
|
|
1522 @equiv{}\n\ |
|
|
1523 eye (2, 2)\n\ |
|
|
1524 @equiv{}\n\ |
|
|
1525 eye (size ([1, 2; 3, 4])\n\ |
|
|
1526 @end group\n\ |
|
|
1527 @end example\n\ |
|
|
1528 \n\ |
|
4945
|
1529 The optional argument @var{class}, allows @code{eye} to return an array of\n\ |
|
|
1530 the specified type, like\n\ |
|
|
1531 \n\ |
|
|
1532 @example\n\ |
|
|
1533 val = zeros (n,m, \"uint8\")\n\ |
|
|
1534 @end example\n\ |
|
|
1535 \n\ |
|
3369
|
1536 For compatibility with @sc{Matlab}, calling @code{eye} with no arguments\n\ |
|
|
1537 is equivalent to calling it with an argument of 1.\n\ |
|
|
1538 @end deftypefn") |
|
523
|
1539 { |
|
3354
|
1540 octave_value retval; |
|
523
|
1541 |
|
4948
|
1542 int nargin = args.length (); |
|
4945
|
1543 |
|
4948
|
1544 oct_data_conv::data_type dt = oct_data_conv::dt_double; |
|
523
|
1545 |
|
4945
|
1546 // Check for type information. |
|
|
1547 |
|
|
1548 if (nargin > 0 && args(nargin-1).is_string ()) |
|
|
1549 { |
|
4948
|
1550 std::string nm = args(nargin-1).string_value (); |
|
4945
|
1551 nargin--; |
|
4948
|
1552 |
|
|
1553 dt = oct_data_conv::string_to_data_type (nm); |
|
|
1554 |
|
|
1555 if (error_state) |
|
|
1556 return retval; |
|
4945
|
1557 } |
|
|
1558 |
|
523
|
1559 switch (nargin) |
|
|
1560 { |
|
712
|
1561 case 0: |
|
4948
|
1562 retval = identity_matrix (1, 1, dt); |
|
712
|
1563 break; |
|
777
|
1564 |
|
610
|
1565 case 1: |
|
3354
|
1566 { |
|
|
1567 int nr, nc; |
|
|
1568 get_dimensions (args(0), "eye", nr, nc); |
|
|
1569 |
|
|
1570 if (! error_state) |
|
4948
|
1571 retval = identity_matrix (nr, nc, dt); |
|
3354
|
1572 } |
|
610
|
1573 break; |
|
777
|
1574 |
|
523
|
1575 case 2: |
|
3354
|
1576 { |
|
|
1577 int nr, nc; |
|
|
1578 get_dimensions (args(0), args(1), "eye", nr, nc); |
|
|
1579 |
|
|
1580 if (! error_state) |
|
4948
|
1581 retval = identity_matrix (nr, nc, dt); |
|
3354
|
1582 } |
|
523
|
1583 break; |
|
777
|
1584 |
|
523
|
1585 default: |
|
|
1586 print_usage ("eye"); |
|
|
1587 break; |
|
|
1588 } |
|
|
1589 |
|
|
1590 return retval; |
|
|
1591 } |
|
|
1592 |
|
1957
|
1593 DEFUN (linspace, args, , |
|
3369
|
1594 "-*- texinfo -*-\n\ |
|
|
1595 @deftypefn {Built-in Function} {} linspace (@var{base}, @var{limit}, @var{n})\n\ |
|
|
1596 Return a row vector with @var{n} linearly spaced elements between\n\ |
|
|
1597 @var{base} and @var{limit}. The number of elements, @var{n}, must be\n\ |
|
|
1598 greater than 1. The @var{base} and @var{limit} are always included in\n\ |
|
|
1599 the range. If @var{base} is greater than @var{limit}, the elements are\n\ |
|
|
1600 stored in decreasing order. If the number of points is not specified, a\n\ |
|
|
1601 value of 100 is used.\n\ |
|
1100
|
1602 \n\ |
|
4455
|
1603 The @code{linspace} function always returns a row vector.\n\ |
|
3369
|
1604 @end deftypefn") |
|
1100
|
1605 { |
|
3418
|
1606 octave_value retval; |
|
1100
|
1607 |
|
|
1608 int nargin = args.length (); |
|
|
1609 |
|
|
1610 int npoints = 100; |
|
|
1611 |
|
1940
|
1612 if (nargin != 2 && nargin != 3) |
|
|
1613 { |
|
|
1614 print_usage ("linspace"); |
|
|
1615 return retval; |
|
|
1616 } |
|
|
1617 |
|
1100
|
1618 if (nargin == 3) |
|
4732
|
1619 npoints = args(2).int_value (); |
|
1100
|
1620 |
|
|
1621 if (! error_state) |
|
|
1622 { |
|
3322
|
1623 octave_value arg_1 = args(0); |
|
|
1624 octave_value arg_2 = args(1); |
|
1100
|
1625 |
|
3322
|
1626 if (arg_1.is_complex_type () || arg_2.is_complex_type ()) |
|
|
1627 { |
|
|
1628 Complex x1 = arg_1.complex_value (); |
|
|
1629 Complex x2 = arg_2.complex_value (); |
|
|
1630 |
|
|
1631 if (! error_state) |
|
1100
|
1632 { |
|
3322
|
1633 ComplexRowVector rv = linspace (x1, x2, npoints); |
|
1100
|
1634 |
|
|
1635 if (! error_state) |
|
3418
|
1636 retval = rv; |
|
1100
|
1637 } |
|
|
1638 } |
|
|
1639 else |
|
3322
|
1640 { |
|
|
1641 double x1 = arg_1.double_value (); |
|
|
1642 double x2 = arg_2.double_value (); |
|
|
1643 |
|
|
1644 if (! error_state) |
|
|
1645 { |
|
|
1646 RowVector rv = linspace (x1, x2, npoints); |
|
|
1647 |
|
|
1648 if (! error_state) |
|
3418
|
1649 retval = rv; |
|
3322
|
1650 } |
|
|
1651 } |
|
1100
|
1652 } |
|
4732
|
1653 else |
|
|
1654 error ("linspace: expecting third argument to be an integer"); |
|
1100
|
1655 |
|
|
1656 return retval; |
|
|
1657 } |
|
|
1658 |
|
4567
|
1659 DEFUN (reshape, args, , |
|
|
1660 "-*- texinfo -*-\n\ |
|
|
1661 @deftypefn {Function File} {} reshape (@var{a}, @var{m}, @var{n}, @dots{})\n\ |
|
|
1662 @deftypefnx {Function File} {} reshape (@var{a}, @var{siz})\n\ |
|
|
1663 Return a matrix with the given dimensions whose elements are taken\n\ |
|
|
1664 from the matrix @var{a}. The elements of the matrix are access in\n\ |
|
|
1665 column-major order (like Fortran arrays are stored).\n\ |
|
|
1666 \n\ |
|
|
1667 For example,\n\ |
|
|
1668 \n\ |
|
|
1669 @example\n\ |
|
|
1670 @group\n\ |
|
|
1671 reshape ([1, 2, 3, 4], 2, 2)\n\ |
|
|
1672 @result{} 1 3\n\ |
|
|
1673 2 4\n\ |
|
|
1674 @end group\n\ |
|
|
1675 @end example\n\ |
|
|
1676 \n\ |
|
|
1677 @noindent\n\ |
|
|
1678 Note that the total number of elements in the original\n\ |
|
|
1679 matrix must match the total number of elements in the new matrix.\n\ |
|
5013
|
1680 \n\ |
|
|
1681 A single dimension of the return matrix can be unknown and is flagged\n\ |
|
|
1682 by an empty argument.\n\ |
|
4567
|
1683 @end deftypefn") |
|
|
1684 { |
|
|
1685 octave_value retval; |
|
|
1686 |
|
|
1687 int nargin = args.length (); |
|
|
1688 |
|
|
1689 Array<int> new_size; |
|
|
1690 |
|
|
1691 if (nargin == 2) |
|
|
1692 new_size = args(1).int_vector_value (); |
|
|
1693 else if (nargin > 2) |
|
|
1694 { |
|
|
1695 new_size.resize (nargin-1); |
|
5013
|
1696 int empty_dim = -1; |
|
|
1697 |
|
4567
|
1698 for (int i = 1; i < nargin; i++) |
|
|
1699 { |
|
5013
|
1700 if (args(i).is_empty ()) |
|
|
1701 if (empty_dim > 0) |
|
|
1702 { |
|
|
1703 error ("reshape: only a single dimension can be unknown"); |
|
|
1704 break; |
|
|
1705 } |
|
|
1706 else |
|
|
1707 { |
|
|
1708 empty_dim = i; |
|
|
1709 new_size(i-1) = 1; |
|
|
1710 } |
|
|
1711 else |
|
|
1712 { |
|
|
1713 new_size(i-1) = args(i).int_value (); |
|
4567
|
1714 |
|
5013
|
1715 if (error_state) |
|
|
1716 break; |
|
|
1717 } |
|
|
1718 } |
|
|
1719 |
|
|
1720 if (! error_state && (empty_dim > 0)) |
|
|
1721 { |
|
|
1722 int nel = 1; |
|
|
1723 for (int i = 0; i < nargin - 1; i++) |
|
|
1724 nel *= new_size(i); |
|
|
1725 |
|
|
1726 if (nel == 0) |
|
|
1727 new_size(empty_dim-1) = 0; |
|
|
1728 else |
|
|
1729 { |
|
|
1730 int size_empty_dim = args(0).numel () / nel; |
|
|
1731 |
|
|
1732 if (args(0).numel () != size_empty_dim * nel) |
|
|
1733 error ("reshape: size is not divisble by the product of known dimensions (= %d)", nel); |
|
|
1734 else |
|
|
1735 new_size(empty_dim-1) = size_empty_dim; |
|
|
1736 } |
|
4567
|
1737 } |
|
|
1738 } |
|
|
1739 else |
|
|
1740 { |
|
|
1741 print_usage ("reshape"); |
|
|
1742 return retval; |
|
|
1743 } |
|
|
1744 |
|
|
1745 if (error_state) |
|
|
1746 { |
|
|
1747 error ("reshape: invalid arguments"); |
|
|
1748 return retval; |
|
|
1749 } |
|
|
1750 |
|
4739
|
1751 // Remove trailing singletons in new_size, but leave at least 2 |
|
|
1752 // elements. |
|
|
1753 |
|
4567
|
1754 int n = new_size.length (); |
|
|
1755 |
|
4739
|
1756 while (n > 2) |
|
|
1757 { |
|
|
1758 if (new_size(n-1) == 1) |
|
|
1759 n--; |
|
|
1760 else |
|
|
1761 break; |
|
|
1762 } |
|
|
1763 |
|
|
1764 new_size.resize (n); |
|
|
1765 |
|
4567
|
1766 if (n < 2) |
|
|
1767 { |
|
|
1768 error ("reshape: expecting size to be vector with at least 2 elements"); |
|
|
1769 return retval; |
|
|
1770 } |
|
|
1771 |
|
|
1772 dim_vector new_dims; |
|
|
1773 |
|
|
1774 new_dims.resize (n); |
|
|
1775 |
|
|
1776 for (int i = 0; i < n; i++) |
|
|
1777 new_dims(i) = new_size(i); |
|
|
1778 |
|
|
1779 octave_value arg = args(0); |
|
|
1780 |
|
|
1781 if (new_dims.numel () == arg.numel ()) |
|
|
1782 retval = (new_dims == arg.dims ()) ? arg : arg.reshape (new_dims); |
|
|
1783 else |
|
|
1784 error ("reshape: size mismatch"); |
|
|
1785 |
|
|
1786 return retval; |
|
|
1787 } |
|
|
1788 |
|
4532
|
1789 DEFUN (squeeze, args, , |
|
|
1790 "-*- texinfo -*-\n\ |
|
|
1791 @deftypefn {Built-in Function} {} squeeze (@var{x})\n\ |
|
|
1792 Remove singleton dimensions from @var{x} and return the result.\n\ |
|
|
1793 @end deftypefn") |
|
|
1794 { |
|
|
1795 octave_value retval; |
|
|
1796 |
|
|
1797 if (args.length () == 1) |
|
4545
|
1798 retval = args(0).squeeze (); |
|
4532
|
1799 else |
|
|
1800 print_usage ("squeeze"); |
|
|
1801 |
|
|
1802 return retval; |
|
|
1803 } |
|
|
1804 |
|
2184
|
1805 void |
|
|
1806 symbols_of_data (void) |
|
|
1807 { |
|
3321
|
1808 |
|
|
1809 #define IMAGINARY_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1810 @defvr {Built-in Variable} I\n\ |
|
|
1811 @defvrx {Built-in Variable} J\n\ |
|
|
1812 @defvrx {Built-in Variable} i\n\ |
|
|
1813 @defvrx {Built-in Variable} j\n\ |
|
|
1814 A pure imaginary number, defined as\n\ |
|
|
1815 @iftex\n\ |
|
|
1816 @tex\n\ |
|
|
1817 $\\sqrt{-1}$.\n\ |
|
|
1818 @end tex\n\ |
|
|
1819 @end iftex\n\ |
|
|
1820 @ifinfo\n\ |
|
|
1821 @code{sqrt (-1)}.\n\ |
|
|
1822 @end ifinfo\n\ |
|
4845
|
1823 These built-in variables behave like functions so you can use the names\n\ |
|
|
1824 for other purposes. If you use them as variables and assign values to\n\ |
|
|
1825 them and then clear them, they once again assume their special predefined\n\ |
|
|
1826 values @xref{Status of Variables}.\n\ |
|
3321
|
1827 @end defvr" |
|
|
1828 |
|
|
1829 #define INFINITY_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1830 @defvr {Built-in Variable} Inf\n\ |
|
|
1831 @defvrx {Built-in Variable} inf\n\ |
|
|
1832 Infinity. This is the result of an operation like 1/0, or an operation\n\ |
|
|
1833 that results in a floating point overflow.\n\ |
|
|
1834 @end defvr" |
|
|
1835 |
|
|
1836 #define NAN_DOC_STRING "-*- texinfo -*-\n\ |
|
|
1837 @defvr {Built-in Variable} NaN\n\ |
|
|
1838 @defvrx {Built-in Variable} nan\n\ |
|
|
1839 Not a number. This is the result of an operation like\n\ |
|
|
1840 @iftex\n\ |
|
|
1841 @tex\n\ |
|
|
1842 $0/0$, or $\\infty - \\infty$,\n\ |
|
|
1843 @end tex\n\ |
|
|
1844 @end iftex\n\ |
|
|
1845 @ifinfo\n\ |
|
|
1846 0/0, or @samp{Inf - Inf},\n\ |
|
|
1847 @end ifinfo\n\ |
|
|
1848 or any operation with a NaN.\n\ |
|
|
1849 \n\ |
|
|
1850 Note that NaN always compares not equal to NaN. This behavior is\n\ |
|
|
1851 specified by the IEEE standard for floating point arithmetic. To\n\ |
|
|
1852 find NaN values, you must use the @code{isnan} function.\n\ |
|
|
1853 @end defvr" |
|
|
1854 |
|
3141
|
1855 DEFCONST (I, Complex (0.0, 1.0), |
|
3321
|
1856 IMAGINARY_DOC_STRING); |
|
2184
|
1857 |
|
4102
|
1858 DEFCONST (Inf, lo_ieee_inf_value (), |
|
3321
|
1859 INFINITY_DOC_STRING); |
|
2184
|
1860 |
|
3141
|
1861 DEFCONST (J, Complex (0.0, 1.0), |
|
3321
|
1862 IMAGINARY_DOC_STRING); |
|
2184
|
1863 |
|
4102
|
1864 DEFCONST (NA, lo_ieee_na_value (), |
|
4025
|
1865 "-*- texinfo -*-\n\ |
|
|
1866 @defvr {Built-in Variable} NA\n\ |
|
|
1867 Missing value.\n\ |
|
|
1868 @end defvr"); |
|
|
1869 |
|
4102
|
1870 DEFCONST (NaN, lo_ieee_nan_value (), |
|
3321
|
1871 NAN_DOC_STRING); |
|
2184
|
1872 |
|
|
1873 #if defined (M_E) |
|
|
1874 double e_val = M_E; |
|
|
1875 #else |
|
|
1876 double e_val = exp (1.0); |
|
|
1877 #endif |
|
|
1878 |
|
3141
|
1879 DEFCONST (e, e_val, |
|
3321
|
1880 "-*- texinfo -*-\n\ |
|
|
1881 @defvr {Built-in Variable} e\n\ |
|
|
1882 The base of natural logarithms. The constant\n\ |
|
|
1883 @iftex\n\ |
|
|
1884 @tex\n\ |
|
|
1885 $e$\n\ |
|
|
1886 @end tex\n\ |
|
|
1887 @end iftex\n\ |
|
|
1888 @ifinfo\n\ |
|
|
1889 @var{e}\n\ |
|
|
1890 @end ifinfo\n\ |
|
|
1891 satisfies the equation\n\ |
|
|
1892 @iftex\n\ |
|
|
1893 @tex\n\ |
|
|
1894 $\\log (e) = 1$.\n\ |
|
|
1895 @end tex\n\ |
|
|
1896 @end iftex\n\ |
|
|
1897 @ifinfo\n\ |
|
|
1898 @code{log} (@var{e}) = 1.\n\ |
|
|
1899 @end ifinfo\n\ |
|
|
1900 @end defvr"); |
|
2184
|
1901 |
|
3141
|
1902 DEFCONST (eps, DBL_EPSILON, |
|
3321
|
1903 "-*- texinfo -*-\n\ |
|
|
1904 @defvr {Built-in Variable} eps\n\ |
|
|
1905 The machine precision. More precisely, @code{eps} is the largest\n\ |
|
|
1906 relative spacing between any two adjacent numbers in the machine's\n\ |
|
|
1907 floating point system. This number is obviously system-dependent. On\n\ |
|
|
1908 machines that support 64 bit IEEE floating point arithmetic, @code{eps}\n\ |
|
|
1909 is approximately\n\ |
|
|
1910 @ifinfo\n\ |
|
|
1911 2.2204e-16.\n\ |
|
|
1912 @end ifinfo\n\ |
|
|
1913 @iftex\n\ |
|
|
1914 @tex\n\ |
|
|
1915 $2.2204\\times10^{-16}$.\n\ |
|
|
1916 @end tex\n\ |
|
|
1917 @end iftex\n\ |
|
|
1918 @end defvr"); |
|
2184
|
1919 |
|
3258
|
1920 DEFCONST (false, false, |
|
3443
|
1921 "-*- texinfo -*-\n\ |
|
|
1922 @defvr {Built-in Variable} false\n\ |
|
|
1923 Logical false value.\n\ |
|
|
1924 @end defvr"); |
|
3258
|
1925 |
|
3141
|
1926 DEFCONST (i, Complex (0.0, 1.0), |
|
3321
|
1927 IMAGINARY_DOC_STRING); |
|
2184
|
1928 |
|
4102
|
1929 DEFCONST (inf, lo_ieee_inf_value (), |
|
3321
|
1930 INFINITY_DOC_STRING); |
|
2184
|
1931 |
|
3141
|
1932 DEFCONST (j, Complex (0.0, 1.0), |
|
3321
|
1933 IMAGINARY_DOC_STRING); |
|
2184
|
1934 |
|
4102
|
1935 DEFCONST (nan, lo_ieee_nan_value (), |
|
3321
|
1936 NAN_DOC_STRING); |
|
2184
|
1937 |
|
|
1938 #if defined (M_PI) |
|
|
1939 double pi_val = M_PI; |
|
|
1940 #else |
|
|
1941 double pi_val = 4.0 * atan (1.0); |
|
|
1942 #endif |
|
|
1943 |
|
3141
|
1944 DEFCONST (pi, pi_val, |
|
3321
|
1945 "-*- texinfo -*-\n\ |
|
|
1946 @defvr {Built-in Variable} pi\n\ |
|
|
1947 The ratio of the circumference of a circle to its diameter.\n\ |
|
|
1948 Internally, @code{pi} is computed as @samp{4.0 * atan (1.0)}.\n\ |
|
|
1949 @end defvr"); |
|
2184
|
1950 |
|
3141
|
1951 DEFCONST (realmax, DBL_MAX, |
|
3321
|
1952 "-*- texinfo -*-\n\ |
|
|
1953 @defvr {Built-in Variable} realmax\n\ |
|
|
1954 The largest floating point number that is representable. The actual\n\ |
|
4303
|
1955 value is system-dependent. On machines that support 64-bit IEEE\n\ |
|
3321
|
1956 floating point arithmetic, @code{realmax} is approximately\n\ |
|
|
1957 @ifinfo\n\ |
|
|
1958 1.7977e+308\n\ |
|
|
1959 @end ifinfo\n\ |
|
|
1960 @iftex\n\ |
|
|
1961 @tex\n\ |
|
|
1962 $1.7977\\times10^{308}$.\n\ |
|
|
1963 @end tex\n\ |
|
|
1964 @end iftex\n\ |
|
|
1965 @end defvr"); |
|
2184
|
1966 |
|
3141
|
1967 DEFCONST (realmin, DBL_MIN, |
|
3321
|
1968 "-*- texinfo -*-\n\ |
|
|
1969 @defvr {Built-in Variable} realmin\n\ |
|
4303
|
1970 The smallest normalized floating point number that is representable.\n\ |
|
|
1971 The actual value is system-dependent. On machines that support\n\ |
|
|
1972 64-bit IEEE floating point arithmetic, @code{realmin} is approximately\n\ |
|
3321
|
1973 @ifinfo\n\ |
|
|
1974 2.2251e-308\n\ |
|
|
1975 @end ifinfo\n\ |
|
|
1976 @iftex\n\ |
|
|
1977 @tex\n\ |
|
|
1978 $2.2251\\times10^{-308}$.\n\ |
|
|
1979 @end tex\n\ |
|
|
1980 @end iftex\n\ |
|
|
1981 @end defvr"); |
|
2188
|
1982 |
|
3258
|
1983 DEFCONST (true, true, |
|
3443
|
1984 "-*- texinfo -*-\n\ |
|
|
1985 @defvr {Built-in Variable} true\n\ |
|
|
1986 Logical true value.\n\ |
|
|
1987 @end defvr"); |
|
3354
|
1988 |
|
2184
|
1989 } |
|
|
1990 |
|
523
|
1991 /* |
|
|
1992 ;;; Local Variables: *** |
|
|
1993 ;;; mode: C++ *** |
|
|
1994 ;;; End: *** |
|
|
1995 */ |
