GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
sparse-xpow.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1998-2023 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 (octave_sparse_xpow_h)
27 #define octave_sparse_xpow_h 1
28 
29 #include "octave-config.h"
30 
31 #include "oct-cmplx.h"
32 
33 class SparseMatrix;
35 class octave_value;
36 
38 
39 extern octave_value xpow (const SparseMatrix& a, double b);
40 extern octave_value xpow (const SparseComplexMatrix& a, double b);
41 
42 extern octave_value elem_xpow (double a, const SparseMatrix& b);
43 extern octave_value elem_xpow (double a, const SparseComplexMatrix& b);
44 
45 extern octave_value elem_xpow (const SparseMatrix& a, double b);
46 extern octave_value elem_xpow (const SparseMatrix& a, const SparseMatrix& b);
47 extern octave_value elem_xpow (const SparseMatrix& a, const Complex& b);
48 extern octave_value elem_xpow (const SparseMatrix& a,
49  const SparseComplexMatrix& b);
50 
51 extern octave_value elem_xpow (const Complex& a, const SparseMatrix& b);
52 extern octave_value elem_xpow (const Complex& a,
53  const SparseComplexMatrix& b);
54 
55 extern octave_value elem_xpow (const SparseComplexMatrix& a, double b);
57  const SparseMatrix& b);
59  const Complex& b);
61  const SparseComplexMatrix& b);
62 
64 
65 #if (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS)
66 
67 OCTAVE_DEPRECATED (7, "use 'octave::xpow' instead")
68 inline octave_value
69 xpow (const SparseMatrix& a, double b)
70 {
71  return octave::xpow (a, b);
72 }
73 
74 OCTAVE_DEPRECATED (7, "use 'octave::xpow' instead")
75 inline octave_value
76 xpow (const SparseComplexMatrix& a, double b)
77 {
78  return octave::xpow (a, b);
79 }
80 
81 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
82 inline octave_value
83 elem_xpow (double a, const SparseMatrix& b)
84 {
85  return octave::elem_xpow (a, b);
86 }
87 
88 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
89 inline octave_value
90 elem_xpow (double a, const SparseComplexMatrix& b)
91 {
92  return octave::elem_xpow (a, b);
93 }
94 
95 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
96 inline octave_value
97 elem_xpow (const SparseMatrix& a, double b)
98 {
99  return octave::elem_xpow (a, b);
100 }
101 
102 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
103 inline octave_value
104 elem_xpow (const SparseMatrix& a, const SparseMatrix& b)
105 {
106  return octave::elem_xpow (a, b);
107 }
108 
109 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
110 inline octave_value
111 elem_xpow (const SparseMatrix& a, const Complex& b)
112 {
113  return octave::elem_xpow (a, b);
114 }
115 
116 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
117 inline octave_value
118 elem_xpow (const SparseMatrix& a, const SparseComplexMatrix& b)
119 {
120  return octave::elem_xpow (a, b);
121 }
122 
123 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
124 inline octave_value
125 elem_xpow (const Complex& a, const SparseMatrix& b)
126 {
127  return octave::elem_xpow (a, b);
128 }
129 
130 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
131 inline octave_value
132 elem_xpow (const Complex& a, const SparseComplexMatrix& b)
133 {
134  return octave::elem_xpow (a, b);
135 }
136 
137 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
138 inline octave_value
139 elem_xpow (const SparseComplexMatrix& a, double b)
140 {
141  return octave::elem_xpow (a, b);
142 }
143 
144 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
145 inline octave_value
146 elem_xpow (const SparseComplexMatrix& a, const SparseMatrix& b)
147 {
148  return octave::elem_xpow (a, b);
149 }
150 
151 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
152 inline octave_value
153 elem_xpow (const SparseComplexMatrix& a, const Complex& b)
154 {
155  return octave::elem_xpow (a, b);
156 }
157 
158 OCTAVE_DEPRECATED (7, "use 'octave::elem_xpow' instead")
159 inline octave_value
161 {
162  return octave::elem_xpow (a, b);
163 }
164 
165 #endif
166 
167 #endif
OCTAVE_END_NAMESPACE(octave)
OCTAVE_BEGIN_NAMESPACE(octave) static octave_value daspk_fcn
std::complex< double > Complex
Definition: oct-cmplx.h:33
octave_value xpow(const SparseMatrix &a, double b)
Definition: sparse-xpow.cc:62
octave_value elem_xpow(double a, const SparseMatrix &b)
Definition: sparse-xpow.cc:347