|
4511
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
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" |
|
|
31 #include "mx-op-defs.h" |
|
|
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 |
|
|
50 NDArray (const MArrayN<double>& a) : MArrayN<double> (a) { } |
|
|
51 |
|
4902
|
52 template <class U> |
|
|
53 explicit NDArray (const intNDArray<U>& a) : MArrayN<double> (a) { } |
|
4543
|
54 |
|
4511
|
55 NDArray& operator = (const NDArray& a) |
|
|
56 { |
|
|
57 MArrayN<double>::operator = (a); |
|
|
58 return *this; |
|
|
59 } |
|
|
60 |
|
4543
|
61 // unary operations |
|
|
62 |
|
|
63 boolNDArray operator ! (void) const; |
|
|
64 |
|
4634
|
65 bool any_element_is_negative (bool = false) const; |
|
|
66 bool any_element_is_inf_or_nan (void) const; |
|
5943
|
67 bool any_element_not_one_or_zero (void) const; |
|
6989
|
68 bool all_elements_are_zero (void) const; |
|
4634
|
69 bool all_elements_are_int_or_inf_or_nan (void) const; |
|
|
70 bool all_integers (double& max_val, double& min_val) const; |
|
|
71 bool too_large_for_float (void) const; |
|
|
72 |
|
5775
|
73 // FIXME -- this is not quite the right thing. |
|
4513
|
74 |
|
4556
|
75 boolNDArray all (int dim = -1) const; |
|
|
76 boolNDArray any (int dim = -1) const; |
|
4513
|
77 |
|
4584
|
78 NDArray cumprod (int dim = -1) const; |
|
|
79 NDArray cumsum (int dim = -1) const; |
|
4569
|
80 NDArray prod (int dim = -1) const; |
|
|
81 NDArray sum (int dim = -1) const; |
|
|
82 NDArray sumsq (int dim = -1) const; |
|
5275
|
83 NDArray concat (const NDArray& rb, const Array<octave_idx_type>& ra_idx); |
|
|
84 ComplexNDArray concat (const ComplexNDArray& rb, const Array<octave_idx_type>& ra_idx); |
|
|
85 charNDArray concat (const charNDArray& rb, const Array<octave_idx_type>& ra_idx); |
|
4844
|
86 |
|
|
87 NDArray max (int dim = 0) const; |
|
5275
|
88 NDArray max (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
4844
|
89 NDArray min (int dim = 0) const; |
|
5275
|
90 NDArray min (ArrayN<octave_idx_type>& index, int dim = 0) const; |
|
4844
|
91 |
|
5275
|
92 NDArray& insert (const NDArray& a, octave_idx_type r, octave_idx_type c); |
|
|
93 NDArray& insert (const NDArray& a, const Array<octave_idx_type>& ra_idx); |
|
4915
|
94 |
|
4634
|
95 NDArray abs (void) const; |
|
|
96 |
|
4773
|
97 ComplexNDArray fourier (int dim = 1) const; |
|
|
98 ComplexNDArray ifourier (int dim = 1) const; |
|
|
99 |
|
|
100 ComplexNDArray fourier2d (void) const; |
|
|
101 ComplexNDArray ifourier2d (void) const; |
|
|
102 |
|
|
103 ComplexNDArray fourierNd (void) const; |
|
|
104 ComplexNDArray ifourierNd (void) const; |
|
|
105 |
|
6108
|
106 friend OCTAVE_API NDArray real (const ComplexNDArray& a); |
|
|
107 friend OCTAVE_API NDArray imag (const ComplexNDArray& a); |
|
4569
|
108 |
|
4513
|
109 Matrix matrix_value (void) const; |
|
|
110 |
|
4902
|
111 NDArray squeeze (void) const { return MArrayN<double>::squeeze (); } |
|
4532
|
112 |
|
5275
|
113 static void increment_index (Array<octave_idx_type>& ra_idx, |
|
4532
|
114 const dim_vector& dimensions, |
|
|
115 int start_dimension = 0); |
|
|
116 |
|
5275
|
117 static octave_idx_type compute_index (Array<octave_idx_type>& ra_idx, |
|
4556
|
118 const dim_vector& dimensions); |
|
|
119 |
|
4511
|
120 // i/o |
|
|
121 |
|
6108
|
122 friend OCTAVE_API std::ostream& operator << (std::ostream& os, const NDArray& a); |
|
|
123 friend OCTAVE_API std::istream& operator >> (std::istream& is, NDArray& a); |
|
4511
|
124 |
|
|
125 static double resize_fill_value (void) { return 0; } |
|
|
126 |
|
4513
|
127 private: |
|
4511
|
128 |
|
4634
|
129 NDArray (double *d, const dim_vector& dv) : MArrayN<double> (d, dv) { } |
|
4511
|
130 }; |
|
|
131 |
|
5508
|
132 // Publish externally used friend functions. |
|
|
133 |
|
6108
|
134 extern OCTAVE_API NDArray real (const ComplexNDArray& a); |
|
|
135 extern OCTAVE_API NDArray imag (const ComplexNDArray& a); |
|
5508
|
136 |
|
6108
|
137 extern OCTAVE_API NDArray min (double d, const NDArray& m); |
|
|
138 extern OCTAVE_API NDArray min (const NDArray& m, double d); |
|
|
139 extern OCTAVE_API NDArray min (const NDArray& a, const NDArray& b); |
|
4844
|
140 |
|
6108
|
141 extern OCTAVE_API NDArray max (double d, const NDArray& m); |
|
|
142 extern OCTAVE_API NDArray max (const NDArray& m, double d); |
|
|
143 extern OCTAVE_API NDArray max (const NDArray& a, const NDArray& b); |
|
4844
|
144 |
|
6708
|
145 NDS_CMP_OP_DECLS (NDArray, double, OCTAVE_API) |
|
|
146 NDS_BOOL_OP_DECLS (NDArray, double, OCTAVE_API) |
|
4543
|
147 |
|
6708
|
148 SND_CMP_OP_DECLS (double, NDArray, OCTAVE_API) |
|
|
149 SND_BOOL_OP_DECLS (double, NDArray, OCTAVE_API) |
|
4543
|
150 |
|
6708
|
151 NDND_CMP_OP_DECLS (NDArray, NDArray, OCTAVE_API) |
|
|
152 NDND_BOOL_OP_DECLS (NDArray, NDArray, OCTAVE_API) |
|
4543
|
153 |
|
4511
|
154 MARRAY_FORWARD_DEFS (MArrayN, NDArray, double) |
|
|
155 |
|
|
156 #endif |
|
4513
|
157 |
|
|
158 /* |
|
|
159 ;;; Local Variables: *** |
|
|
160 ;;; mode: C++ *** |
|
|
161 ;;; End: *** |
|
|
162 */ |
