Mercurial > hg > octave-nkf
annotate liboctave/dNDArray.h @ 12011:67ad3b58b99a release-3-2-x
improve error handling
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Wed, 24 Jun 2009 07:31:32 +0200 |
| parents | a48fba01e4ac |
| children | 9f870f73ab7d |
| 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 |
| 4511 | 40 NDArray (void) : MArrayN<double> () { } |
| 41 | |
| 4587 | 42 NDArray (const dim_vector& dv) : MArrayN<double> (dv) { } |
| 4511 | 43 |
| 4587 | 44 NDArray (const dim_vector& dv, double val) |
| 45 : MArrayN<double> (dv, val) { } | |
| 4511 | 46 |
| 4513 | 47 NDArray (const NDArray& a) : MArrayN<double> (a) { } |
| 48 | |
| 49 NDArray (const Matrix& a) : MArrayN<double> (a) { } | |
| 4511 | 50 |
|
7919
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
51 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
|
52 bool negative_to_nan = false); |
|
9d080df0c843
new NDArray constructor for ArrayN<octave_idx_type>
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
53 |
|
7789
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 NDArray (const MArrayN<U>& a) : MArrayN<double> (a) { } |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
56 |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
57 template <class U> |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7620
diff
changeset
|
58 NDArray (const ArrayN<U>& a) : MArrayN<double> (a) { } |
| 4511 | 59 |
| 4902 | 60 template <class U> |
| 61 explicit NDArray (const intNDArray<U>& a) : MArrayN<double> (a) { } | |
| 4543 | 62 |
|
8956
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
63 NDArray (const charNDArray&); |
|
d91fa4b20bbb
ensure nonnegative char -> real conversion
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
64 |
| 4511 | 65 NDArray& operator = (const NDArray& a) |
| 66 { | |
| 67 MArrayN<double>::operator = (a); | |
| 68 return *this; | |
| 69 } | |
| 70 | |
| 4543 | 71 // unary operations |
| 72 | |
| 73 boolNDArray operator ! (void) const; | |
| 74 | |
| 4634 | 75 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
|
76 bool any_element_is_nan (void) const; |
| 4634 | 77 bool any_element_is_inf_or_nan (void) const; |
| 5943 | 78 bool any_element_not_one_or_zero (void) const; |
| 6989 | 79 bool all_elements_are_zero (void) const; |
| 4634 | 80 bool all_elements_are_int_or_inf_or_nan (void) const; |
| 81 bool all_integers (double& max_val, double& min_val) const; | |
| 82 bool too_large_for_float (void) const; | |
| 83 | |
| 5775 | 84 // FIXME -- this is not quite the right thing. |
| 4513 | 85 |
| 4556 | 86 boolNDArray all (int dim = -1) const; |
| 87 boolNDArray any (int dim = -1) const; | |
| 4513 | 88 |
| 4584 | 89 NDArray cumprod (int dim = -1) const; |
| 90 NDArray cumsum (int dim = -1) const; | |
| 4569 | 91 NDArray prod (int dim = -1) const; |
| 92 NDArray sum (int dim = -1) const; | |
| 93 NDArray sumsq (int dim = -1) const; | |
| 5275 | 94 NDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); |
| 95 ComplexNDArray concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 96 charNDArray concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx); | |
| 4844 | 97 |
| 98 NDArray max (int dim = 0) const; | |
| 5275 | 99 NDArray max (ArrayN<octave_idx_type>& index, int dim = 0) const; |
| 4844 | 100 NDArray min (int dim = 0) const; |
| 5275 | 101 NDArray min (ArrayN<octave_idx_type>& index, int dim = 0) const; |
| 4844 | 102 |
|
8777
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
103 NDArray cummax (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
104 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
|
105 NDArray cummin (int dim = 0) const; |
|
724c0f46d9d4
implement cummin/cummax functions
Jaroslav Hajek <highegg@gmail.com>
parents:
8774
diff
changeset
|
106 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
|
107 |
| 5275 | 108 NDArray& insert (const NDArray& a, octave_idx_type r, octave_idx_type c); |
| 109 NDArray& insert (const NDArray& a, const Array<octave_idx_type>& ra_idx); | |
| 4915 | 110 |
| 4634 | 111 NDArray abs (void) const; |
|
8998
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
112 boolNDArray isnan (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
113 boolNDArray isinf (void) const; |
|
a48fba01e4ac
optimize isnan/isinf/isfinite mappers
Jaroslav Hajek <highegg@gmail.com>
parents:
8956
diff
changeset
|
114 boolNDArray isfinite (void) const; |
| 4634 | 115 |
| 4773 | 116 ComplexNDArray fourier (int dim = 1) const; |
| 117 ComplexNDArray ifourier (int dim = 1) const; | |
| 118 | |
| 119 ComplexNDArray fourier2d (void) const; | |
| 120 ComplexNDArray ifourier2d (void) const; | |
| 121 | |
| 122 ComplexNDArray fourierNd (void) const; | |
| 123 ComplexNDArray ifourierNd (void) const; | |
| 124 | |
| 6108 | 125 friend OCTAVE_API NDArray real (const ComplexNDArray& a); |
| 126 friend OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
| 4569 | 127 |
|
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
|
128 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
|
129 |
| 4513 | 130 Matrix matrix_value (void) const; |
| 131 | |
| 4902 | 132 NDArray squeeze (void) const { return MArrayN<double>::squeeze (); } |
| 4532 | 133 |
| 5275 | 134 static void increment_index (Array<octave_idx_type>& ra_idx, |
| 4532 | 135 const dim_vector& dimensions, |
| 136 int start_dimension = 0); | |
| 137 | |
| 5275 | 138 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
| 4556 | 139 const dim_vector& dimensions); |
| 140 | |
| 4511 | 141 // i/o |
| 142 | |
| 6108 | 143 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const NDArray& a); |
| 144 friend OCTAVE_API std::istream& operator >> (std::istream& is, NDArray& a); | |
| 4511 | 145 |
| 146 static double resize_fill_value (void) { return 0; } | |
| 147 | |
|
7620
36594d5bbe13
Move diag function into the octave_value class
David Bateman <dbateman@free.fr>
parents:
7503
diff
changeset
|
148 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
|
149 |
|
7503
8c32f95c2639
convert mapper functions to new format
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
150 typedef double (*dmapper) (double); |
|
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) (double); |
|
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 |
| 4513 | 158 private: |
| 4511 | 159 |
| 4634 | 160 NDArray (double *d, const dim_vector& dv) : MArrayN<double> (d, dv) { } |
| 4511 | 161 }; |
| 162 | |
| 5508 | 163 // Publish externally used friend functions. |
| 164 | |
| 6108 | 165 extern OCTAVE_API NDArray real (const ComplexNDArray& a); |
| 166 extern OCTAVE_API NDArray imag (const ComplexNDArray& a); | |
| 5508 | 167 |
| 6108 | 168 extern OCTAVE_API NDArray min (double d, const NDArray& m); |
| 169 extern OCTAVE_API NDArray min (const NDArray& m, double d); | |
| 170 extern OCTAVE_API NDArray min (const NDArray& a, const NDArray& b); | |
| 4844 | 171 |
| 6108 | 172 extern OCTAVE_API NDArray max (double d, const NDArray& m); |
| 173 extern OCTAVE_API NDArray max (const NDArray& m, double d); | |
| 174 extern OCTAVE_API NDArray max (const NDArray& a, const NDArray& b); | |
| 4844 | 175 |
| 6708 | 176 NDS_CMP_OP_DECLS (NDArray, double, OCTAVE_API) |
| 177 NDS_BOOL_OP_DECLS (NDArray, double, OCTAVE_API) | |
| 4543 | 178 |
| 6708 | 179 SND_CMP_OP_DECLS (double, NDArray, OCTAVE_API) |
| 180 SND_BOOL_OP_DECLS (double, NDArray, OCTAVE_API) | |
| 4543 | 181 |
| 6708 | 182 NDND_CMP_OP_DECLS (NDArray, NDArray, OCTAVE_API) |
| 183 NDND_BOOL_OP_DECLS (NDArray, NDArray, OCTAVE_API) | |
| 4543 | 184 |
| 4511 | 185 MARRAY_FORWARD_DEFS (MArrayN, NDArray, double) |
| 186 | |
| 187 #endif | |
| 4513 | 188 |
| 189 /* | |
| 190 ;;; Local Variables: *** | |
| 191 ;;; mode: C++ *** | |
| 192 ;;; End: *** | |
| 193 */ |