Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / smoke / intern / tnt / tnt_array3d.h
1 /** \file \ingroup smoke
2  */
3 /*
4 *
5 * Template Numerical Toolkit (TNT)
6 *
7 * Mathematical and Computational Sciences Division
8 * National Institute of Technology,
9 * Gaithersburg, MD USA
10 *
11 *
12 * This software was developed at the National Institute of Standards and
13 * Technology (NIST) by employees of the Federal Government in the course
14 * of their official duties. Pursuant to title 17 Section 105 of the
15 * United States Code, this software is not subject to copyright protection
16 * and is in the public domain. NIST assumes no responsibility whatsoever for
17 * its use by other parties, and makes no guarantees, expressed or implied,
18 * about its quality, reliability, or any other characteristic.
19 *
20 */
21
22
23
24 #ifndef TNT_ARRAY3D_H
25 #define TNT_ARRAY3D_H
26
27 #include <cstdlib>
28 #include <iostream>
29 #ifdef TNT_BOUNDS_CHECK
30 #include <assert.h>
31 #endif
32
33 #include "tnt_array1d.h"
34 #include "tnt_array2d.h"
35
36 namespace TNT
37 {
38
39 template <class T>
40 class Array3D 
41 {
42
43
44   private:
45         Array1D<T> data_;
46         Array2D<T*> v_;
47         int m_;
48     int n_;
49         int g_;
50
51
52   public:
53
54     typedef         T   value_type;
55
56                Array3D();
57                Array3D(int m, int n, int g);
58                Array3D(int m, int n, int g,  T val);
59                Array3D(int m, int n, int g, T *a);
60
61         inline operator T***();
62         inline operator const T***();
63     inline Array3D(const Array3D &A);
64         inline Array3D & operator=(const T &a);
65         inline Array3D & operator=(const Array3D &A);
66         inline Array3D & ref(const Array3D &A);
67                Array3D copy() const;
68                    Array3D & inject(const Array3D & A);
69
70         inline T** operator[](int i);
71         inline const T* const * operator[](int i) const;
72         inline int dim1() const;
73         inline int dim2() const;
74         inline int dim3() const;
75                ~Array3D();
76
77         /* extended interface */
78
79         inline int ref_count(){ return data_.ref_count(); }
80    Array3D subarray(int i0, int i1, int j0, int j1, 
81                                 int k0, int k1);
82 };
83
84 template <class T>
85 Array3D<T>::Array3D() : data_(), v_(), m_(0), n_(0) {}
86
87 template <class T>
88 Array3D<T>::Array3D(const Array3D<T> &A) : data_(A.data_), 
89         v_(A.v_), m_(A.m_), n_(A.n_), g_(A.g_)
90 {
91 }
92
93
94
95 template <class T>
96 Array3D<T>::Array3D(int m, int n, int g) : data_(m*n*g), v_(m,n),
97         m_(m), n_(n), g_(g)
98 {
99
100   if (m>0 && n>0 && g>0)
101   {
102         T* p = & (data_[0]);
103         int ng = n_*g_;
104
105         for (int i=0; i<m_; i++)
106         {       
107                 T* ping = p+ i*ng;
108                 for (int j=0; j<n; j++)
109                         v_[i][j] = ping + j*g_;
110         }
111   }
112 }
113
114
115
116 template <class T>
117 Array3D<T>::Array3D(int m, int n, int g, T val) : data_(m*n*g, val), 
118         v_(m,n), m_(m), n_(n), g_(g)
119 {
120   if (m>0 && n>0 && g>0)
121   {
122
123         T* p = & (data_[0]);
124         int ng = n_*g_;
125
126         for (int i=0; i<m_; i++)
127         {       
128                 T* ping = p+ i*ng;
129                 for (int j=0; j<n; j++)
130                         v_[i][j] = ping + j*g_;
131         }
132   }
133 }
134
135
136
137 template <class T>
138 Array3D<T>::Array3D(int m, int n, int g, T* a) : 
139                 data_(m*n*g, a), v_(m,n), m_(m), n_(n), g_(g)
140 {
141
142   if (m>0 && n>0 && g>0)
143   {
144         T* p = & (data_[0]);
145         int ng = n_*g_;
146
147         for (int i=0; i<m_; i++)
148         {       
149                 T* ping = p+ i*ng;
150                 for (int j=0; j<n; j++)
151                         v_[i][j] = ping + j*g_;
152         }
153   }
154 }
155
156
157
158 template <class T>
159 inline T** Array3D<T>::operator[](int i) 
160
161 #ifdef TNT_BOUNDS_CHECK
162         assert(i >= 0);
163         assert(i < m_);
164 #endif
165
166 return v_[i]; 
167
168 }
169
170 template <class T>
171 inline const T* const * Array3D<T>::operator[](int i) const 
172 { return v_[i]; }
173
174 template <class T>
175 Array3D<T> & Array3D<T>::operator=(const T &a)
176 {
177         for (int i=0; i<m_; i++)
178                 for (int j=0; j<n_; j++)
179                         for (int k=0; k<g_; k++)
180                                 v_[i][j][k] = a;
181
182         return *this;
183 }
184
185 template <class T>
186 Array3D<T> Array3D<T>::copy() const
187 {
188         Array3D A(m_, n_, g_);
189         for (int i=0; i<m_; i++)
190                 for (int j=0; j<n_; j++)
191                         for (int k=0; k<g_; k++)
192                                 A.v_[i][j][k] = v_[i][j][k];
193
194         return A;
195 }
196
197
198 template <class T>
199 Array3D<T> & Array3D<T>::inject(const Array3D &A)
200 {
201         if (A.m_ == m_ &&  A.n_ == n_ && A.g_ == g_)
202
203         for (int i=0; i<m_; i++)
204                 for (int j=0; j<n_; j++)
205                         for (int k=0; k<g_; k++)
206                                 v_[i][j][k] = A.v_[i][j][k];
207
208         return *this;
209 }
210
211
212
213 template <class T>
214 Array3D<T> & Array3D<T>::ref(const Array3D<T> &A)
215 {
216         if (this != &A)
217         {
218                 m_ = A.m_;
219                 n_ = A.n_;
220                 g_ = A.g_;
221                 v_ = A.v_;
222                 data_ = A.data_;
223         }
224         return *this;
225 }
226
227 template <class T>
228 Array3D<T> & Array3D<T>::operator=(const Array3D<T> &A)
229 {
230         return ref(A);
231 }
232
233
234 template <class T>
235 inline int Array3D<T>::dim1() const { return m_; }
236
237 template <class T>
238 inline int Array3D<T>::dim2() const { return n_; }
239
240 template <class T>
241 inline int Array3D<T>::dim3() const { return g_; }
242
243
244
245 template <class T>
246 Array3D<T>::~Array3D() {}
247
248 template <class T>
249 inline Array3D<T>::operator T***()
250 {
251         return v_;
252 }
253
254
255 template <class T>
256 inline Array3D<T>::operator const T***()
257 {
258         return v_;
259 }
260
261 /* extended interface */
262 template <class T>
263 Array3D<T> Array3D<T>::subarray(int i0, int i1, int j0,
264         int j1, int k0, int k1)
265 {
266
267         /* check that ranges are valid. */
268         if (!( 0 <= i0 && i0 <= i1 && i1 < m_ &&
269               0 <= j0 && j0 <= j1 && j1 < n_ &&
270               0 <= k0 && k0 <= k1 && k1 < g_))
271                 return Array3D<T>();  /* null array */
272
273
274         Array3D<T> A;
275         A.data_ = data_;
276         A.m_ = i1-i0+1;
277         A.n_ = j1-j0+1;
278         A.g_ = k1-k0+1;
279         A.v_ = Array2D<T*>(A.m_,A.n_);
280         T* p = &(data_[0]) + i0*n_*g_ + j0*g_ + k0; 
281
282         for (int i=0; i<A.m_; i++)
283         {
284                 T* ping = p + i*n_*g_;
285                 for (int j=0; j<A.n_; j++)
286                         A.v_[i][j] = ping + j*g_ ;
287         }
288
289         return A;
290 }
291         
292
293
294 } /* namespace TNT */
295
296 #endif
297 /* TNT_ARRAY3D_H */
298