Mercurial > octave-nkf
annotate liboctave/CNDArray.h @ 9721:192d94cff6c1
improve sum & implement the 'extra' option, refactor some code
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Tue, 13 Oct 2009 12:22:50 +0200 |
| parents | b29504415a2e |
| children | b4fdfee405b5 |
| rev | line source |
|---|---|
| 4514 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 John W. Eaton |
| 4514 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 4514 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 4514 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_ComplexNDArray_h) | |
| 24 #define octave_ComplexNDArray_h 1 | |
| 25 | |
| 26 #include "MArrayN.h" | |
| 27 #include "CMatrix.h" | |
| 28 | |
| 29 #include "mx-defs.h" | |
|
8774
b756ce0002db
split implementation and interface in mx-op-defs and MArray-defs
Jaroslav Hajek <highegg@gmail.com>
parents:
8650
diff
changeset
|
30 #include "mx-op-decl.h" |
| 4514 | 31 |
| 32 class | |
| 6108 | 33 OCTAVE_API |
| 4514 | 34 ComplexNDArray : public MArrayN<Complex> |
| 35 { | |
| 36 public: | |
| 5523 | 37 |
|
9656
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
38 typedef ComplexMatrix matrix_type; |
|
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
39 |
| 4514 | 40 ComplexNDArray (void) : MArrayN<Complex> () { } |
| 41 | |
| 4587 | 42 ComplexNDArray (const dim_vector& dv) : MArrayN<Complex> (dv) { } |
| 4514 | 43 |
| 4587 | 44 ComplexNDArray (const dim_vector& dv, const Complex& val) |
| 45 : MArrayN<Complex> (dv, val) { } | |
| 4514 | 46 |
| 47 ComplexNDArray (const ComplexNDArray& a) : MArrayN<Complex> (a) { } | |
| 48 | |
| 49 ComplexNDArray (const ComplexMatrix& a) : MArrayN<Complex> (a) { } | |
| 50 | |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
51 template <class U> |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
52 ComplexNDArray (const MArrayN<U>& a) : MArrayN<Complex> (a) { } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
53 |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
54 template <class U> |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
55 ComplexNDArray (const ArrayN<U>& a) : MArrayN<Complex> (a) { } |
| 4514 | 56 |
|
8956
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
57 ComplexNDArray (const charNDArray&); |
|
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
58 |
| 4514 | 59 ComplexNDArray& operator = (const ComplexNDArray& a) |
| 60 { | |
| 61 MArrayN<Complex>::operator = (a); | |
| 62 return *this; | |
| 63 } | |
| 64 | |
| 4543 | 65 // unary operations |
| 66 | |
| 67 boolNDArray operator ! (void) const; | |
| 68 | |
| 5775 | 69 // FIXME -- this is not quite the right thing. |
| 4514 | 70 |
|
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7789
diff
changeset
|
71 bool any_element_is_nan (void) const; |
| 4687 | 72 bool any_element_is_inf_or_nan (void) const; |
| 73 bool all_elements_are_real (void) const; | |
| 74 bool all_integers (double& max_val, double& min_val) const; | |
| 75 bool too_large_for_float (void) const; | |
| 76 | |
| 4556 | 77 boolNDArray all (int dim = -1) const; |
| 78 boolNDArray any (int dim = -1) const; | |
| 4514 | 79 |
| 4584 | 80 ComplexNDArray cumprod (int dim = -1) const; |
| 81 ComplexNDArray cumsum (int dim = -1) const; | |
| 4569 | 82 ComplexNDArray prod (int dim = -1) const; |
| 83 ComplexNDArray sum (int dim = -1) const; | |
|
9721
192d94cff6c1
improve sum & implement the 'extra' option, refactor some code
Jaroslav Hajek <highegg@gmail.com>
parents:
9656
diff
changeset
|
84 ComplexNDArray xsum (int dim = -1) const; |
| 4569 | 85 ComplexNDArray sumsq (int dim = -1) const; |
| 5275 | 86 ComplexNDArray concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx); |
| 87 ComplexNDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 4569 | 88 |
| 4844 | 89 ComplexNDArray max (int dim = 0) const; |
| 5275 | 90 ComplexNDArray max (ArrayN<octave_idx_type>& index, int dim = 0) const; |
| 4844 | 91 ComplexNDArray min (int dim = 0) const; |
| 5275 | 92 ComplexNDArray min (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
8777
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
93 |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
94 ComplexNDArray cummax (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
95 ComplexNDArray cummax (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
96 ComplexNDArray cummin (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
97 ComplexNDArray cummin (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
98 |
|
9513
9f870f73ab7d
implement built-in diff
Jaroslav Hajek <highegg@gmail.com>
parents:
9237
diff
changeset
|
99 ComplexNDArray diff (octave_idx_type order = 1, int dim = 0) const; |
|
9f870f73ab7d
implement built-in diff
Jaroslav Hajek <highegg@gmail.com>
parents:
9237
diff
changeset
|
100 |
| 5275 | 101 ComplexNDArray& insert (const NDArray& a, octave_idx_type r, octave_idx_type c); |
| 102 ComplexNDArray& insert (const ComplexNDArray& a, octave_idx_type r, octave_idx_type c); | |
| 103 ComplexNDArray& insert (const ComplexNDArray& a, const Array<octave_idx_type>& ra_idx); | |
| 4765 | 104 |
| 4634 | 105 NDArray abs (void) const; |
|
8998
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
106 boolNDArray isnan (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
107 boolNDArray isinf (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
108 boolNDArray isfinite (void) const; |
| 4569 | 109 |
|
9237
3c1762c7e787
Add missing xxx_API decoration and remove misplaced ones
Michael Goffioul <michael.goffioul@gmail.com>
parents:
8998
diff
changeset
|
110 friend OCTAVE_API ComplexNDArray conj (const ComplexNDArray& a); |
|
8650
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
111 |
| 4773 | 112 ComplexNDArray fourier (int dim = 1) const; |
| 113 ComplexNDArray ifourier (int dim = 1) const; | |
| 114 | |
| 115 ComplexNDArray fourier2d (void) const; | |
| 116 ComplexNDArray ifourier2d (void) const; | |
| 117 | |
| 118 ComplexNDArray fourierNd (void) const; | |
| 119 ComplexNDArray ifourierNd (void) const; | |
| 120 | |
| 4514 | 121 ComplexMatrix matrix_value (void) const; |
| 122 | |
| 4902 | 123 ComplexNDArray squeeze (void) const { return MArrayN<Complex>::squeeze (); } |
| 4532 | 124 |
| 5275 | 125 static void increment_index (Array<octave_idx_type>& ra_idx, |
| 4532 | 126 const dim_vector& dimensions, |
| 127 int start_dimension = 0); | |
| 128 | |
| 5275 | 129 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
| 4556 | 130 const dim_vector& dimensions); |
| 131 | |
| 4514 | 132 // i/o |
| 133 | |
| 6108 | 134 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const ComplexNDArray& a); |
| 135 friend OCTAVE_API std::istream& operator >> (std::istream& is, ComplexNDArray& a); | |
| 4514 | 136 |
| 137 static Complex resize_fill_value (void) { return Complex (0.0, 0.0); } | |
| 138 | |
| 139 // bool all_elements_are_real (void) const; | |
| 140 // bool all_integers (double& max_val, double& min_val) const; | |
| 141 | |
|
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
142 ComplexNDArray diag (octave_idx_type k = 0) const; |
|
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
143 |
|
9607
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
144 ComplexNDArray& changesign (void) |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
145 { |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
146 MArrayN<Complex>::changesign (); |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
147 return *this; |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
148 } |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9546
diff
changeset
|
149 |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
150 typedef double (*dmapper) (const Complex&); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
151 typedef Complex (*cmapper) (const Complex&); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
152 typedef bool (*bmapper) (const Complex&); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
153 |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
154 NDArray map (dmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
155 ComplexNDArray map (cmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
156 boolNDArray map (bmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
157 |
| 4514 | 158 private: |
| 159 | |
| 4634 | 160 ComplexNDArray (Complex *d, const dim_vector& dv) |
| 4587 | 161 : MArrayN<Complex> (d, dv) { } |
| 4514 | 162 }; |
| 163 | |
|
8650
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
164 extern OCTAVE_API ComplexNDArray conj (const ComplexNDArray& a); |
|
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
165 |
| 6108 | 166 extern OCTAVE_API ComplexNDArray min (const Complex& c, const ComplexNDArray& m); |
| 167 extern OCTAVE_API ComplexNDArray min (const ComplexNDArray& m, const Complex& c); | |
| 168 extern OCTAVE_API ComplexNDArray min (const ComplexNDArray& a, const ComplexNDArray& b); | |
| 4844 | 169 |
| 6108 | 170 extern OCTAVE_API ComplexNDArray max (const Complex& c, const ComplexNDArray& m); |
| 171 extern OCTAVE_API ComplexNDArray max (const ComplexNDArray& m, const Complex& c); | |
| 172 extern OCTAVE_API ComplexNDArray max (const ComplexNDArray& a, const ComplexNDArray& b); | |
| 4844 | 173 |
| 6708 | 174 NDS_CMP_OP_DECLS (ComplexNDArray, Complex, OCTAVE_API) |
| 175 NDS_BOOL_OP_DECLS (ComplexNDArray, Complex, OCTAVE_API) | |
| 4543 | 176 |
| 6708 | 177 SND_CMP_OP_DECLS (Complex, ComplexNDArray, OCTAVE_API) |
| 178 SND_BOOL_OP_DECLS (Complex, ComplexNDArray, OCTAVE_API) | |
| 4543 | 179 |
| 6708 | 180 NDND_CMP_OP_DECLS (ComplexNDArray, ComplexNDArray, OCTAVE_API) |
| 181 NDND_BOOL_OP_DECLS (ComplexNDArray, ComplexNDArray, OCTAVE_API) | |
| 4543 | 182 |
| 4514 | 183 MARRAY_FORWARD_DEFS (MArrayN, ComplexNDArray, Complex) |
| 184 | |
|
9546
1beb23d2b892
optimize op= in common cases
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
185 extern OCTAVE_API ComplexNDArray& operator *= (ComplexNDArray& a, double s); |
|
1beb23d2b892
optimize op= in common cases
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
186 extern OCTAVE_API ComplexNDArray& operator /= (ComplexNDArray& a, double s); |
|
1beb23d2b892
optimize op= in common cases
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
187 |
| 4514 | 188 #endif |
| 189 | |
| 190 /* | |
| 191 ;;; Local Variables: *** | |
| 192 ;;; mode: C++ *** | |
| 193 ;;; End: *** | |
| 194 */ |