2376
|
1 /* |
|
2 |
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
2376
|
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. |
2376
|
21 |
|
22 */ |
|
23 |
|
24 #ifdef HAVE_CONFIG_H |
|
25 #include <config.h> |
|
26 #endif |
|
27 |
4100
|
28 #include <climits> |
|
29 |
3503
|
30 #include <iostream> |
4726
|
31 #include <vector> |
2901
|
32 |
4944
|
33 #include "data-conv.h" |
2376
|
34 #include "lo-ieee.h" |
|
35 #include "lo-utils.h" |
4944
|
36 #include "mach-info.h" |
2376
|
37 #include "mx-base.h" |
4153
|
38 #include "quit.h" |
2376
|
39 |
4901
|
40 #include "defun.h" |
2376
|
41 #include "gripes.h" |
|
42 #include "oct-obj.h" |
2979
|
43 #include "oct-lvalue.h" |
4944
|
44 #include "oct-stream.h" |
2410
|
45 #include "ops.h" |
3219
|
46 #include "ov-base.h" |
|
47 #include "ov-base-mat.h" |
|
48 #include "ov-base-mat.cc" |
2410
|
49 #include "ov-scalar.h" |
2376
|
50 #include "ov-re-mat.h" |
4901
|
51 #include "ov-type-conv.h" |
2376
|
52 #include "pr-output.h" |
2948
|
53 #include "variables.h" |
2376
|
54 |
4687
|
55 #include "byte-swap.h" |
|
56 #include "ls-oct-ascii.h" |
|
57 #include "ls-utils.h" |
4805
|
58 #include "ls-hdf5.h" |
4687
|
59 |
4100
|
60 #if ! defined (UCHAR_MAX) |
|
61 #define UCHAR_MAX 255 |
|
62 #endif |
|
63 |
4513
|
64 template class octave_base_matrix<NDArray>; |
2376
|
65 |
3219
|
66 DEFINE_OCTAVE_ALLOCATOR (octave_matrix); |
2477
|
67 |
4612
|
68 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_matrix, "matrix", "double"); |
2376
|
69 |
5759
|
70 octave_base_value * |
2410
|
71 octave_matrix::try_narrowing_conversion (void) |
|
72 { |
5759
|
73 octave_base_value *retval = 0; |
2410
|
74 |
4513
|
75 if (matrix.nelem () == 1) |
|
76 retval = new octave_scalar (matrix (0)); |
2410
|
77 |
|
78 return retval; |
|
79 } |
|
80 |
2376
|
81 bool |
|
82 octave_matrix::valid_as_scalar_index (void) const |
|
83 { |
5775
|
84 // FIXME |
2376
|
85 return false; |
|
86 } |
|
87 |
|
88 double |
|
89 octave_matrix::double_value (bool) const |
|
90 { |
4102
|
91 double retval = lo_ieee_nan_value (); |
2376
|
92 |
4645
|
93 if (numel () > 0) |
4455
|
94 { |
5781
|
95 gripe_implicit_conversion ("Octave:array-as-scalar", |
|
96 "real matrix", "real scalar"); |
4455
|
97 |
|
98 retval = matrix (0, 0); |
|
99 } |
2376
|
100 else |
|
101 gripe_invalid_conversion ("real matrix", "real scalar"); |
|
102 |
|
103 return retval; |
|
104 } |
|
105 |
5775
|
106 // FIXME |
4513
|
107 |
|
108 Matrix |
|
109 octave_matrix::matrix_value (bool) const |
|
110 { |
|
111 return matrix.matrix_value (); |
|
112 } |
|
113 |
2376
|
114 Complex |
|
115 octave_matrix::complex_value (bool) const |
|
116 { |
4102
|
117 double tmp = lo_ieee_nan_value (); |
|
118 |
|
119 Complex retval (tmp, tmp); |
2376
|
120 |
4455
|
121 if (rows () > 0 && columns () > 0) |
|
122 { |
5781
|
123 gripe_implicit_conversion ("Octave:array-as-scalar", |
|
124 "real matrix", "complex scalar"); |
4455
|
125 |
|
126 retval = matrix (0, 0); |
|
127 } |
2376
|
128 else |
|
129 gripe_invalid_conversion ("real matrix", "complex scalar"); |
|
130 |
|
131 return retval; |
|
132 } |
|
133 |
5775
|
134 // FIXME |
4513
|
135 |
|
136 ComplexMatrix |
|
137 octave_matrix::complex_matrix_value (bool) const |
|
138 { |
|
139 return ComplexMatrix (matrix.matrix_value ()); |
|
140 } |
|
141 |
4699
|
142 ComplexNDArray |
|
143 octave_matrix::complex_array_value (bool) const |
|
144 { |
|
145 return ComplexNDArray (matrix); |
|
146 } |
|
147 |
5898
|
148 boolNDArray |
5943
|
149 octave_matrix::bool_array_value (bool warn) const |
5898
|
150 { |
5943
|
151 if (warn && matrix.any_element_not_one_or_zero ()) |
|
152 gripe_logical_conversion (); |
|
153 |
5898
|
154 return boolNDArray (matrix); |
|
155 } |
|
156 |
4758
|
157 charNDArray |
|
158 octave_matrix::char_array_value (bool) const |
|
159 { |
|
160 charNDArray retval (dims ()); |
|
161 |
5275
|
162 octave_idx_type nel = numel (); |
4758
|
163 |
5275
|
164 for (octave_idx_type i = 0; i < nel; i++) |
4758
|
165 retval.elem (i) = static_cast<char>(matrix.elem (i)); |
|
166 |
|
167 return retval; |
|
168 } |
|
169 |
5164
|
170 SparseMatrix |
|
171 octave_matrix::sparse_matrix_value (bool) const |
|
172 { |
|
173 return SparseMatrix (matrix.matrix_value ()); |
|
174 } |
|
175 |
|
176 SparseComplexMatrix |
|
177 octave_matrix::sparse_complex_matrix_value (bool) const |
|
178 { |
5775
|
179 // FIXME Need a SparseComplexMatrix (Matrix) constructor to make |
5164
|
180 // this function more efficient. Then this should become |
|
181 // return SparseComplexMatrix (matrix.matrix_value ()); |
|
182 return SparseComplexMatrix (sparse_matrix_value ()); |
|
183 } |
|
184 |
4645
|
185 streamoff_array |
|
186 octave_matrix::streamoff_array_value (void) const |
|
187 { |
|
188 streamoff_array retval (dims ()); |
|
189 |
5275
|
190 octave_idx_type nel = numel (); |
4645
|
191 |
5275
|
192 for (octave_idx_type i = 0; i < nel; i++) |
4645
|
193 { |
|
194 double d = matrix(i); |
|
195 |
|
196 if (D_NINT (d) == d) |
|
197 retval(i) = std::streamoff (static_cast<long> (d)); |
|
198 else |
|
199 { |
|
200 error ("conversion to streamoff_array value failed"); |
|
201 break; |
|
202 } |
|
203 } |
|
204 |
|
205 return retval; |
|
206 } |
|
207 |
2376
|
208 octave_value |
5279
|
209 octave_matrix::convert_to_str_internal (bool, bool, char type) const |
2376
|
210 { |
|
211 octave_value retval; |
4844
|
212 dim_vector dv = dims (); |
5862
|
213 octave_idx_type nel = dv.numel (); |
|
214 |
|
215 charNDArray chm (dv); |
2376
|
216 |
5862
|
217 bool warned = false; |
|
218 |
|
219 for (octave_idx_type i = 0; i < nel; i++) |
2376
|
220 { |
5862
|
221 OCTAVE_QUIT; |
|
222 |
|
223 double d = matrix (i); |
4844
|
224 |
5862
|
225 if (xisnan (d)) |
|
226 { |
|
227 ::error ("invalid conversion from NaN to character"); |
|
228 return retval; |
|
229 } |
|
230 else |
4844
|
231 { |
5862
|
232 int ival = NINT (d); |
4844
|
233 |
5862
|
234 if (ival < 0 || ival > UCHAR_MAX) |
|
235 { |
|
236 // FIXME -- is there something |
|
237 // better we could do? |
2376
|
238 |
5862
|
239 ival = 0; |
|
240 |
|
241 if (! warned) |
|
242 { |
|
243 ::warning ("range error for conversion to character value"); |
|
244 warned = true; |
|
245 } |
4844
|
246 } |
2376
|
247 |
5862
|
248 chm (i) = static_cast<char> (ival); |
|
249 } |
|
250 } |
2376
|
251 |
5862
|
252 retval = octave_value (chm, true, type); |
2376
|
253 |
|
254 return retval; |
|
255 } |
|
256 |
4687
|
257 bool |
6974
|
258 octave_matrix::save_ascii (std::ostream& os) |
4687
|
259 { |
|
260 dim_vector d = dims (); |
5958
|
261 |
4687
|
262 if (d.length () > 2) |
|
263 { |
|
264 NDArray tmp = array_value (); |
|
265 |
|
266 os << "# ndims: " << d.length () << "\n"; |
|
267 |
|
268 for (int i=0; i < d.length (); i++) |
|
269 os << " " << d (i); |
|
270 |
|
271 os << "\n" << tmp; |
|
272 } |
|
273 else |
|
274 { |
|
275 // Keep this case, rather than use generic code above for backward |
|
276 // compatiability. Makes load_ascii much more complex!! |
|
277 os << "# rows: " << rows () << "\n" |
|
278 << "# columns: " << columns () << "\n"; |
|
279 |
5958
|
280 os << matrix_value (); |
4687
|
281 } |
|
282 |
|
283 return true; |
|
284 } |
|
285 |
|
286 bool |
|
287 octave_matrix::load_ascii (std::istream& is) |
|
288 { |
|
289 bool success = true; |
5099
|
290 |
|
291 string_vector keywords(2); |
|
292 |
|
293 keywords[0] = "ndims"; |
|
294 keywords[1] = "rows"; |
4687
|
295 |
5099
|
296 std::string kw; |
5275
|
297 octave_idx_type val = 0; |
5099
|
298 |
|
299 if (extract_keyword (is, keywords, kw, val, true)) |
4687
|
300 { |
5099
|
301 if (kw == "ndims") |
4687
|
302 { |
5275
|
303 int mdims = static_cast<int> (val); |
4687
|
304 |
5099
|
305 if (mdims >= 0) |
4687
|
306 { |
5099
|
307 dim_vector dv; |
|
308 dv.resize (mdims); |
4687
|
309 |
5099
|
310 for (int i = 0; i < mdims; i++) |
|
311 is >> dv(i); |
4687
|
312 |
6717
|
313 if (is) |
|
314 { |
|
315 NDArray tmp(dv); |
|
316 |
|
317 if (tmp.is_empty ()) |
|
318 matrix = tmp; |
|
319 else |
|
320 { |
|
321 is >> tmp; |
5099
|
322 |
6717
|
323 if (is) |
|
324 matrix = tmp; |
|
325 else |
|
326 { |
|
327 error ("load: failed to load matrix constant"); |
|
328 success = false; |
|
329 } |
|
330 } |
|
331 } |
|
332 else |
4687
|
333 { |
6717
|
334 error ("load: failed to read dimensions"); |
4687
|
335 success = false; |
|
336 } |
|
337 } |
|
338 else |
5099
|
339 { |
6717
|
340 error ("load: failed to extract number of dimensions"); |
5099
|
341 success = false; |
|
342 } |
4687
|
343 } |
5099
|
344 else if (kw == "rows") |
4687
|
345 { |
5275
|
346 octave_idx_type nr = val; |
|
347 octave_idx_type nc = 0; |
5099
|
348 |
|
349 if (nr >= 0 && extract_keyword (is, "columns", nc) && nc >= 0) |
|
350 { |
|
351 if (nr > 0 && nc > 0) |
|
352 { |
|
353 Matrix tmp (nr, nc); |
|
354 is >> tmp; |
|
355 if (is) |
|
356 matrix = tmp; |
|
357 else |
|
358 { |
|
359 error ("load: failed to load matrix constant"); |
|
360 success = false; |
|
361 } |
|
362 } |
|
363 else if (nr == 0 || nc == 0) |
|
364 matrix = Matrix (nr, nc); |
|
365 else |
|
366 panic_impossible (); |
|
367 } |
|
368 else |
|
369 { |
|
370 error ("load: failed to extract number of rows and columns"); |
|
371 success = false; |
|
372 } |
4687
|
373 } |
5099
|
374 else |
|
375 panic_impossible (); |
|
376 } |
|
377 else |
|
378 { |
|
379 error ("load: failed to extract number of rows and columns"); |
|
380 success = false; |
4687
|
381 } |
|
382 |
|
383 return success; |
|
384 } |
|
385 |
|
386 bool |
|
387 octave_matrix::save_binary (std::ostream& os, bool& save_as_floats) |
|
388 { |
|
389 |
|
390 dim_vector d = dims (); |
|
391 if (d.length() < 1) |
|
392 return false; |
|
393 |
|
394 // Use negative value for ndims to differentiate with old format!! |
5828
|
395 int32_t tmp = - d.length(); |
5760
|
396 os.write (reinterpret_cast<char *> (&tmp), 4); |
5275
|
397 for (int i = 0; i < d.length (); i++) |
4687
|
398 { |
|
399 tmp = d(i); |
5760
|
400 os.write (reinterpret_cast<char *> (&tmp), 4); |
4687
|
401 } |
|
402 |
|
403 NDArray m = array_value (); |
|
404 save_type st = LS_DOUBLE; |
|
405 if (save_as_floats) |
|
406 { |
|
407 if (m.too_large_for_float ()) |
|
408 { |
|
409 warning ("save: some values too large to save as floats --"); |
|
410 warning ("save: saving as doubles instead"); |
|
411 } |
|
412 else |
|
413 st = LS_FLOAT; |
|
414 } |
5775
|
415 else if (d.numel () > 8192) // FIXME -- make this configurable. |
4687
|
416 { |
|
417 double max_val, min_val; |
|
418 if (m.all_integers (max_val, min_val)) |
|
419 st = get_save_type (max_val, min_val); |
|
420 } |
|
421 |
|
422 const double *mtmp = m.data (); |
|
423 write_doubles (os, mtmp, st, d.numel ()); |
|
424 |
|
425 return true; |
|
426 } |
|
427 |
|
428 bool |
|
429 octave_matrix::load_binary (std::istream& is, bool swap, |
|
430 oct_mach_info::float_format fmt) |
|
431 { |
|
432 char tmp; |
5828
|
433 int32_t mdims; |
5760
|
434 if (! is.read (reinterpret_cast<char *> (&mdims), 4)) |
4687
|
435 return false; |
|
436 if (swap) |
4944
|
437 swap_bytes<4> (&mdims); |
4687
|
438 if (mdims < 0) |
|
439 { |
|
440 mdims = - mdims; |
5828
|
441 int32_t di; |
4687
|
442 dim_vector dv; |
|
443 dv.resize (mdims); |
|
444 |
|
445 for (int i = 0; i < mdims; i++) |
|
446 { |
5760
|
447 if (! is.read (reinterpret_cast<char *> (&di), 4)) |
4687
|
448 return false; |
|
449 if (swap) |
4944
|
450 swap_bytes<4> (&di); |
4687
|
451 dv(i) = di; |
|
452 } |
|
453 |
5157
|
454 // Convert an array with a single dimension to be a row vector. |
|
455 // Octave should never write files like this, other software |
|
456 // might. |
|
457 |
|
458 if (mdims == 1) |
|
459 { |
|
460 mdims = 2; |
|
461 dv.resize (mdims); |
|
462 dv(1) = dv(0); |
|
463 dv(0) = 1; |
|
464 } |
|
465 |
5760
|
466 if (! is.read (reinterpret_cast<char *> (&tmp), 1)) |
4687
|
467 return false; |
|
468 |
|
469 NDArray m(dv); |
|
470 double *re = m.fortran_vec (); |
5760
|
471 read_doubles (is, re, static_cast<save_type> (tmp), dv.numel (), swap, fmt); |
4687
|
472 if (error_state || ! is) |
|
473 return false; |
|
474 matrix = m; |
|
475 } |
|
476 else |
|
477 { |
5828
|
478 int32_t nr, nc; |
4687
|
479 nr = mdims; |
5760
|
480 if (! is.read (reinterpret_cast<char *> (&nc), 4)) |
4687
|
481 return false; |
|
482 if (swap) |
4944
|
483 swap_bytes<4> (&nc); |
5760
|
484 if (! is.read (reinterpret_cast<char *> (&tmp), 1)) |
4687
|
485 return false; |
|
486 Matrix m (nr, nc); |
|
487 double *re = m.fortran_vec (); |
5275
|
488 octave_idx_type len = nr * nc; |
5760
|
489 read_doubles (is, re, static_cast<save_type> (tmp), len, swap, fmt); |
4687
|
490 if (error_state || ! is) |
|
491 return false; |
|
492 matrix = m; |
|
493 } |
|
494 return true; |
|
495 } |
|
496 |
|
497 #if defined (HAVE_HDF5) |
4944
|
498 |
4687
|
499 bool |
|
500 octave_matrix::save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats) |
|
501 { |
4837
|
502 dim_vector dv = dims (); |
|
503 int empty = save_hdf5_empty (loc_id, name, dv); |
|
504 if (empty) |
4805
|
505 return (empty > 0); |
|
506 |
4837
|
507 int rank = dv.length (); |
4687
|
508 hid_t space_hid = -1, data_hid = -1; |
|
509 bool retval = true; |
|
510 NDArray m = array_value (); |
|
511 |
4805
|
512 OCTAVE_LOCAL_BUFFER (hsize_t, hdims, rank); |
|
513 |
4687
|
514 // Octave uses column-major, while HDF5 uses row-major ordering |
4805
|
515 for (int i = 0; i < rank; i++) |
4837
|
516 hdims[i] = dv (rank-i-1); |
4805
|
517 |
4815
|
518 space_hid = H5Screate_simple (rank, hdims, 0); |
4687
|
519 |
|
520 if (space_hid < 0) return false; |
|
521 |
|
522 hid_t save_type_hid = H5T_NATIVE_DOUBLE; |
|
523 |
|
524 if (save_as_floats) |
|
525 { |
|
526 if (m.too_large_for_float ()) |
|
527 { |
|
528 warning ("save: some values too large to save as floats --"); |
|
529 warning ("save: saving as doubles instead"); |
|
530 } |
|
531 else |
|
532 save_type_hid = H5T_NATIVE_FLOAT; |
|
533 } |
|
534 #if HAVE_HDF5_INT2FLOAT_CONVERSIONS |
|
535 // hdf5 currently doesn't support float/integer conversions |
|
536 else |
|
537 { |
|
538 double max_val, min_val; |
|
539 |
|
540 if (m.all_integers (max_val, min_val)) |
|
541 save_type_hid |
|
542 = save_type_to_hdf5 (get_save_type (max_val, min_val)); |
|
543 } |
|
544 #endif /* HAVE_HDF5_INT2FLOAT_CONVERSIONS */ |
|
545 |
|
546 data_hid = H5Dcreate (loc_id, name, save_type_hid, space_hid, |
|
547 H5P_DEFAULT); |
|
548 if (data_hid < 0) |
|
549 { |
|
550 H5Sclose (space_hid); |
|
551 return false; |
|
552 } |
|
553 |
|
554 double *mtmp = m.fortran_vec (); |
|
555 retval = H5Dwrite (data_hid, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
4815
|
556 H5P_DEFAULT, mtmp) >= 0; |
4687
|
557 |
|
558 H5Dclose (data_hid); |
|
559 H5Sclose (space_hid); |
4837
|
560 |
4687
|
561 return retval; |
|
562 } |
|
563 |
|
564 bool |
|
565 octave_matrix::load_hdf5 (hid_t loc_id, const char *name, |
|
566 bool /* have_h5giterate_bug */) |
|
567 { |
4837
|
568 bool retval = false; |
|
569 |
4805
|
570 dim_vector dv; |
|
571 int empty = load_hdf5_empty (loc_id, name, dv); |
|
572 if (empty > 0) |
|
573 matrix.resize(dv); |
4837
|
574 if (empty) |
4805
|
575 return (empty > 0); |
|
576 |
4687
|
577 hid_t data_hid = H5Dopen (loc_id, name); |
|
578 hid_t space_id = H5Dget_space (data_hid); |
|
579 |
|
580 hsize_t rank = H5Sget_simple_extent_ndims (space_id); |
|
581 |
|
582 if (rank < 1) |
|
583 { |
|
584 H5Sclose (space_id); |
|
585 H5Dclose (data_hid); |
|
586 return false; |
|
587 } |
|
588 |
|
589 OCTAVE_LOCAL_BUFFER (hsize_t, hdims, rank); |
|
590 OCTAVE_LOCAL_BUFFER (hsize_t, maxdims, rank); |
|
591 |
|
592 H5Sget_simple_extent_dims (space_id, hdims, maxdims); |
|
593 |
|
594 // Octave uses column-major, while HDF5 uses row-major ordering |
|
595 if (rank == 1) |
|
596 { |
|
597 dv.resize (2); |
|
598 dv(0) = 1; |
|
599 dv(1) = hdims[0]; |
|
600 } |
|
601 else |
|
602 { |
|
603 dv.resize (rank); |
4815
|
604 for (hsize_t i = 0, j = rank - 1; i < rank; i++, j--) |
4687
|
605 dv(j) = hdims[i]; |
|
606 } |
|
607 |
|
608 NDArray m (dv); |
|
609 double *re = m.fortran_vec (); |
|
610 if (H5Dread (data_hid, H5T_NATIVE_DOUBLE, H5S_ALL, H5S_ALL, |
4815
|
611 H5P_DEFAULT, re) >= 0) |
4687
|
612 { |
|
613 retval = true; |
|
614 matrix = m; |
|
615 } |
|
616 |
|
617 H5Sclose (space_id); |
|
618 H5Dclose (data_hid); |
4837
|
619 |
4687
|
620 return retval; |
|
621 } |
4944
|
622 |
4687
|
623 #endif |
|
624 |
4643
|
625 void |
|
626 octave_matrix::print_raw (std::ostream& os, |
|
627 bool pr_as_read_syntax) const |
|
628 { |
|
629 octave_print_internal (os, matrix, pr_as_read_syntax, |
|
630 current_print_indent_level ()); |
|
631 } |
|
632 |
5900
|
633 mxArray * |
|
634 octave_matrix::as_mxArray (void) const |
|
635 { |
|
636 mxArray *retval = new mxArray (mxDOUBLE_CLASS, dims (), mxREAL); |
|
637 |
|
638 double *pr = static_cast<double *> (retval->get_data ()); |
|
639 |
6686
|
640 mwSize nel = numel (); |
5900
|
641 |
|
642 const double *p = matrix.data (); |
|
643 |
6686
|
644 for (mwIndex i = 0; i < nel; i++) |
5900
|
645 pr[i] = p[i]; |
|
646 |
|
647 return retval; |
|
648 } |
|
649 |
4901
|
650 DEFUN (double, args, , |
|
651 "-*- texinfo -*-\n\ |
|
652 @deftypefn {Built-in Function} {} double (@var{x})\n\ |
|
653 Convert @var{x} to double precision type.\n\ |
|
654 @end deftypefn") |
|
655 { |
|
656 OCTAVE_TYPE_CONV_BODY3 (double, octave_matrix, octave_scalar); |
|
657 } |
|
658 |
2376
|
659 /* |
|
660 ;;; Local Variables: *** |
|
661 ;;; mode: C++ *** |
|
662 ;;; End: *** |
|
663 */ |