Mercurial > hg > octave-nkf
annotate liboctave/dNDArray.h @ 9656:b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Sat, 19 Sep 2009 11:14:28 +0200 |
| parents | 1be3c73ed7b5 |
| children | 192d94cff6c1 |
| rev | line source |
|---|---|
| 4511 | 1 /* |
| 2 | |
| 8920 | 3 Copyright (C) 1996, 1997, 2003, 2004, 2005, 2006, 2007, 2008, |
| 4 2009 John W. Eaton | |
| 4511 | 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. | |
| 4511 | 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/>. | |
| 4511 | 21 |
| 22 */ | |
| 23 | |
| 4513 | 24 #if !defined (octave_NDArray_h) |
| 25 #define octave_NDArray_h 1 | |
| 4511 | 26 |
| 27 #include "MArrayN.h" | |
| 4513 | 28 #include "dMatrix.h" |
| 4902 | 29 #include "intNDArray.h" |
| 4511 | 30 |
| 31 #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
|
32 #include "mx-op-decl.h" |
| 4511 | 33 |
| 4513 | 34 class |
| 6108 | 35 OCTAVE_API |
| 4513 | 36 NDArray : public MArrayN<double> |
| 4511 | 37 { |
| 4513 | 38 public: |
| 5523 | 39 |
|
9656
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
40 typedef Matrix matrix_type; |
|
b29504415a2e
provide NDArray->Matrix->Vector typedef mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
9607
diff
changeset
|
41 |
| 4511 | 42 NDArray (void) : MArrayN<double> () { } |
| 43 | |
| 4587 | 44 NDArray (const dim_vector& dv) : MArrayN<double> (dv) { } |
| 4511 | 45 |
| 4587 | 46 NDArray (const dim_vector& dv, double val) |
| 47 : MArrayN<double> (dv, val) { } | |
| 4511 | 48 |
| 4513 | 49 NDArray (const NDArray& a) : MArrayN<double> (a) { } |
| 50 | |
| 51 NDArray (const Matrix& a) : MArrayN<double> (a) { } | |
| 4511 | 52 |
|
7919
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
53 NDArray (const Array<octave_idx_type>& a, bool zero_based = false, |
|
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
54 bool negative_to_nan = false); |
|
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
55 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
56 template <class U> |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
57 NDArray (const MArrayN<U>& a) : MArrayN<double> (a) { } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
58 |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
59 template <class U> |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
60 NDArray (const ArrayN<U>& a) : MArrayN<double> (a) { } |
| 4511 | 61 |
| 4902 | 62 template <class U> |
| 63 explicit NDArray (const intNDArray<U>& a) : MArrayN<double> (a) { } | |
| 4543 | 64 |
|
8956
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
65 NDArray (const charNDArray&); |
|
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
66 |
| 4511 | 67 NDArray& operator = (const NDArray& a) |
| 68 { | |
| 69 MArrayN<double>::operator = (a); | |
| 70 return *this; | |
| 71 } | |
| 72 | |
| 4543 | 73 // unary operations |
| 74 | |
| 75 boolNDArray operator ! (void) const; | |
| 76 | |
| 4634 | 77 bool any_element_is_negative (bool = false) const; |
|
7922
935be827eaf8
error for NaN values in & and | expressions
John W. Eaton <jwe@octave.org>
parents:
7919
diff
changeset
|
78 bool any_element_is_nan (void) const; |
| 4634 | 79 bool any_element_is_inf_or_nan (void) const; |
| 5943 | 80 bool any_element_not_one_or_zero (void) const; |
| 6989 | 81 bool all_elements_are_zero (void) const; |
| 4634 | 82 bool all_elements_are_int_or_inf_or_nan (void) const; |
| 83 bool all_integers (double& max_val, double& min_val) const; | |
| 84 bool too_large_for_float (void) const; | |
| 85 | |
| 5775 | 86 // FIXME -- this is not quite the right thing. |
| 4513 | 87 |
| 4556 | 88 boolNDArray all (int dim = -1) const; |
| 89 boolNDArray any (int dim = -1) const; | |
| 4513 | 90 |
| 4584 | 91 NDArray cumprod (int dim = -1) const; |
| 92 NDArray cumsum (int dim = -1) const; | |
| 4569 | 93 NDArray prod (int dim = -1) const; |
| 94 NDArray sum (int dim = -1) const; | |
| 95 NDArray sumsq (int dim = -1) const; | |
| 5275 | 96 NDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); |
| 97 ComplexNDArray concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 98 charNDArray concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 4844 | 99 |
| 100 NDArray max (int dim = 0) const; | |
| 5275 | 101 NDArray max (ArrayN<octave_idx_type>& index, int dim = 0) const; |
| 4844 | 102 NDArray min (int dim = 0) const; |
| 5275 | 103 NDArray min (ArrayN<octave_idx_type>& index, int dim = 0) const; |
| 4844 | 104 |
|
8777
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
105 NDArray cummax (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
106 NDArray cummax (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
107 NDArray cummin (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
108 NDArray cummin (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
109 |
|
9513
9f870f73ab7d
implement built-in diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8998
diff
changeset
|
110 NDArray diff (octave_idx_type order = 1, int dim = 0) const; |
|
9f870f73ab7d
implement built-in diff
Jaroslav Hajek <highegg@gmail.com>
parents:
8998
diff
changeset
|
111 |
| 5275 | 112 NDArray& insert (const NDArray& a, octave_idx_type r, octave_idx_type c); |
| 113 NDArray& insert (const NDArray& a, const Array<octave_idx_type>& ra_idx); | |
| 4915 | 114 |
| 4634 | 115 NDArray abs (void) const; |
|
8998
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
116 boolNDArray isnan (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
117 boolNDArray isinf (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
118 boolNDArray isfinite (void) const; |
| 4634 | 119 |
| 4773 | 120 ComplexNDArray fourier (int dim = 1) const; |
| 121 ComplexNDArray ifourier (int dim = 1) const; | |
| 122 | |
| 123 ComplexNDArray fourier2d (void) const; | |
| 124 ComplexNDArray ifourier2d (void) const; | |
| 125 | |
| 126 ComplexNDArray fourierNd (void) const; | |
| 127 ComplexNDArray ifourierNd (void) const; | |
| 128 | |
| 6108 | 129 friend OCTAVE_API NDArray real (const ComplexNDArray& a); |
| 130 friend OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
| 4569 | 131 |
|
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
|
132 friend class ComplexNDArray; |
|
a1ae2aae903e
abs,real,imag,conj: use code from mx-inlines rather than the generic map
Jaroslav Hajek <highegg@gmail.com>
parents:
7922
diff
changeset
|
133 |
| 4513 | 134 Matrix matrix_value (void) const; |
| 135 | |
| 4902 | 136 NDArray squeeze (void) const { return MArrayN<double>::squeeze (); } |
| 4532 | 137 |
| 5275 | 138 static void increment_index (Array<octave_idx_type>& ra_idx, |
| 4532 | 139 const dim_vector& dimensions, |
| 140 int start_dimension = 0); | |
| 141 | |
| 5275 | 142 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
| 4556 | 143 const dim_vector& dimensions); |
| 144 | |
| 4511 | 145 // i/o |
| 146 | |
| 6108 | 147 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const NDArray& a); |
| 148 friend OCTAVE_API std::istream& operator >> (std::istream& is, NDArray& a); | |
| 4511 | 149 |
| 150 static double resize_fill_value (void) { return 0; } | |
| 151 | |
|
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
152 NDArray 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
|
153 |
|
9607
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
154 NDArray& changesign (void) |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
155 { |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
156 MArrayN<double>::changesign (); |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
157 return *this; |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
158 } |
|
1be3c73ed7b5
reuse temporary arrays in nested expressions
Jaroslav Hajek <highegg@gmail.com>
parents:
9513
diff
changeset
|
159 |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
160 typedef double (*dmapper) (double); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
161 typedef Complex (*cmapper) (const Complex&); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
162 typedef bool (*bmapper) (double); |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
163 |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
164 NDArray map (dmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
165 ComplexNDArray map (cmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
166 boolNDArray map (bmapper fcn) const; |
|
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
167 |
| 4513 | 168 private: |
| 4511 | 169 |
| 4634 | 170 NDArray (double *d, const dim_vector& dv) : MArrayN<double> (d, dv) { } |
| 4511 | 171 }; |
| 172 | |
| 5508 | 173 // Publish externally used friend functions. |
| 174 | |
| 6108 | 175 extern OCTAVE_API NDArray real (const ComplexNDArray& a); |
| 176 extern OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
| 5508 | 177 |
| 6108 | 178 extern OCTAVE_API NDArray min (double d, const NDArray& m); |
| 179 extern OCTAVE_API NDArray min (const NDArray& m, double d); | |
| 180 extern OCTAVE_API NDArray min (const NDArray& a, const NDArray& b); | |
| 4844 | 181 |
| 6108 | 182 extern OCTAVE_API NDArray max (double d, const NDArray& m); |
| 183 extern OCTAVE_API NDArray max (const NDArray& m, double d); | |
| 184 extern OCTAVE_API NDArray max (const NDArray& a, const NDArray& b); | |
| 4844 | 185 |
| 6708 | 186 NDS_CMP_OP_DECLS (NDArray, double, OCTAVE_API) |
| 187 NDS_BOOL_OP_DECLS (NDArray, double, OCTAVE_API) | |
| 4543 | 188 |
| 6708 | 189 SND_CMP_OP_DECLS (double, NDArray, OCTAVE_API) |
| 190 SND_BOOL_OP_DECLS (double, NDArray, OCTAVE_API) | |
| 4543 | 191 |
| 6708 | 192 NDND_CMP_OP_DECLS (NDArray, NDArray, OCTAVE_API) |
| 193 NDND_BOOL_OP_DECLS (NDArray, NDArray, OCTAVE_API) | |
| 4543 | 194 |
| 4511 | 195 MARRAY_FORWARD_DEFS (MArrayN, NDArray, double) |
| 196 | |
| 197 #endif | |
| 4513 | 198 |
| 199 /* | |
| 200 ;;; Local Variables: *** | |
| 201 ;;; mode: C++ *** | |
| 202 ;;; End: *** | |
| 203 */ |