|
228
|
1 // Template array classes -*- C++ -*- |
|
|
2 /* |
|
|
3 |
|
319
|
4 Copyright (C) 1993, 1994 John W. Eaton |
|
228
|
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 |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
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 |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
|
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 #if !defined (_Array_h) |
|
|
25 #define _Array_h 1 |
|
|
26 |
|
238
|
27 #if defined (__GNUG__) && defined (USE_EXTERNAL_TEMPLATES) |
|
|
28 #pragma interface |
|
|
29 #endif |
|
|
30 |
|
|
31 // Classes we declare. |
|
228
|
32 |
|
238
|
33 template <class T> class ArrayRep; |
|
|
34 template <class T> class Array; |
|
|
35 template <class T> class Array2; |
|
|
36 template <class T> class Array3; |
|
|
37 template <class T> class DiagArray; |
|
|
38 |
|
|
39 /* |
|
|
40 * The real representation of all arrays. |
|
|
41 */ |
|
228
|
42 |
|
|
43 template <class T> |
|
|
44 class ArrayRep |
|
|
45 { |
|
238
|
46 // Rethink resize()? |
|
228
|
47 friend class Array<T>; |
|
238
|
48 friend class Array2<T>; |
|
|
49 friend class Array3<T>; |
|
|
50 friend class DiagArray<T>; |
|
|
51 |
|
|
52 protected: |
|
|
53 |
|
|
54 ArrayRep (T *d, int l); |
|
228
|
55 |
|
|
56 public: |
|
|
57 |
|
238
|
58 ArrayRep (void); |
|
|
59 ArrayRep (int n); |
|
|
60 ArrayRep (const ArrayRep<T>& a); |
|
228
|
61 |
|
|
62 ~ArrayRep (void); |
|
238
|
63 |
|
228
|
64 int length (void) const; |
|
238
|
65 |
|
228
|
66 T& elem (int n); |
|
238
|
67 |
|
228
|
68 T elem (int n) const; |
|
238
|
69 |
|
|
70 void resize (int n); |
|
|
71 |
|
228
|
72 private: |
|
238
|
73 |
|
228
|
74 T *data; |
|
|
75 int len; |
|
|
76 int count; |
|
|
77 }; |
|
|
78 |
|
238
|
79 /* |
|
|
80 * One dimensional array class. Handles the reference counting for |
|
|
81 * all the derived classes. |
|
|
82 */ |
|
|
83 |
|
228
|
84 template <class T> |
|
|
85 class Array |
|
|
86 { |
|
238
|
87 protected: |
|
|
88 |
|
|
89 ArrayRep<T> *rep; |
|
|
90 |
|
|
91 Array (T *d, int l); |
|
|
92 |
|
228
|
93 public: |
|
238
|
94 |
|
228
|
95 Array (void); |
|
238
|
96 Array (int n); |
|
|
97 Array (int n, const T& val); |
|
|
98 |
|
228
|
99 Array (const Array<T>& a); |
|
|
100 |
|
|
101 ~Array (void); |
|
|
102 |
|
|
103 Array<T>& operator = (const Array<T>& a); |
|
238
|
104 |
|
|
105 int capacity (void) const; |
|
228
|
106 int length (void) const; |
|
|
107 |
|
|
108 T& elem (int n); |
|
|
109 T& checkelem (int n); |
|
|
110 T& operator () (int n); |
|
|
111 |
|
238
|
112 // No checking. |
|
|
113 T& xelem (int n); |
|
|
114 |
|
228
|
115 T elem (int n) const; |
|
|
116 T checkelem (int n) const; |
|
|
117 T operator () (int n) const; |
|
|
118 |
|
238
|
119 void resize (int n); |
|
|
120 void resize (int n, const T& val); |
|
|
121 |
|
|
122 const T *data (void) const; |
|
228
|
123 |
|
238
|
124 T *fortran_vec (void); |
|
228
|
125 }; |
|
|
126 |
|
238
|
127 /* |
|
|
128 * Two dimensional array class. |
|
|
129 */ |
|
|
130 |
|
228
|
131 template <class T> |
|
|
132 class Array2 : public Array<T> |
|
|
133 { |
|
238
|
134 protected: |
|
|
135 |
|
|
136 int d1; |
|
|
137 int d2; |
|
|
138 |
|
|
139 Array2 (T *d, int n, int m); |
|
|
140 |
|
228
|
141 public: |
|
|
142 |
|
|
143 Array2 (void); |
|
|
144 Array2 (int n, int m); |
|
238
|
145 Array2 (int n, int m, const T& val); |
|
228
|
146 Array2 (const Array2<T>& a); |
|
238
|
147 Array2 (const DiagArray<T>& a); |
|
228
|
148 |
|
|
149 Array2<T>& operator = (const Array2<T>& a); |
|
|
150 |
|
|
151 int dim1 (void) const; |
|
|
152 int dim2 (void) const; |
|
238
|
153 |
|
|
154 int rows (void) const; |
|
|
155 int cols (void) const; |
|
|
156 int columns (void) const; |
|
|
157 |
|
228
|
158 T& elem (int i, int j); |
|
238
|
159 T& checkelem (int i, int j); |
|
228
|
160 T& operator () (int i, int j); |
|
238
|
161 |
|
|
162 // No checking. |
|
|
163 T& xelem (int i, int j); |
|
|
164 |
|
228
|
165 T elem (int i, int j) const; |
|
|
166 T checkelem (int i, int j) const; |
|
|
167 T operator () (int i, int j) const; |
|
|
168 |
|
238
|
169 void resize (int n, int m); |
|
|
170 void resize (int n, int m, const T& val); |
|
228
|
171 }; |
|
|
172 |
|
238
|
173 /* |
|
|
174 * Three dimensional array class. |
|
|
175 */ |
|
|
176 |
|
228
|
177 template <class T> |
|
|
178 class Array3 : public Array2<T> |
|
|
179 { |
|
238
|
180 protected: |
|
|
181 |
|
|
182 int d3; |
|
|
183 |
|
|
184 Array3 (T *d, int n, int m, int k); |
|
|
185 |
|
228
|
186 public: |
|
|
187 |
|
|
188 Array3 (void); |
|
|
189 Array3 (int n, int m, int k); |
|
238
|
190 Array3 (int n, int m, int k, const T& val); |
|
228
|
191 Array3 (const Array3<T>& a); |
|
|
192 |
|
|
193 Array3<T>& operator = (const Array3<T>& a); |
|
|
194 |
|
|
195 int dim3 (void) const; |
|
|
196 |
|
|
197 T& elem (int i, int j, int k); |
|
238
|
198 T& checkelem (int i, int j, int k); |
|
|
199 T& operator () (int i, int j, int k); |
|
|
200 |
|
|
201 // No checking. |
|
|
202 T& xelem (int i, int j, int k); |
|
|
203 |
|
228
|
204 T elem (int i, int j, int k) const; |
|
238
|
205 T checkelem (int i, int j, int k) const; |
|
|
206 T operator () (int i, int j, int k) const; |
|
228
|
207 |
|
238
|
208 void resize (int n, int m, int k); |
|
|
209 void resize (int n, int m, int k, const T& val); |
|
228
|
210 }; |
|
|
211 |
|
238
|
212 /* |
|
|
213 * A two-dimensional array with diagonal elements only. |
|
319
|
214 * |
|
|
215 * Idea and example code for Proxy class and functions from: |
|
|
216 * |
|
|
217 * From: kanze@us-es.sel.de (James Kanze) |
|
|
218 * Subject: Re: How to overload [] to do READ/WRITE differently ? |
|
|
219 * Message-ID: <KANZE.93Nov29151407@slsvhdt.us-es.sel.de> |
|
|
220 * Sender: news@us-es.sel.de |
|
|
221 * Date: 29 Nov 1993 14:14:07 GMT |
|
|
222 * -- |
|
|
223 * James Kanze email: kanze@us-es.sel.de |
|
|
224 * GABI Software, Sarl., 8 rue du Faisan, F-67000 Strasbourg, France |
|
238
|
225 */ |
|
|
226 |
|
228
|
227 template <class T> |
|
|
228 class DiagArray : public Array<T> |
|
|
229 { |
|
344
|
230 #if ! defined (_AIX) |
|
319
|
231 private: |
|
|
232 |
|
|
233 class Proxy |
|
|
234 { |
|
|
235 public: |
|
|
236 |
|
|
237 Proxy (DiagArray<T> *ref, int r, int c) : object (ref), i (r), j (c) { } |
|
|
238 |
|
|
239 const Proxy& operator = (const T& val) const |
|
|
240 { |
|
|
241 if (i == j) |
|
|
242 { |
|
|
243 if (object) |
|
|
244 object->set (val, i); |
|
|
245 } |
|
|
246 else |
|
|
247 (*current_liboctave_error_handler) |
|
|
248 ("assignment to off-diagonal element attempted for diagonal array"); |
|
|
249 |
|
|
250 return *this; |
|
|
251 } |
|
|
252 |
|
|
253 operator T () const |
|
|
254 { |
|
|
255 if (object) |
|
|
256 return object->get (i); |
|
|
257 else |
|
|
258 { |
|
|
259 static T foo (0); |
|
|
260 return foo; |
|
|
261 } |
|
|
262 } |
|
|
263 |
|
|
264 private: |
|
|
265 |
|
|
266 // XXX FIXME XXX -- this is declared private to keep the user from |
|
|
267 // taking the address of a Proxy. Maybe it should be implemented by |
|
|
268 // means of a companion function in the DiagArray class. |
|
|
269 |
|
|
270 T *operator& () const; |
|
|
271 |
|
|
272 int i; |
|
|
273 int j; |
|
|
274 |
|
|
275 DiagArray<T> *object; |
|
|
276 |
|
|
277 }; |
|
|
278 |
|
|
279 friend class Proxy; |
|
344
|
280 #endif |
|
319
|
281 |
|
238
|
282 protected: |
|
|
283 |
|
|
284 int nr; |
|
|
285 int nc; |
|
|
286 |
|
|
287 DiagArray (T *d, int r, int c); |
|
|
288 |
|
228
|
289 public: |
|
238
|
290 |
|
228
|
291 DiagArray (void); |
|
238
|
292 DiagArray (int n); |
|
|
293 DiagArray (int n, const T& val); |
|
228
|
294 DiagArray (int r, int c); |
|
238
|
295 DiagArray (int r, int c, const T& val); |
|
228
|
296 DiagArray (const Array<T>& a); |
|
|
297 DiagArray (const DiagArray<T>& a); |
|
|
298 |
|
|
299 DiagArray<T>& operator = (const DiagArray<T>& a); |
|
|
300 |
|
238
|
301 int dim1 (void) const; |
|
|
302 int dim2 (void) const; |
|
|
303 |
|
228
|
304 int rows (void) const; |
|
|
305 int cols (void) const; |
|
|
306 int columns (void) const; |
|
|
307 |
|
344
|
308 #if defined (_AIX) |
|
|
309 T& elem (int r, int c); |
|
|
310 T& checkelem (int r, int c); |
|
|
311 T& operator () (int r, int c); |
|
|
312 #else |
|
319
|
313 Proxy elem (int r, int c) |
|
|
314 { |
|
|
315 return Proxy (this, r, c); |
|
|
316 } |
|
|
317 |
|
|
318 Proxy checkelem (int r, int c) |
|
|
319 { |
|
|
320 if (r < 0 || c < 0 || r >= nr || c >= nc) |
|
|
321 { |
|
|
322 (*current_liboctave_error_handler) ("range error"); |
|
|
323 return Proxy (0, r, c); |
|
|
324 } |
|
|
325 else |
|
|
326 return Proxy (this, r, c); |
|
|
327 } |
|
|
328 |
|
|
329 Proxy operator () (int r, int c) |
|
|
330 { |
|
|
331 if (r < 0 || c < 0 || r >= nr || c >= nc) |
|
|
332 { |
|
|
333 (*current_liboctave_error_handler) ("range error"); |
|
|
334 return Proxy (0, r, c); |
|
|
335 } |
|
|
336 else |
|
|
337 return Proxy (this, r, c); |
|
|
338 } |
|
344
|
339 #endif |
|
228
|
340 |
|
238
|
341 // No checking. |
|
|
342 T& xelem (int r, int c); |
|
|
343 |
|
228
|
344 T elem (int r, int c) const; |
|
|
345 T checkelem (int r, int c) const; |
|
|
346 T operator () (int r, int c) const; |
|
|
347 |
|
238
|
348 void resize (int n, int m); |
|
|
349 void resize (int n, int m, const T& val); |
|
319
|
350 |
|
|
351 private: |
|
|
352 |
|
|
353 T get (int i) { return Array<T>::elem (i); } |
|
|
354 void set (const T& val, int i) { Array<T>::elem (i) = val; } |
|
228
|
355 }; |
|
|
356 |
|
238
|
357 #if defined (__GNUG__) && ! defined (USE_EXTERNAL_TEMPLATES) |
|
228
|
358 #include "Array.cc" |
|
|
359 #endif |
|
|
360 |
|
|
361 #endif |
|
|
362 |
|
|
363 /* |
|
|
364 ;;; Local Variables: *** |
|
|
365 ;;; mode: C++ *** |
|
|
366 ;;; page-delimiter: "^/\\*" *** |
|
|
367 ;;; End: *** |
|
|
368 */ |
