1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1998-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 "ovl.h"
31 #include "ov.h"
32 #include "ov-typeinfo.h"
33 #include "ov-re-mat.h"
34 #include "ov-null-mat.h"
35 #include "ops.h"
36 
37 #include "sparse-xpow.h"
38 #include "sparse-xdiv.h"
39 #include "ov-re-sparse.h"
40 
41 // sparse matrix unary ops.
42 
43 DEFUNOP_OP (not, sparse_matrix, !)
44 DEFUNOP_OP (uplus, sparse_matrix, /* no-op */)
45 DEFUNOP_OP (uminus, sparse_matrix, -)
46 
DEFUNOP(transpose,sparse_matrix)47 DEFUNOP (transpose, sparse_matrix)
48 {
49   const octave_sparse_matrix& v = dynamic_cast<const octave_sparse_matrix&> (a);
50   return octave_value (v.sparse_matrix_value ().transpose (),
51                        v.matrix_type ().transpose ());
52 }
53 
54 // sparse matrix by sparse matrix ops.
55 
56 DEFBINOP_OP (add, sparse_matrix, sparse_matrix, +)
57 
58 // DEFBINOP_OP (sub, sparse_matrix, sparse_matrix, -)
59 
60 static octave_value
oct_binop_sub(const octave_base_value & a1,const octave_base_value & a2)61 oct_binop_sub (const octave_base_value& a1, const octave_base_value& a2)
62 {
63   const octave_sparse_matrix& v1
64     = dynamic_cast<const octave_sparse_matrix&> (a1);
65   const octave_sparse_matrix& v2
66     = dynamic_cast<const octave_sparse_matrix&> (a2);
67   SparseMatrix m = v1.sparse_matrix_value () - v2.sparse_matrix_value ();
68 
69   return octave_value (m);
70 }
71 
72 DEFBINOP_OP (mul, sparse_matrix, sparse_matrix, *)
73 
DEFBINOP(div,sparse_matrix,sparse_matrix)74 DEFBINOP (div, sparse_matrix, sparse_matrix)
75 {
76   const octave_sparse_matrix& v1 = dynamic_cast<const octave_sparse_matrix&> (a1);
77   const octave_sparse_matrix& v2 = dynamic_cast<const octave_sparse_matrix&> (a2);
78 
79   if (v2.rows () == 1 && v2.columns () == 1)
80     return octave_value (v1.sparse_matrix_value () / v2.scalar_value ());
81   else
82     {
83       MatrixType typ = v2.matrix_type ();
84       SparseMatrix ret = xdiv (v1.sparse_matrix_value (),
85                                v2.sparse_matrix_value (), typ);
86 
87       v2.matrix_type (typ);
88       return ret;
89     }
90 }
91 
DEFBINOPX(pow,sparse_matrix,sparse_matrix)92 DEFBINOPX (pow, sparse_matrix, sparse_matrix)
93 {
94   error ("can't do A ^ B for A and B both matrices");
95 }
96 
DEFBINOP(ldiv,sparse_matrix,sparse_matrix)97 DEFBINOP (ldiv, sparse_matrix, sparse_matrix)
98 {
99   const octave_sparse_matrix& v1 = dynamic_cast<const octave_sparse_matrix&> (a1);
100   const octave_sparse_matrix& v2 = dynamic_cast<const octave_sparse_matrix&> (a2);
101 
102   if (v1.rows () == 1 && v1.columns () == 1)
103     return octave_value (v2.sparse_matrix_value () / v1.double_value ());
104   else
105     {
106       MatrixType typ = v1.matrix_type ();
107 
108       SparseMatrix ret = xleftdiv (v1.sparse_matrix_value (),
109                                    v2.sparse_matrix_value (), typ);
110 
111       v1.matrix_type (typ);
112       return ret;
113     }
114 }
115 
DEFBINOP_FN(lt,sparse_matrix,sparse_matrix,mx_el_lt)116 DEFBINOP_FN (lt, sparse_matrix, sparse_matrix, mx_el_lt)
117 DEFBINOP_FN (le, sparse_matrix, sparse_matrix, mx_el_le)
118 DEFBINOP_FN (eq, sparse_matrix, sparse_matrix, mx_el_eq)
119 DEFBINOP_FN (ge, sparse_matrix, sparse_matrix, mx_el_ge)
120 DEFBINOP_FN (gt, sparse_matrix, sparse_matrix, mx_el_gt)
121 DEFBINOP_FN (ne, sparse_matrix, sparse_matrix, mx_el_ne)
122 
123 DEFBINOP_FN (el_mul, sparse_matrix, sparse_matrix, product)
124 DEFBINOP_FN (el_div, sparse_matrix, sparse_matrix, quotient)
125 
126 DEFBINOP_FN (el_pow, sparse_matrix, sparse_matrix, elem_xpow)
127 
128 DEFBINOP (el_ldiv, sparse_matrix, sparse_matrix)
129 {
130   const octave_sparse_matrix& v1 = dynamic_cast<const octave_sparse_matrix&> (a1);
131   const octave_sparse_matrix& v2 = dynamic_cast<const octave_sparse_matrix&> (a2);
132   return octave_value
133          (quotient (v2.sparse_matrix_value (), v1.sparse_matrix_value ()));
134 }
135 
DEFBINOP_FN(el_and,sparse_matrix,sparse_matrix,mx_el_and)136 DEFBINOP_FN (el_and, sparse_matrix, sparse_matrix, mx_el_and)
137 DEFBINOP_FN (el_or,  sparse_matrix, sparse_matrix, mx_el_or)
138 
139 DEFCATOP_FN (sm_sm, sparse_matrix, sparse_matrix, concat)
140 
141 DEFASSIGNOP_FN (assign, sparse_matrix, sparse_matrix, assign)
142 
143 DEFNULLASSIGNOP_FN (null_assign, sparse_matrix, delete_elements)
144 
145 void
146 install_sm_sm_ops (octave::type_info& ti)
147 {
148   INSTALL_UNOP_TI (ti, op_not, octave_sparse_matrix, not);
149   INSTALL_UNOP_TI (ti, op_uplus, octave_sparse_matrix, uplus);
150   INSTALL_UNOP_TI (ti, op_uminus, octave_sparse_matrix, uminus);
151   INSTALL_UNOP_TI (ti, op_transpose, octave_sparse_matrix, transpose);
152   INSTALL_UNOP_TI (ti, op_hermitian, octave_sparse_matrix, transpose);
153 
154   INSTALL_BINOP_TI (ti, op_add, octave_sparse_matrix, octave_sparse_matrix, add);
155   INSTALL_BINOP_TI (ti, op_sub, octave_sparse_matrix, octave_sparse_matrix, sub);
156   INSTALL_BINOP_TI (ti, op_mul, octave_sparse_matrix, octave_sparse_matrix, mul);
157   INSTALL_BINOP_TI (ti, op_div, octave_sparse_matrix, octave_sparse_matrix, div);
158   INSTALL_BINOP_TI (ti, op_pow, octave_sparse_matrix, octave_sparse_matrix, pow);
159   INSTALL_BINOP_TI (ti, op_ldiv, octave_sparse_matrix, octave_sparse_matrix,
160                     ldiv);
161   INSTALL_BINOP_TI (ti, op_lt, octave_sparse_matrix, octave_sparse_matrix, lt);
162   INSTALL_BINOP_TI (ti, op_le, octave_sparse_matrix, octave_sparse_matrix, le);
163   INSTALL_BINOP_TI (ti, op_eq, octave_sparse_matrix, octave_sparse_matrix, eq);
164   INSTALL_BINOP_TI (ti, op_ge, octave_sparse_matrix, octave_sparse_matrix, ge);
165   INSTALL_BINOP_TI (ti, op_gt, octave_sparse_matrix, octave_sparse_matrix, gt);
166   INSTALL_BINOP_TI (ti, op_ne, octave_sparse_matrix, octave_sparse_matrix, ne);
167   INSTALL_BINOP_TI (ti, op_el_mul, octave_sparse_matrix, octave_sparse_matrix,
168                     el_mul);
169   INSTALL_BINOP_TI (ti, op_el_div, octave_sparse_matrix, octave_sparse_matrix,
170                     el_div);
171   INSTALL_BINOP_TI (ti, op_el_pow, octave_sparse_matrix, octave_sparse_matrix,
172                     el_pow);
173   INSTALL_BINOP_TI (ti, op_el_ldiv, octave_sparse_matrix, octave_sparse_matrix,
174                     el_ldiv);
175   INSTALL_BINOP_TI (ti, op_el_and, octave_sparse_matrix, octave_sparse_matrix,
176                     el_and);
177   INSTALL_BINOP_TI (ti, op_el_or, octave_sparse_matrix, octave_sparse_matrix,
178                     el_or);
179 
180   INSTALL_CATOP_TI (ti, octave_sparse_matrix, octave_sparse_matrix, sm_sm);
181 
182   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_sparse_matrix, octave_sparse_matrix,
183                        assign);
184 
185   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_sparse_matrix, octave_null_matrix,
186                        null_assign);
187   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_sparse_matrix, octave_null_str,
188                        null_assign);
189   INSTALL_ASSIGNOP_TI (ti, op_asn_eq, octave_sparse_matrix, octave_null_sq_str,
190                        null_assign);
191 }
192