1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1996-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 "errwarn.h"
31 #include "ovl.h"
32 #include "ov.h"
33 #include "ov-re-mat.h"
34 #include "ov-flt-re-mat.h"
35 #include "ov-typeinfo.h"
36 #include "ov-null-mat.h"
37 #include "ops.h"
38 #include "xdiv.h"
39 #include "xpow.h"
40 
41 // matrix unary ops.
42 
43 DEFNDUNOP_OP (not, float_matrix, float_array, !)
44 DEFNDUNOP_OP (uplus, float_matrix, float_array, /* no-op */)
45 DEFNDUNOP_OP (uminus, float_matrix, float_array, -)
46 
DEFUNOP(transpose,float_matrix)47 DEFUNOP (transpose, float_matrix)
48 {
49   const octave_float_matrix& v = dynamic_cast<const octave_float_matrix&> (a);
50 
51   if (v.ndims () > 2)
52     error ("transpose not defined for N-D objects");
53 
54   return octave_value (v.float_matrix_value ().transpose ());
55 }
56 
DEFNCUNOP_METHOD(incr,float_matrix,increment)57 DEFNCUNOP_METHOD (incr, float_matrix, increment)
58 DEFNCUNOP_METHOD (decr, float_matrix, decrement)
59 DEFNCUNOP_METHOD (changesign, float_matrix, changesign)
60 
61 // matrix by matrix ops.
62 
63 DEFNDBINOP_OP (add, float_matrix, float_matrix, float_array, float_array, +)
64 DEFNDBINOP_OP (sub, float_matrix, float_matrix, float_array, float_array, -)
65 
66 DEFBINOP_OP (mul, float_matrix, float_matrix, *)
67 
68 DEFBINOP (div, float_matrix, float_matrix)
69 {
70   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
71   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
72   MatrixType typ = v2.matrix_type ();
73 
74   FloatMatrix ret = xdiv (v1.float_matrix_value (),
75                           v2.float_matrix_value (), typ);
76 
77   v2.matrix_type (typ);
78   return ret;
79 }
80 
DEFBINOPX(pow,float_matrix,float_matrix)81 DEFBINOPX (pow, float_matrix, float_matrix)
82 {
83   error ("can't do A ^ B for A and B both matrices");
84 }
85 
DEFBINOP(ldiv,float_matrix,float_matrix)86 DEFBINOP (ldiv, float_matrix, float_matrix)
87 {
88   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
89   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
90   MatrixType typ = v1.matrix_type ();
91 
92   FloatMatrix ret = xleftdiv (v1.float_matrix_value (),
93                               v2.float_matrix_value (), typ);
94 
95   v1.matrix_type (typ);
96   return ret;
97 }
98 
DEFBINOP(trans_mul,float_matrix,float_matrix)99 DEFBINOP (trans_mul, float_matrix, float_matrix)
100 {
101   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
102   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
103   return octave_value(xgemm (v1.float_matrix_value (),
104                              v2.float_matrix_value (),
105                              blas_trans, blas_no_trans));
106 }
107 
DEFBINOP(mul_trans,float_matrix,float_matrix)108 DEFBINOP (mul_trans, float_matrix, float_matrix)
109 {
110   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
111   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
112   return octave_value(xgemm (v1.float_matrix_value (),
113                              v2.float_matrix_value (),
114                              blas_no_trans, blas_trans));
115 }
116 
DEFBINOP(trans_ldiv,float_matrix,float_matrix)117 DEFBINOP (trans_ldiv, float_matrix, float_matrix)
118 {
119   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
120   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
121   MatrixType typ = v1.matrix_type ();
122 
123   FloatMatrix ret = xleftdiv (v1.float_matrix_value (),
124                               v2.float_matrix_value (), typ, blas_trans);
125 
126   v1.matrix_type (typ);
127   return ret;
128 }
129 
DEFNDBINOP_FN(lt,float_matrix,float_matrix,float_array,float_array,mx_el_lt)130 DEFNDBINOP_FN (lt, float_matrix, float_matrix, float_array,
131                float_array, mx_el_lt)
132 DEFNDBINOP_FN (le, float_matrix, float_matrix, float_array,
133                float_array, mx_el_le)
134 DEFNDBINOP_FN (eq, float_matrix, float_matrix, float_array,
135                float_array, mx_el_eq)
136 DEFNDBINOP_FN (ge, float_matrix, float_matrix, float_array,
137                float_array, mx_el_ge)
138 DEFNDBINOP_FN (gt, float_matrix, float_matrix, float_array,
139                float_array, mx_el_gt)
140 DEFNDBINOP_FN (ne, float_matrix, float_matrix, float_array,
141                float_array, mx_el_ne)
142 
143 DEFNDBINOP_FN (el_mul, float_matrix, float_matrix, float_array,
144                float_array, product)
145 DEFNDBINOP_FN (el_div, float_matrix, float_matrix, float_array,
146                float_array, quotient)
147 DEFNDBINOP_FN (el_pow, float_matrix, float_matrix, float_array,
148                float_array, elem_xpow)
149 
150 DEFBINOP (el_ldiv, float_matrix, float_matrix)
151 {
152   const octave_float_matrix& v1 = dynamic_cast<const octave_float_matrix&> (a1);
153   const octave_float_matrix& v2 = dynamic_cast<const octave_float_matrix&> (a2);
154 
155   return octave_value (quotient (v2.float_array_value (),
156                                  v1.float_array_value ()));
157 }
158 
DEFNDBINOP_FN(el_and,float_matrix,float_matrix,float_array,float_array,mx_el_and)159 DEFNDBINOP_FN (el_and, float_matrix, float_matrix, float_array,
160                float_array, mx_el_and)
161 DEFNDBINOP_FN (el_or,  float_matrix, float_matrix, float_array,
162                float_array, mx_el_or)
163 DEFNDBINOP_FN (el_not_and, float_matrix, float_matrix, float_array,
164                float_array, mx_el_not_and)
165 DEFNDBINOP_FN (el_not_or,  float_matrix, float_matrix, float_array,
166                float_array, mx_el_not_or)
167 DEFNDBINOP_FN (el_and_not, float_matrix, float_matrix, float_array,
168                float_array, mx_el_and_not)
169 DEFNDBINOP_FN (el_or_not,  float_matrix, float_matrix, float_array,
170                float_array, mx_el_or_not)
171 
172 DEFNDCATOP_FN (fm_fm, float_matrix, float_matrix, float_array,
173                float_array, concat)
174 
175 DEFNDCATOP_FN (m_fm, matrix, float_matrix, float_array, float_array, concat)
176 
177 DEFNDCATOP_FN (fm_m, float_matrix, matrix, float_array, float_array, concat)
178 
179 DEFNDASSIGNOP_FN (assign, float_matrix, float_matrix, float_array, assign)
180 
181 DEFNDASSIGNOP_FN (dbl_assign, matrix, float_matrix, array, assign)
182 
183 DEFNULLASSIGNOP_FN (null_assign, float_matrix, delete_elements)
184 
185 DEFNDASSIGNOP_OP (assign_add, float_matrix, float_matrix, float_array, +=)
186 DEFNDASSIGNOP_OP (assign_sub, float_matrix, float_matrix, float_array, -=)
187 DEFNDASSIGNOP_FNOP (assign_el_mul, float_matrix, float_matrix, float_array,
188                     product_eq)
189 DEFNDASSIGNOP_FNOP (assign_el_div, float_matrix, float_matrix, float_array,
190                     quotient_eq)
191 
192 void
193 install_fm_fm_ops (octave::type_info& ti)
194 {
195   INSTALL_UNOP_TI (ti, op_not, octave_float_matrix, not);
196   INSTALL_UNOP_TI (ti, op_uplus, octave_float_matrix, uplus);
197   INSTALL_UNOP_TI (ti, op_uminus, octave_float_matrix, uminus);
198   INSTALL_UNOP_TI (ti, op_transpose, octave_float_matrix, transpose);
199   INSTALL_UNOP_TI (ti, op_hermitian, octave_float_matrix, transpose);
200 
201   INSTALL_NCUNOP_TI (ti, op_incr, octave_float_matrix, incr);
202   INSTALL_NCUNOP_TI (ti, op_decr, octave_float_matrix, decr);
203   INSTALL_NCUNOP_TI (ti, op_uminus, octave_float_matrix, changesign);
204 
205   INSTALL_BINOP_TI (ti, op_add, octave_float_matrix, octave_float_matrix, add);
206   INSTALL_BINOP_TI (ti, op_sub, octave_float_matrix, octave_float_matrix, sub);
207   INSTALL_BINOP_TI (ti, op_mul, octave_float_matrix, octave_float_matrix, mul);
208   INSTALL_BINOP_TI (ti, op_div, octave_float_matrix, octave_float_matrix, div);
209   INSTALL_BINOP_TI (ti, op_pow, octave_float_matrix, octave_float_matrix, pow);
210   INSTALL_BINOP_TI (ti, op_ldiv, octave_float_matrix, octave_float_matrix, ldiv);
211   INSTALL_BINOP_TI (ti, op_lt, octave_float_matrix, octave_float_matrix, lt);
212   INSTALL_BINOP_TI (ti, op_le, octave_float_matrix, octave_float_matrix, le);
213   INSTALL_BINOP_TI (ti, op_eq, octave_float_matrix, octave_float_matrix, eq);
214   INSTALL_BINOP_TI (ti, op_ge, octave_float_matrix, octave_float_matrix, ge);
215   INSTALL_BINOP_TI (ti, op_gt, octave_float_matrix, octave_float_matrix, gt);
216   INSTALL_BINOP_TI (ti, op_ne, octave_float_matrix, octave_float_matrix, ne);
217   INSTALL_BINOP_TI (ti, op_el_mul, octave_float_matrix, octave_float_matrix,
218                     el_mul);
219   INSTALL_BINOP_TI (ti, op_el_div, octave_float_matrix, octave_float_matrix,
220                     el_div);
221   INSTALL_BINOP_TI (ti, op_el_pow, octave_float_matrix, octave_float_matrix,
222                     el_pow);
223   INSTALL_BINOP_TI (ti, op_el_ldiv, octave_float_matrix, octave_float_matrix,
224                     el_ldiv);
225   INSTALL_BINOP_TI (ti, op_el_and, octave_float_matrix, octave_float_matrix,
226                     el_and);
227   INSTALL_BINOP_TI (ti, op_el_or, octave_float_matrix, octave_float_matrix,
228                     el_or);
229   INSTALL_BINOP_TI (ti, op_el_and_not, octave_float_matrix, octave_float_matrix,
230                     el_and_not);
231   INSTALL_BINOP_TI (ti, op_el_or_not, octave_float_matrix, octave_float_matrix,
232                     el_or_not);
233   INSTALL_BINOP_TI (ti, op_el_not_and, octave_float_matrix, octave_float_matrix,
234                     el_not_and);
235   INSTALL_BINOP_TI (ti, op_el_not_or, octave_float_matrix, octave_float_matrix,
236                     el_not_or);
237   INSTALL_BINOP_TI (ti, op_trans_mul, octave_float_matrix, octave_float_matrix,
238                     trans_mul);
239   INSTALL_BINOP_TI (ti, op_mul_trans, octave_float_matrix, octave_float_matrix,
240                     mul_trans);
241   INSTALL_BINOP_TI (ti, op_herm_mul, octave_float_matrix, octave_float_matrix,
242                     trans_mul);
243   INSTALL_BINOP_TI (ti, op_mul_herm, octave_float_matrix, octave_float_matrix,
244                     mul_trans);
245   INSTALL_BINOP_TI (ti, op_trans_ldiv, octave_float_matrix, octave_float_matrix,
246                     trans_ldiv);
247   INSTALL_BINOP_TI (ti, op_herm_ldiv, octave_float_matrix, octave_float_matrix,
248                     trans_ldiv);
249 
250   INSTALL_CATOP_TI (ti, octave_float_matrix, octave_float_matrix, fm_fm);
251   INSTALL_CATOP_TI (ti, octave_matrix, octave_float_matrix, m_fm);
252   INSTALL_CATOP_TI (ti, octave_float_matrix, octave_matrix, fm_m);
253 
254   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_float_matrix,
255                        octave_float_matrix, assign);
256   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_matrix,
257                        octave_float_matrix, dbl_assign);
258 
259   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_float_matrix, octave_null_matrix,
260                        null_assign);
261   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_float_matrix, octave_null_str,
262                        null_assign);
263   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_float_matrix, octave_null_sq_str,
264                        null_assign);
265 
266   INSTALL_ASSIGNOP_TI (ti, op_add_eq, octave_float_matrix, octave_float_matrix,
267                        assign_add);
268   INSTALL_ASSIGNOP_TI (ti, op_sub_eq, octave_float_matrix, octave_float_matrix,
269                        assign_sub);
270   INSTALL_ASSIGNOP_TI (ti, op_el_mul_eq, octave_float_matrix, octave_float_matrix,
271                        assign_el_mul);
272   INSTALL_ASSIGNOP_TI (ti, op_el_div_eq, octave_float_matrix, octave_float_matrix,
273                        assign_el_div);
274 }
275