synched with trunk at revision 36569
[blender.git] / intern / smoke / intern / tnt / tnt_fortran_array1d.h
1 /** \file smoke/intern/tnt/tnt_fortran_array1d.h
2  *  \ingroup smoke
3  */
4 /*
5 *
6 * Template Numerical Toolkit (TNT)
7 *
8 * Mathematical and Computational Sciences Division
9 * National Institute of Technology,
10 * Gaithersburg, MD USA
11 *
12 *
13 * This software was developed at the National Institute of Standards and
14 * Technology (NIST) by employees of the Federal Government in the course
15 * of their official duties. Pursuant to title 17 Section 105 of the
16 * United States Code, this software is not subject to copyright protection
17 * and is in the public domain. NIST assumes no responsibility whatsoever for
18 * its use by other parties, and makes no guarantees, expressed or implied,
19 * about its quality, reliability, or any other characteristic.
20 *
21 */
22
23
24
25 #ifndef TNT_FORTRAN_ARRAY1D_H
26 #define TNT_FORTRAN_ARRAY1D_H
27
28 #include <cstdlib>
29 #include <iostream>
30
31 #ifdef TNT_BOUNDS_CHECK
32 #include <assert.h>
33 #endif
34
35
36 #include "tnt_i_refvec.h"
37
38 namespace TNT
39 {
40
41 template <class T>
42 class Fortran_Array1D 
43 {
44
45   private:
46
47     i_refvec<T> v_;
48     int n_;
49     T* data_;                           /* this normally points to v_.begin(), but
50                              * could also point to a portion (subvector)
51                                                          * of v_.
52                             */
53
54     void initialize_(int n);
55     void copy_(T* p, const T*  q, int len) const;
56     void set_(T* begin,  T* end, const T& val);
57  
58
59   public:
60
61     typedef         T   value_type;
62
63
64                  Fortran_Array1D();
65         explicit Fortran_Array1D(int n);
66                  Fortran_Array1D(int n, const T &a);
67                  Fortran_Array1D(int n,  T *a);
68     inline   Fortran_Array1D(const Fortran_Array1D &A);
69         inline   Fortran_Array1D & operator=(const T &a);
70         inline   Fortran_Array1D & operator=(const Fortran_Array1D &A);
71         inline   Fortran_Array1D & ref(const Fortran_Array1D &A);
72                  Fortran_Array1D copy() const;
73                      Fortran_Array1D & inject(const Fortran_Array1D & A);
74         inline   T& operator()(int i);
75         inline   const T& operator()(int i) const;
76         inline   int dim1() const;
77         inline   int dim() const;
78               ~Fortran_Array1D();
79
80
81         /* ... extended interface ... */
82
83         inline int ref_count() const;
84         inline Fortran_Array1D<T> subarray(int i0, int i1);
85
86 };
87
88
89
90
91 template <class T>
92 Fortran_Array1D<T>::Fortran_Array1D() : v_(), n_(0), data_(0) {}
93
94 template <class T>
95 Fortran_Array1D<T>::Fortran_Array1D(const Fortran_Array1D<T> &A) : v_(A.v_),  n_(A.n_), 
96                 data_(A.data_)
97 {
98 #ifdef TNT_DEBUG
99         std::cout << "Created Fortran_Array1D(const Fortran_Array1D<T> &A) \n";
100 #endif
101
102 }
103
104
105 template <class T>
106 Fortran_Array1D<T>::Fortran_Array1D(int n) : v_(n), n_(n), data_(v_.begin())
107 {
108 #ifdef TNT_DEBUG
109         std::cout << "Created Fortran_Array1D(int n) \n";
110 #endif
111 }
112
113 template <class T>
114 Fortran_Array1D<T>::Fortran_Array1D(int n, const T &val) : v_(n), n_(n), data_(v_.begin()) 
115 {
116 #ifdef TNT_DEBUG
117         std::cout << "Created Fortran_Array1D(int n, const T& val) \n";
118 #endif
119         set_(data_, data_+ n, val);
120
121 }
122
123 template <class T>
124 Fortran_Array1D<T>::Fortran_Array1D(int n, T *a) : v_(a), n_(n) , data_(v_.begin())
125 {
126 #ifdef TNT_DEBUG
127         std::cout << "Created Fortran_Array1D(int n, T* a) \n";
128 #endif
129 }
130
131 template <class T>
132 inline T& Fortran_Array1D<T>::operator()(int i) 
133
134 #ifdef TNT_BOUNDS_CHECK
135         assert(i>= 1);
136         assert(i <= n_);
137 #endif
138         return data_[i-1]; 
139 }
140
141 template <class T>
142 inline const T& Fortran_Array1D<T>::operator()(int i) const 
143
144 #ifdef TNT_BOUNDS_CHECK
145         assert(i>= 1);
146         assert(i <= n_);
147 #endif
148         return data_[i-1]; 
149 }
150
151
152         
153
154 template <class T>
155 Fortran_Array1D<T> & Fortran_Array1D<T>::operator=(const T &a)
156 {
157         set_(data_, data_+n_, a);
158         return *this;
159 }
160
161 template <class T>
162 Fortran_Array1D<T> Fortran_Array1D<T>::copy() const
163 {
164         Fortran_Array1D A( n_);
165         copy_(A.data_, data_, n_);
166
167         return A;
168 }
169
170
171 template <class T>
172 Fortran_Array1D<T> & Fortran_Array1D<T>::inject(const Fortran_Array1D &A)
173 {
174         if (A.n_ == n_)
175                 copy_(data_, A.data_, n_);
176
177         return *this;
178 }
179
180
181
182
183
184 template <class T>
185 Fortran_Array1D<T> & Fortran_Array1D<T>::ref(const Fortran_Array1D<T> &A)
186 {
187         if (this != &A)
188         {
189                 v_ = A.v_;              /* operator= handles the reference counting. */
190                 n_ = A.n_;
191                 data_ = A.data_; 
192                 
193         }
194         return *this;
195 }
196
197 template <class T>
198 Fortran_Array1D<T> & Fortran_Array1D<T>::operator=(const Fortran_Array1D<T> &A)
199 {
200         return ref(A);
201 }
202
203 template <class T>
204 inline int Fortran_Array1D<T>::dim1() const { return n_; }
205
206 template <class T>
207 inline int Fortran_Array1D<T>::dim() const { return n_; }
208
209 template <class T>
210 Fortran_Array1D<T>::~Fortran_Array1D() {}
211
212
213 /* ............................ exented interface ......................*/
214
215 template <class T>
216 inline int Fortran_Array1D<T>::ref_count() const
217 {
218         return v_.ref_count();
219 }
220
221 template <class T>
222 inline Fortran_Array1D<T> Fortran_Array1D<T>::subarray(int i0, int i1)
223 {
224 #ifdef TNT_DEBUG
225                 std::cout << "entered subarray. \n";
226 #endif
227         if ((i0 > 0) && (i1 < n_) || (i0 <= i1))
228         {
229                 Fortran_Array1D<T> X(*this);  /* create a new instance of this array. */
230                 X.n_ = i1-i0+1;
231                 X.data_ += i0;
232
233                 return X;
234         }
235         else
236         {
237 #ifdef TNT_DEBUG
238                 std::cout << "subarray:  null return.\n";
239 #endif
240                 return Fortran_Array1D<T>();
241         }
242 }
243
244
245 /* private internal functions */
246
247
248 template <class T>
249 void Fortran_Array1D<T>::set_(T* begin, T* end, const T& a)
250 {
251         for (T* p=begin; p<end; p++)
252                 *p = a;
253
254 }
255
256 template <class T>
257 void Fortran_Array1D<T>::copy_(T* p, const T* q, int len) const
258 {
259         T *end = p + len;
260         while (p<end )
261                 *p++ = *q++;
262
263 }
264
265
266 } /* namespace TNT */
267
268 #endif
269 /* TNT_FORTRAN_ARRAY1D_H */
270