GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
op-m-cm.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 "mx-m-cm.h"
31 #include "mx-cm-m.h"
32 #include "mx-nda-cnda.h"
33 #include "mx-cnda-nda.h"
34 
35 #include "errwarn.h"
36 #include "ovl.h"
37 #include "ov.h"
38 #include "ov-re-mat.h"
39 #include "ov-flt-re-mat.h"
40 #include "ov-cx-mat.h"
41 #include "ov-flt-cx-mat.h"
42 #include "ov-typeinfo.h"
43 #include "ops.h"
44 #include "xdiv.h"
45 #include "xpow.h"
46 
48 
49 // matrix by complex matrix ops.
50 
51 DEFNDBINOP_OP (add, matrix, complex_matrix, array, complex_array, +)
52 DEFNDBINOP_OP (sub, matrix, complex_matrix, array, complex_array, -)
53 
54 DEFBINOP_OP (mul, matrix, complex_matrix, *)
55 
56 DEFBINOP (trans_mul, matrix, complex_matrix)
57 {
58  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
60 
61  Matrix m1 = v1.matrix_value ();
63 
64  return ComplexMatrix (xgemm (m1, real (m2), blas_trans, blas_no_trans),
65  xgemm (m1, imag (m2), blas_trans, blas_no_trans));
66 }
67 
68 DEFBINOP (div, matrix, complex_matrix)
69 {
70  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
72  MatrixType typ = v2.matrix_type ();
73 
74  ComplexMatrix ret = xdiv (v1.matrix_value (),
75  v2.complex_matrix_value (), typ);
76 
77  v2.matrix_type (typ);
78  return ret;
79 }
80 
81 DEFBINOPX (pow, matrix, complex_matrix)
82 {
83  error ("can't do A ^ B for A and B both matrices");
84 }
85 
86 DEFBINOP (ldiv, matrix, complex_matrix)
87 {
88  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
90  MatrixType typ = v1.matrix_type ();
91 
92  ComplexMatrix ret = xleftdiv (v1.matrix_value (),
93  v2.complex_matrix_value (), typ);
94 
95  v1.matrix_type (typ);
96  return ret;
97 }
98 
99 DEFBINOP (trans_ldiv, matrix, complex_matrix)
100 {
101  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
103  MatrixType typ = v1.matrix_type ();
104 
105  ComplexMatrix ret = xleftdiv (v1.matrix_value (),
107 
108  v1.matrix_type (typ);
109  return ret;
110 }
111 
112 DEFNDCMPLXCMPOP_FN (lt, matrix, complex_matrix, array, complex_array, mx_el_lt)
113 DEFNDCMPLXCMPOP_FN (le, matrix, complex_matrix, array, complex_array, mx_el_le)
114 DEFNDCMPLXCMPOP_FN (eq, matrix, complex_matrix, array, complex_array, mx_el_eq)
115 DEFNDCMPLXCMPOP_FN (ge, matrix, complex_matrix, array, complex_array, mx_el_ge)
116 DEFNDCMPLXCMPOP_FN (gt, matrix, complex_matrix, array, complex_array, mx_el_gt)
117 DEFNDCMPLXCMPOP_FN (ne, matrix, complex_matrix, array, complex_array, mx_el_ne)
118 
119 DEFNDBINOP_FN (el_mul, matrix, complex_matrix, array, complex_array, product)
120 DEFNDBINOP_FN (el_div, matrix, complex_matrix, array, complex_array, quotient)
121 DEFNDBINOP_FN (el_pow, matrix, complex_matrix, array, complex_array, elem_xpow)
122 
123 DEFBINOP (el_ldiv, matrix, complex_matrix)
124 {
125  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v1, a1);
127 
128  return quotient (v2.complex_array_value (), v1.array_value ());
129 }
130 
131 DEFNDBINOP_FN (el_and, matrix, complex_matrix, array, complex_array, mx_el_and)
132 DEFNDBINOP_FN (el_or, matrix, complex_matrix, array, complex_array, mx_el_or)
133 
134 DEFNDCATOP_FN (m_cm, matrix, complex_matrix, array, complex_array, concat)
135 
136 DEFCONV (complex_matrix_conv, matrix, complex_matrix)
137 {
138  OCTAVE_CAST_BASE_VALUE (const octave_matrix&, v, a);
139 
140  return new octave_complex_matrix (ComplexNDArray (v.array_value ()));
141 }
142 
143 void
144 install_m_cm_ops (octave::type_info& ti)
145 {
162  el_ldiv);
166  trans_mul);
168  trans_mul);
170  trans_ldiv);
172  trans_ldiv);
173 
175 
180 
182  complex_matrix_conv);
183 }
184 
185 OCTAVE_END_NAMESPACE(octave)
ComplexColumnVector quotient(const ComplexColumnVector &x, const ComplexColumnVector &y)
Definition: CColVector.h:158
ComplexColumnVector product(const ComplexColumnVector &x, const ComplexColumnVector &y)
Definition: CColVector.h:158
ComplexMatrix xgemm(const ComplexMatrix &a, const ComplexMatrix &b, blas_trans_type transa, blas_trans_type transb)
Definition: CMatrix.cc:3346
ComplexNDArray concat(NDArray &ra, ComplexNDArray &rb, const Array< octave_idx_type > &ra_idx)
Definition: CNDArray.cc:418
ComplexMatrix trans_mul(const SparseComplexMatrix &m, const ComplexMatrix &a)
Definition: CSparse.cc:7546
boolMatrix mx_el_le(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
boolMatrix mx_el_ne(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
boolMatrix mx_el_or(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:88
boolMatrix mx_el_and(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:88
boolMatrix mx_el_gt(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
boolMatrix mx_el_eq(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
boolMatrix mx_el_lt(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
boolMatrix mx_el_ge(const boolMatrix &m1, const boolMatrix &m2)
Definition: boolMatrix.cc:91
Definition: dMatrix.h:42
MatrixType matrix_type() const
Definition: ov-base-mat.h:139
ComplexMatrix complex_matrix_value(bool=false) const
Definition: ov-ch-mat.h:130
ComplexNDArray complex_array_value(bool=false) const
Definition: ov-ch-mat.h:136
ColumnVector real(const ComplexColumnVector &a)
Definition: dColVector.cc:137
ColumnVector imag(const ComplexColumnVector &a)
Definition: dColVector.cc:143
OCTAVE_BEGIN_NAMESPACE(octave) static octave_value daspk_fcn
void() error(const char *fmt,...)
Definition: error.cc:988
@ blas_no_trans
Definition: mx-defs.h:81
@ blas_trans
Definition: mx-defs.h:82
octave_int< T > pow(const octave_int< T > &a, const octave_int< T > &b)
const octave_base_value & a2
const octave_char_matrix & v2
void install_m_cm_ops(octave::type_info &ti)
Definition: op-m-cm.cc:144
#define DEFNDBINOP_OP(name, t1, t2, e1, e2, op)
Definition: ops.h:291
#define DEFNDBINOP_FN(name, t1, t2, e1, e2, f)
Definition: ops.h:316
#define DEFNDCMPLXCMPOP_FN(name, t1, t2, e1, e2, f)
Definition: ops.h:327
#define DEFBINOPX(name, t1, t2)
Definition: ops.h:240
#define DEFCONV(name, a_dummy, b_dummy)
Definition: ops.h:187
#define DEFBINOP(name, t1, t2)
Definition: ops.h:245
#define DEFBINOP_OP(name, t1, t2, op)
Definition: ops.h:250
#define INSTALL_ASSIGNCONV_TI(ti, t1, t2, tr)
Definition: ops.h:88
#define OCTAVE_CAST_BASE_VALUE(T, T_VAL, BASE_VAL)
Definition: ops.h:52
#define INSTALL_BINOP_TI(ti, op, t1, t2, f)
Definition: ops.h:70
#define DEFNDCATOP_FN(name, t1, t2, e1, e2, f)
Definition: ops.h:364
#define INSTALL_WIDENOP_TI(ti, t1, t2, f)
Definition: ops.h:92
#define INSTALL_CATOP_TI(ti, t1, t2, f)
Definition: ops.h:75
octave_value op_ne(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1676
octave_value op_el_ldiv(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1681
octave_value op_add(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1663
octave_value op_gt(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1675
octave_value op_el_div(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1679
octave_value op_el_or(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1683
octave_value op_sub(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1664
octave_value op_mul(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1665
octave_value op_le(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1672
octave_value op_el_and(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1682
octave_value op_herm_mul(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1696
octave_value op_eq(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1673
octave_value op_el_pow(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1680
octave_value op_ldiv(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1669
octave_value op_pow(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1668
octave_value op_ge(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1674
octave_value op_el_mul(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1678
octave_value op_div(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1666
octave_value op_trans_mul(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1694
octave_value op_lt(const octave_value &a1, const octave_value &a2)
Definition: ov.h:1671
Matrix xdiv(const Matrix &a, const SparseMatrix &b, MatrixType &typ)
Definition: sparse-xdiv.cc:137
Matrix xleftdiv(const SparseMatrix &a, const Matrix &b, MatrixType &typ)
Definition: sparse-xdiv.cc:469
octave_value elem_xpow(double a, const SparseMatrix &b)
Definition: sparse-xpow.cc:347