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