GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
op-struct.cc
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1996-2024 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 "errwarn.h"
31 #include "ovl.h"
32 #include "ov.h"
33 #include "ov-re-mat.h"
34 #include "ov-struct.h"
35 #include "ov-typeinfo.h"
36 #include "ops.h"
37 
39 
40 // struct ops.
41 
42 DEFUNOP (transpose, struct)
43 {
45 
46  if (v.ndims () > 2)
47  error ("transpose not defined for N-D objects");
48 
49  return octave_value (v.map_value ().transpose ());
50 }
51 
52 DEFUNOP (scalar_transpose, scalar_struct)
53 {
55 
56  return octave_value (v.scalar_map_value ());
57 }
58 
59 DEFNDCATOP_FN (s_s_concat, struct, struct, map, map, concat)
60 DEFNDCATOP_FN (s_ss_concat, struct, scalar_struct, map, map, concat)
61 DEFNDCATOP_FN (ss_s_concat, scalar_struct, struct, map, map, concat)
62 DEFNDCATOP_FN (ss_ss_concat, scalar_struct, scalar_struct, map, map, concat)
63 
64 static octave_value
65 oct_catop_struct_matrix (const octave_base_value& a1,
66  const octave_base_value& a2,
68 {
69  OCTAVE_CAST_BASE_VALUE (const octave_struct&, v1, a1);
71 
72  NDArray tmp = v2.array_value ();
73  dim_vector dv = tmp.dims ();
74 
75  if (! dv.all_zero ())
76  error ("invalid concatenation of structure with matrix");
77 
78  return octave_value (v1.map_value ());
79 }
80 
81 static octave_value
82 oct_catop_matrix_struct (const octave_base_value& a1,
83  const octave_base_value& a2,
85 {
86  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
88 
89  NDArray tmp = v1.array_value ();
90  dim_vector dv = tmp.dims ();
91 
92  if (! dv.all_zero ())
93  error ("invalid concatenation of structure with matrix");
94 
95  return octave_value (v2.map_value ());
96 }
97 
98 void
99 install_struct_ops (octave::type_info& ti)
100 {
101  INSTALL_UNOP_TI (ti, op_transpose, octave_struct, transpose);
102  INSTALL_UNOP_TI (ti, op_hermitian, octave_struct, transpose);
103 
104  INSTALL_UNOP_TI (ti, op_transpose, octave_scalar_struct, scalar_transpose);
105  INSTALL_UNOP_TI (ti, op_hermitian, octave_scalar_struct, scalar_transpose);
106 
107  INSTALL_CATOP_TI (ti, octave_struct, octave_struct, s_s_concat);
111 
112  INSTALL_CATOP_TI (ti, octave_struct, octave_matrix, struct_matrix);
113  INSTALL_CATOP_TI (ti, octave_matrix, octave_struct, matrix_struct);
114 }
115 
116 OCTAVE_END_NAMESPACE(octave)
ComplexNDArray concat(NDArray &ra, ComplexNDArray &rb, const Array< octave_idx_type > &ra_idx)
Definition: CNDArray.cc:418
const dim_vector & dims() const
Return a const-reference so that dims ()(i) works efficiently.
Definition: Array.h:503
Vector representing the dimensions (size) of an Array.
Definition: dim-vector.h:94
bool all_zero() const
Definition: dim-vector.h:300
virtual octave_map map_value() const
Definition: ov-base.cc:882
NDArray array_value(bool=false) const
Definition: ov-ch-mat.h:120
OCTAVE_BEGIN_NAMESPACE(octave) static octave_value daspk_fcn
void() error(const char *fmt,...)
Definition: error.cc:988
const octave_base_value & a2
return octave_value(v1.char_array_value() . concat(v2.char_array_value(), ra_idx),((a1.is_sq_string()||a2.is_sq_string()) ? '\'' :'"'))
const octave_char_matrix & v2
void install_struct_ops(octave::type_info &ti)
Definition: op-struct.cc:99
#define OCTAVE_CAST_BASE_VALUE(T, T_VAL, BASE_VAL)
Definition: ops.h:52
#define DEFNDCATOP_FN(name, t1, t2, e1, e2, f)
Definition: ops.h:364
#define DEFUNOP(name, t)
Definition: ops.h:194
#define INSTALL_CATOP_TI(ti, t1, t2, f)
Definition: ops.h:75
#define INSTALL_UNOP_TI(ti, op, t, f)
Definition: ops.h:62
octave_value op_transpose(const octave_value &a)
Definition: ov.h:1637
octave_value op_hermitian(const octave_value &a)
Definition: ov.h:1638