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