Mercurial > hg > octave-lyh
annotate src/xpow.h @ 10687:a8ce6bdecce5
Improve documentation strings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 Jun 2010 20:22:38 -0700 |
parents | cd96d29c5efa |
children | fd0a3ac60b0e |
rev | line source |
---|---|
1 | 1 /* |
2 | |
8920 | 3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 2002, 2003, 2005, 2007, 2008 |
7017 | 4 John W. Eaton |
1 | 5 |
6 This file is part of Octave. | |
7 | |
8 Octave is free software; you can redistribute it and/or modify it | |
9 under the terms of the GNU General Public License as published by the | |
7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
11 option) any later version. | |
1 | 12 |
13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
7016 | 19 along with Octave; see the file COPYING. If not, see |
20 <http://www.gnu.org/licenses/>. | |
1 | 21 |
22 */ | |
23 | |
383 | 24 #if !defined (octave_xpow_h) |
25 #define octave_xpow_h 1 | |
1 | 26 |
1651 | 27 #include "oct-cmplx.h" |
28 | |
164 | 29 class Matrix; |
30 class ComplexMatrix; | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
31 class FloatMatrix; |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
32 class FloatComplexMatrix; |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
33 class DiagMatrix; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
34 class ComplexDiagMatrix; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
35 class FloatDiagMatrix; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
36 class FloatComplexDiagMatrix; |
8958
6ccc12cc65ef
implement raising a permutation matrix to integer power
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
37 class PermMatrix; |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
38 class NDArray; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
39 class FloatNDArray; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
40 class ComplexNDArray; |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
41 class FloatComplexNDArray; |
2086 | 42 class octave_value; |
9103
10bed8fbec99
optimize scalar .^ range operation
Jaroslav Hajek <highegg@gmail.com>
parents:
8960
diff
changeset
|
43 class Range; |
1 | 44 |
2086 | 45 extern octave_value xpow (double a, double b); |
46 extern octave_value xpow (double a, const Matrix& b); | |
47 extern octave_value xpow (double a, const Complex& b); | |
48 extern octave_value xpow (double a, const ComplexMatrix& b); | |
1 | 49 |
2086 | 50 extern octave_value xpow (const Matrix& a, double b); |
51 extern octave_value xpow (const Matrix& a, const Complex& b); | |
1 | 52 |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
53 extern octave_value xpow (const DiagMatrix& a, double b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
54 extern octave_value xpow (const DiagMatrix& a, const Complex& b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
55 |
8958
6ccc12cc65ef
implement raising a permutation matrix to integer power
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
56 extern octave_value xpow (const PermMatrix& a, double b); |
6ccc12cc65ef
implement raising a permutation matrix to integer power
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
57 |
2086 | 58 extern octave_value xpow (const Complex& a, double b); |
59 extern octave_value xpow (const Complex& a, const Matrix& b); | |
60 extern octave_value xpow (const Complex& a, const Complex& b); | |
61 extern octave_value xpow (const Complex& a, const ComplexMatrix& b); | |
1 | 62 |
2086 | 63 extern octave_value xpow (const ComplexMatrix& a, double b); |
64 extern octave_value xpow (const ComplexMatrix& a, const Complex& b); | |
1 | 65 |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
66 extern octave_value xpow (const ComplexDiagMatrix& a, double b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
67 extern octave_value xpow (const ComplexDiagMatrix& a, const Complex& b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
68 |
2086 | 69 extern octave_value elem_xpow (double a, const Matrix& b); |
70 extern octave_value elem_xpow (double a, const ComplexMatrix& b); | |
9103
10bed8fbec99
optimize scalar .^ range operation
Jaroslav Hajek <highegg@gmail.com>
parents:
8960
diff
changeset
|
71 extern octave_value elem_xpow (double a, const Range& r); |
1 | 72 |
2086 | 73 extern octave_value elem_xpow (const Matrix& a, double b); |
74 extern octave_value elem_xpow (const Matrix& a, const Matrix& b); | |
75 extern octave_value elem_xpow (const Matrix& a, const Complex& b); | |
76 extern octave_value elem_xpow (const Matrix& a, const ComplexMatrix& b); | |
1 | 77 |
2086 | 78 extern octave_value elem_xpow (const Complex& a, const Matrix& b); |
79 extern octave_value elem_xpow (const Complex& a, const ComplexMatrix& b); | |
9103
10bed8fbec99
optimize scalar .^ range operation
Jaroslav Hajek <highegg@gmail.com>
parents:
8960
diff
changeset
|
80 extern octave_value elem_xpow (const Complex& a, const Range& r); |
1 | 81 |
2086 | 82 extern octave_value elem_xpow (const ComplexMatrix& a, double b); |
83 extern octave_value elem_xpow (const ComplexMatrix& a, const Matrix& b); | |
84 extern octave_value elem_xpow (const ComplexMatrix& a, const Complex& b); | |
4188 | 85 extern octave_value elem_xpow (const ComplexMatrix& a, const ComplexMatrix& b); |
1 | 86 |
4543 | 87 |
88 extern octave_value elem_xpow (double a, const NDArray& b); | |
89 extern octave_value elem_xpow (double a, const ComplexNDArray& b); | |
90 | |
91 extern octave_value elem_xpow (const NDArray& a, double b); | |
92 extern octave_value elem_xpow (const NDArray& a, const NDArray& b); | |
93 extern octave_value elem_xpow (const NDArray& a, const Complex& b); | |
94 extern octave_value elem_xpow (const NDArray& a, const ComplexNDArray& b); | |
95 | |
96 extern octave_value elem_xpow (const Complex& a, const NDArray& b); | |
97 extern octave_value elem_xpow (const Complex& a, const ComplexNDArray& b); | |
98 | |
99 extern octave_value elem_xpow (const ComplexNDArray& a, double b); | |
100 extern octave_value elem_xpow (const ComplexNDArray& a, const NDArray& b); | |
101 extern octave_value elem_xpow (const ComplexNDArray& a, const Complex& b); | |
102 extern octave_value elem_xpow (const ComplexNDArray& a, const ComplexNDArray& b); | |
103 | |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
104 extern octave_value xpow (float a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
105 extern octave_value xpow (float a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
106 extern octave_value xpow (float a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
107 extern octave_value xpow (float a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
108 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
109 extern octave_value xpow (const FloatMatrix& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
110 extern octave_value xpow (const FloatMatrix& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
111 |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
112 extern octave_value xpow (const FloatDiagMatrix& a, float b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
113 extern octave_value xpow (const FloatDiagMatrix& a, const FloatComplex& b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
114 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
115 extern octave_value xpow (const FloatComplex& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
116 extern octave_value xpow (const FloatComplex& a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
117 extern octave_value xpow (const FloatComplex& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
118 extern octave_value xpow (const FloatComplex& a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
119 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
120 extern octave_value xpow (const FloatComplexMatrix& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
121 extern octave_value xpow (const FloatComplexMatrix& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
122 |
8382
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
123 extern octave_value xpow (const FloatComplexDiagMatrix& a, float b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
124 extern octave_value xpow (const FloatComplexDiagMatrix& a, const FloatComplex& b); |
9b20a4847056
implement scalar powers of diag matrices
Jaroslav Hajek <highegg@gmail.com>
parents:
7789
diff
changeset
|
125 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
126 extern octave_value elem_xpow (float a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
127 extern octave_value elem_xpow (float a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
128 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
129 extern octave_value elem_xpow (const FloatMatrix& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
130 extern octave_value elem_xpow (const FloatMatrix& a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
131 extern octave_value elem_xpow (const FloatMatrix& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
132 extern octave_value elem_xpow (const FloatMatrix& a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
133 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
134 extern octave_value elem_xpow (const FloatComplex& a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
135 extern octave_value elem_xpow (const FloatComplex& a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
136 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
137 extern octave_value elem_xpow (const FloatComplexMatrix& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
138 extern octave_value elem_xpow (const FloatComplexMatrix& a, const FloatMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
139 extern octave_value elem_xpow (const FloatComplexMatrix& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
140 extern octave_value elem_xpow (const FloatComplexMatrix& a, const FloatComplexMatrix& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
141 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
142 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
143 extern octave_value elem_xpow (float a, const FloatNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
144 extern octave_value elem_xpow (float a, const FloatComplexNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
145 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
146 extern octave_value elem_xpow (const FloatNDArray& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
147 extern octave_value elem_xpow (const FloatNDArray& a, const FloatNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
148 extern octave_value elem_xpow (const FloatNDArray& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
149 extern octave_value elem_xpow (const FloatNDArray& a, const FloatComplexNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
150 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
151 extern octave_value elem_xpow (const FloatComplex& a, const FloatNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
152 extern octave_value elem_xpow (const FloatComplex& a, const FloatComplexNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
153 |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
154 extern octave_value elem_xpow (const FloatComplexNDArray& a, float b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
155 extern octave_value elem_xpow (const FloatComplexNDArray& a, const FloatNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
156 extern octave_value elem_xpow (const FloatComplexNDArray& a, const FloatComplex& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
157 extern octave_value elem_xpow (const FloatComplexNDArray& a, const FloatComplexNDArray& b); |
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
158 |
1 | 159 #endif |