GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
ov-perm.cc
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 2008-2021 The Octave Project Developers
4 //
5 // See the file COPYRIGHT.md in the top-level directory of this
6 // distribution or <https://octave.org/copyright/>.
7 //
8 // This file is part of Octave.
9 //
10 // Octave is free software: you can redistribute it and/or modify it
11 // under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // Octave is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with Octave; see the file COPYING. If not, see
22 // <https://www.gnu.org/licenses/>.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 #if defined (HAVE_CONFIG_H)
27 # include "config.h"
28 #endif
29 
30 #include "byte-swap.h"
31 #include "dim-vector.h"
32 
33 #include "mxarray.h"
34 #include "ov-perm.h"
35 #include "ov-re-mat.h"
36 #include "ov-scalar.h"
37 #include "error.h"
38 #include "errwarn.h"
39 #include "ops.h"
40 #include "pr-output.h"
41 
42 #include "ls-oct-text.h"
43 
45 octave_perm_matrix::subsref (const std::string& type,
46  const std::list<octave_value_list>& idx)
47 {
49 
50  switch (type[0])
51  {
52  case '(':
53  retval = do_index_op (idx.front ());
54  break;
55 
56  case '{':
57  case '.':
58  {
59  std::string nm = type_name ();
60  error ("%s cannot be indexed with %c", nm.c_str (), type[0]);
61  }
62  break;
63 
64  default:
66  }
67 
68  return retval.next_subsref (type, idx);
69 }
70 
73  bool resize_ok)
74 {
76  octave_idx_type nidx = idx.length ();
77  idx_vector idx0, idx1;
78  if (nidx == 2)
79  {
80  int k = 0; // index we're processing when index_vector throws
81  try
82  {
83  idx0 = idx(0).index_vector ();
84  k = 1;
85  idx1 = idx(1).index_vector ();
86  }
87  catch (octave::index_exception& e)
88  {
89  // Rethrow to allow more info to be reported later.
90  e.set_pos_if_unset (2, k+1);
91  throw;
92  }
93  }
94 
95  // This hack is to allow constructing permutation matrices using
96  // eye(n)(p,:), eye(n)(:,q) && eye(n)(p,q) where p & q are permutation
97  // vectors.
98  // Note that, for better consistency, eye(n)(:,:) still converts to a full
99  // matrix.
100  if (nidx == 2)
101  {
102  bool left = idx0.is_permutation (matrix.rows ());
103  bool right = idx1.is_permutation (matrix.cols ());
104 
105  if (left && right)
106  {
107  if (idx0.is_colon ()) left = false;
108  if (idx1.is_colon ()) right = false;
109  if (left || right)
110  {
111  PermMatrix p = matrix;
112  if (left)
113  p = PermMatrix (idx0, false) * p;
114  if (right)
115  p = p * PermMatrix (idx1, true);
116  retval = p;
117  }
118  else
119  {
120  retval = this;
121  this->count++;
122  }
123  }
124  }
125 
126  if (! retval.is_defined ())
127  {
128  if (nidx == 2 && ! resize_ok && idx0.is_scalar () && idx1.is_scalar ())
129  retval = matrix.checkelem (idx0(0), idx1(0));
130  else
131  retval = to_dense ().do_index_op (idx, resize_ok);
132  }
133 
134  return retval;
135 }
136 
137 // Return true if this matrix has all true elements (non-zero, not NaN/NA).
138 // A permutation cannot have NaN/NA.
139 bool
141 {
142  if (dims ().numel () > 1)
143  {
145  return false; // > 1x1 permutation always has zeros, and no NaN.
146  }
147  else
148  return dims ().numel (); // 1x1 is [1] == true, 0x0 == false.
149 }
150 
151 double
153 {
154  if (isempty ())
155  err_invalid_conversion (type_name (), "real scalar");
156 
157  warn_implicit_conversion ("Octave:array-to-scalar",
158  type_name (), "real scalar");
159 
160  return matrix(0, 0);
161 }
162 
163 float
165 {
166  if (isempty ())
167  err_invalid_conversion (type_name (), "real scalar");
168 
169  warn_implicit_conversion ("Octave:array-to-scalar",
170  type_name (), "real scalar");
171 
172  return matrix(0, 0);
173 }
174 
175 Complex
177 {
178  if (rows () == 0 || columns () == 0)
179  err_invalid_conversion (type_name (), "complex scalar");
180 
181  warn_implicit_conversion ("Octave:array-to-scalar",
182  type_name (), "complex scalar");
183 
184  return Complex (matrix(0, 0), 0);
185 }
186 
189 {
190  float tmp = lo_ieee_float_nan_value ();
191 
192  FloatComplex retval (tmp, tmp);
193 
194  if (rows () == 0 || columns () == 0)
195  err_invalid_conversion (type_name (), "complex scalar");
196 
197  warn_implicit_conversion ("Octave:array-to-scalar",
198  type_name (), "complex scalar");
199 
200  retval = matrix(0, 0);
201 
202  return retval;
203 }
204 
205 #define FORWARD_MATRIX_VALUE(TYPE, PREFIX) \
206  TYPE \
207  octave_perm_matrix::PREFIX ## _value (bool frc_str_conv) const \
208  { \
209  return to_dense ().PREFIX ## _value (frc_str_conv); \
210  }
211 
214 {
215  return SparseMatrix (matrix);
216 }
217 
220 {
221  return SparseBoolMatrix (matrix);
222 }
223 
226 {
228 }
229 
234 
239 
242 
244 octave_perm_matrix::index_vector (bool require_integers) const
245 {
246  return to_dense ().index_vector (require_integers);
247 }
248 
251  char type) const
252 {
253  return to_dense ().convert_to_str_internal (pad, force, type);
254 }
255 
258 {
259  return matrix;
260 }
261 
264 {
265  return float_array_value ();
266 }
267 
270 {
271  return int8_array_value ();
272 }
273 
276 {
277  return int16_array_value ();
278 }
279 
282 {
283  return int32_array_value ();
284 }
285 
288 {
289  return int64_array_value ();
290 }
291 
294 {
295  return uint8_array_value ();
296 }
297 
300 {
301  return uint16_array_value ();
302 }
303 
306 {
307  return uint32_array_value ();
308 }
309 
312 {
313  return uint64_array_value ();
314 }
315 
318 {
319  return float_display_format (float_format (1, 0, 0));
320 }
321 
322 std::string
324  octave_idx_type i,
325  octave_idx_type j) const
326 {
327  std::ostringstream buf;
329  return buf.str ();
330 }
331 
332 bool
334 {
335  os << "# size: " << matrix.rows () << "\n";
336  os << "# orient: c\n";
337 
339  octave_idx_type n = pvec.numel ();
340  ColumnVector tmp (n);
341  for (octave_idx_type i = 0; i < n; i++) tmp(i) = pvec(i) + 1;
342  os << tmp;
343 
344  return true;
345 }
346 
347 bool
349 {
351  char orient;
352 
353  if (! extract_keyword (is, "size", n, true)
354  || ! extract_keyword (is, "orient", orient, true))
355  error ("load: failed to extract size & orientation");
356 
357  bool colp = orient == 'c';
358  ColumnVector tmp (n);
359  is >> tmp;
360  if (! is)
361  error ("load: failed to load permutation matrix constant");
362 
363  Array<octave_idx_type> pvec (dim_vector (n, 1));
364  for (octave_idx_type i = 0; i < n; i++) pvec(i) = tmp(i) - 1;
365  matrix = PermMatrix (pvec, colp);
366 
367  // Invalidate cache. Probably not necessary, but safe.
369 
370  return true;
371 }
372 
373 bool
374 octave_perm_matrix::save_binary (std::ostream& os, bool)
375 {
376 
377  int32_t sz = matrix.rows ();
378  bool colp = true;
379  os.write (reinterpret_cast<char *> (&sz), 4);
380  os.write (reinterpret_cast<char *> (&colp), 1);
381  const Array<octave_idx_type>& col_perm = matrix.col_perm_vec ();
382  os.write (reinterpret_cast<const char *> (col_perm.data ()),
383  col_perm.byte_size ());
384 
385  return true;
386 }
387 
388 bool
389 octave_perm_matrix::load_binary (std::istream& is, bool swap,
391 {
392  int32_t sz;
393  bool colp;
394  if (! (is.read (reinterpret_cast<char *> (&sz), 4)
395  && is.read (reinterpret_cast<char *> (&colp), 1)))
396  return false;
397 
399 
400  if (! is.read (reinterpret_cast<char *> (m.fortran_vec ()), m.byte_size ()))
401  return false;
402 
403  if (swap)
404  {
405  int nel = m.numel ();
406  for (int i = 0; i < nel; i++)
407  switch (sizeof (octave_idx_type))
408  {
409  case 8:
410  swap_bytes<8> (&m(i));
411  break;
412  case 4:
413  swap_bytes<4> (&m(i));
414  break;
415  case 2:
416  swap_bytes<2> (&m(i));
417  break;
418  case 1:
419  default:
420  break;
421  }
422  }
423 
424  matrix = PermMatrix (m, colp);
425  return true;
426 }
427 
428 void
430  bool pr_as_read_syntax) const
431 {
432  return octave_print_internal (os, matrix, pr_as_read_syntax,
434 }
435 
436 mxArray *
438 {
439  return to_dense ().as_mxArray ();
440 }
441 
442 bool
444 {
445  dim_vector dv = dims ();
446 
447  return (dv.all_ones () || dv.any_zero ());
448 }
449 
450 void
451 octave_perm_matrix::print (std::ostream& os, bool pr_as_read_syntax)
452 {
453  print_raw (os, pr_as_read_syntax);
454  newline (os);
455 }
456 
457 int
459  oct_data_conv::data_type output_type, int skip,
460  octave::mach_info::float_format flt_fmt) const
461 {
462  return to_dense ().write (os, block_size, output_type, skip, flt_fmt);
463 }
464 
465 void
467  const std::string& prefix) const
468 {
469  matrix.print_info (os, prefix);
470 }
471 
474 {
475  if (! dense_cache.is_defined ())
477 
478  return dense_cache;
479 }
480 
482  "permutation matrix", "double");
483 
484 static octave_base_value *
486 {
487  const octave_perm_matrix& v = dynamic_cast<const octave_perm_matrix&> (a);
488 
489  return new octave_matrix (v.matrix_value ());
490 }
491 
494 {
497 }
498 
499 // FIXME: This is duplicated from octave_base_matrix<T>. Could
500 // octave_perm_matrix be derived from octave_base_matrix<T>?
501 
502 void
503 octave_perm_matrix::short_disp (std::ostream& os) const
504 {
505  if (matrix.isempty ())
506  os << "[]";
507  else if (matrix.ndims () == 2)
508  {
509  // FIXME: should this be configurable?
510  octave_idx_type max_elts = 10;
511  octave_idx_type elts = 0;
512 
513  octave_idx_type nel = matrix.numel ();
514 
515  octave_idx_type nr = matrix.rows ();
517 
518  os << '[';
519 
520  for (octave_idx_type i = 0; i < nr; i++)
521  {
522  for (octave_idx_type j = 0; j < nc; j++)
523  {
524  std::ostringstream buf;
526  octave_print_internal (buf, tval);
527  std::string tmp = buf.str ();
528  size_t pos = tmp.find_first_not_of (' ');
529  if (pos != std::string::npos)
530  os << tmp.substr (pos);
531  else if (! tmp.empty ())
532  os << tmp[0];
533 
534  if (++elts >= max_elts)
535  goto done;
536 
537  if (j < nc - 1)
538  os << ", ";
539  }
540 
541  if (i < nr - 1 && elts < max_elts)
542  os << "; ";
543  }
544 
545  done:
546 
547  if (nel <= max_elts)
548  os << ']';
549  }
550  else
551  os << "...";
552 }
553 
556 {
557  octave_base_value *retval = nullptr;
558 
559  if (matrix.numel () == 1)
560  retval = new octave_scalar (matrix (0, 0));
561 
562  return retval;
563 }
564 
567 {
568  if (n < matrix.numel ())
569  {
570  octave_idx_type nr = matrix.rows ();
571 
572  octave_idx_type r = n % nr;
573  octave_idx_type c = n / nr;
574 
575  return octave_value (matrix.elem (r, c));
576  }
577  else
578  return octave_value ();
579 }
void swap_bytes< 2 >(void *ptr)
Definition: byte-swap.h:56
void swap_bytes< 8 >(void *ptr)
Definition: byte-swap.h:71
void swap_bytes< 4 >(void *ptr)
Definition: byte-swap.h:63
octave_idx_type numel(void) const
Number of elements in the array.
Definition: Array.h:377
size_t byte_size(void) const
Size of the specified dimension.
Definition: Array.h:449
const T * data(void) const
Size of the specified dimension.
Definition: Array.h:581
Definition: dMatrix.h:42
const Array< octave_idx_type > & col_perm_vec(void) const
Definition: PermMatrix.h:81
octave_idx_type cols(void) const
Definition: PermMatrix.h:61
octave_idx_type columns(void) const
Definition: PermMatrix.h:62
octave_idx_type elem(octave_idx_type i, octave_idx_type j) const
Definition: PermMatrix.h:85
void print_info(std::ostream &os, const std::string &prefix) const
Definition: PermMatrix.h:112
octave_idx_type rows(void) const
Definition: PermMatrix.h:60
octave_idx_type checkelem(octave_idx_type i, octave_idx_type j) const
Definition: PermMatrix.cc:91
octave_idx_type numel(void) const
Definition: PermMatrix.h:70
bool isempty(void) const
Definition: PermMatrix.h:77
int ndims(void) const
Definition: PermMatrix.h:79
Vector representing the dimensions (size) of an Array.
Definition: dim-vector.h:95
octave_idx_type numel(int n=0) const
Number of elements that a matrix with this dimensions would have.
Definition: dim-vector.h:401
bool all_ones(void) const
Definition: dim-vector.h:390
bool any_zero(void) const
Definition: dim-vector.h:382
bool is_colon(void) const
Definition: idx-vector.h:576
bool is_scalar(void) const
Definition: idx-vector.h:579
bool is_permutation(octave_idx_type n) const
Definition: idx-vector.cc:1141
void set_pos_if_unset(octave_idx_type nd_arg, octave_idx_type dim_arg)
octave_idx_type columns(void) const
Definition: ov-base.h:325
octave::refcount< octave_idx_type > count
Definition: ov-base.h:860
int current_print_indent_level(void) const
Definition: ov-base.h:847
void newline(std::ostream &os) const
Definition: ov-base.cc:1321
virtual octave_idx_type numel(void) const
Definition: ov-base.h:335
octave_idx_type rows(void) const
Definition: ov-base.h:318
friend class octave_value
Definition: ov-base.h:228
bool isempty(void) const
Definition: ov-base.h:357
static int static_type_id(void)
Definition: ov-re-mat.h:250
virtual octave_value subsref(const std::string &type, const std::list< octave_value_list > &idx)
Definition: ov-base.cc:201
octave_value convert_to_str_internal(bool pad, bool force, char type) const
Definition: ov-perm.cc:250
void print_raw(std::ostream &os, bool pr_as_read_syntax=false) const
Definition: ov-perm.cc:429
std::string edit_display(const float_display_format &fmt, octave_idx_type i, octave_idx_type j) const
Definition: ov-perm.cc:323
octave_base_value * try_narrowing_conversion(void)
Definition: ov-perm.cc:555
octave_value as_int16(void) const
Definition: ov-perm.cc:275
octave_value as_int8(void) const
Definition: ov-perm.cc:269
mxArray * as_mxArray(void) const
Definition: ov-perm.cc:437
octave_value as_int64(void) const
Definition: ov-perm.cc:287
int8NDArray int8_array_value(void) const
Definition: ov-perm.h:185
SparseMatrix sparse_matrix_value(bool=false) const
Definition: ov-perm.cc:213
virtual octave_value to_dense(void) const
Definition: ov-perm.cc:473
octave_value as_uint32(void) const
Definition: ov-perm.cc:305
dim_vector dims(void) const
Definition: ov-perm.h:77
void print(std::ostream &os, bool pr_as_read_syntax=false)
Definition: ov-perm.cc:451
int64NDArray int64_array_value(void) const
Definition: ov-perm.h:194
void print_info(std::ostream &os, const std::string &prefix) const
Definition: ov-perm.cc:466
bool save_binary(std::ostream &os, bool save_as_floats)
Definition: ov-perm.cc:374
double double_value(bool=false) const
Definition: ov-perm.cc:152
int16NDArray int16_array_value(void) const
Definition: ov-perm.h:188
octave_value as_uint64(void) const
Definition: ov-perm.cc:311
octave_value as_double(void) const
Definition: ov-perm.cc:257
FloatNDArray float_array_value(bool=false) const
Definition: ov-perm.cc:236
idx_vector index_vector(bool require_integers=false) const
Definition: ov-perm.cc:244
int32NDArray int32_array_value(void) const
Definition: ov-perm.h:191
octave_value as_single(void) const
Definition: ov-perm.cc:263
float_display_format get_edit_display_format(void) const
Definition: ov-perm.cc:317
SparseBoolMatrix sparse_bool_matrix_value(bool=false) const
Definition: ov-perm.cc:219
bool load_ascii(std::istream &is)
Definition: ov-perm.cc:348
uint8NDArray uint8_array_value(void) const
Definition: ov-perm.h:197
std::string type_name(void) const
Definition: ov-perm.h:268
bool print_as_scalar(void) const
Definition: ov-perm.cc:443
type_conv_info numeric_conversion_function(void) const
Definition: ov-perm.cc:493
float float_value(bool=false) const
Definition: ov-perm.cc:164
FloatComplex float_complex_value(bool=false) const
Definition: ov-perm.cc:188
Complex complex_value(bool=false) const
Definition: ov-perm.cc:176
octave_value fast_elem_extract(octave_idx_type n) const
Definition: ov-perm.cc:566
bool is_true(void) const
Definition: ov-perm.cc:140
SparseComplexMatrix sparse_complex_matrix_value(bool=false) const
Definition: ov-perm.cc:225
octave_value do_index_op(const octave_value_list &idx, bool resize_ok=false)
Definition: ov-perm.cc:72
int write(octave::stream &os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const
Definition: ov-perm.cc:458
bool save_ascii(std::ostream &os)
Definition: ov-perm.cc:333
uint64NDArray uint64_array_value(void) const
Definition: ov-perm.h:206
Matrix matrix_value(bool=false) const
Definition: ov-perm.cc:230
uint32NDArray uint32_array_value(void) const
Definition: ov-perm.h:203
octave_value as_uint8(void) const
Definition: ov-perm.cc:293
octave_value as_uint16(void) const
Definition: ov-perm.cc:299
octave_value dense_cache
Definition: ov-perm.h:264
bool load_binary(std::istream &is, bool swap, octave::mach_info::float_format fmt)
Definition: ov-perm.cc:389
octave_value as_int32(void) const
Definition: ov-perm.cc:281
PermMatrix matrix
Definition: ov-perm.h:260
uint16NDArray uint16_array_value(void) const
Definition: ov-perm.h:200
void short_disp(std::ostream &os) const
Definition: ov-perm.cc:503
octave_idx_type length(void) const
Definition: ovl.h:113
octave_value convert_to_str_internal(bool pad, bool force, char type) const
Definition: ov.h:1221
mxArray * as_mxArray(void) const
Definition: ov.h:1331
octave_value do_index_op(const octave_value_list &idx, bool resize_ok=false)
Definition: ov.h:475
bool is_defined(void) const
Definition: ov.h:551
int write(octave::stream &os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const
void error(const char *fmt,...)
Definition: error.cc:968
#define panic_impossible()
Definition: error.h:380
void warn_array_as_logical(const dim_vector &dv)
Definition: errwarn.cc:286
void err_invalid_conversion(const std::string &from, const std::string &to)
Definition: errwarn.cc:71
void warn_implicit_conversion(const char *id, const char *from, const char *to)
Definition: errwarn.cc:344
float lo_ieee_float_nan_value(void)
Definition: lo-ieee.cc:126
std::string extract_keyword(std::istream &is, const char *keyword, const bool next_only)
Definition: ls-oct-text.cc:84
T octave_idx_type m
Definition: mx-inlines.cc:773
octave_idx_type n
Definition: mx-inlines.cc:753
T * r
Definition: mx-inlines.cc:773
static int left
Definition: randmtzig.cc:191
std::complex< double > Complex
Definition: oct-cmplx.h:33
std::complex< float > FloatComplex
Definition: oct-cmplx.h:34
#define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c)
Definition: ov-base.h:180
static octave_base_value * default_numeric_conversion_function(const octave_base_value &a)
Definition: ov-perm.cc:485
#define FORWARD_MATRIX_VALUE(TYPE, PREFIX)
Definition: ov-perm.cc:205
octave_value::octave_value(const Array< char > &chm, char type) return retval
Definition: ov.cc:811
void octave_print_internal(std::ostream &os, const float_display_format &fmt, bool d, bool pr_as_read_syntax)
Definition: pr-output.cc:1762