doxygen: add newline after \file
[blender.git] / intern / smoke / intern / tnt / tnt_fortran_array2d.h
1 /** \file
2  * \ingroup smoke
3  */
4 /*
5 *
6 * Template Numerical Toolkit (TNT): Two-dimensional Fortran numerical array
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_ARRAY2D_H
26 #define TNT_FORTRAN_ARRAY2D_H
27
28 #include <cstdlib>
29 #include <iostream>
30
31 #ifdef TNT_BOUNDS_CHECK
32 #include <assert.h>
33 #endif
34
35 #include "tnt_i_refvec.h"
36
37 namespace TNT
38 {
39
40 template <class T>
41 class Fortran_Array2D 
42 {
43
44
45   private: 
46                 i_refvec<T> v_;
47                 int m_;
48                 int n_;
49                 T* data_;
50
51
52         void initialize_(int n);
53         void copy_(T* p, const T*  q, int len);
54         void set_(T* begin,  T* end, const T& val);
55  
56   public:
57
58     typedef         T   value_type;
59
60                Fortran_Array2D();
61                Fortran_Array2D(int m, int n);
62                Fortran_Array2D(int m, int n,  T *a);
63                Fortran_Array2D(int m, int n, const T &a);
64     inline Fortran_Array2D(const Fortran_Array2D &A);
65         inline Fortran_Array2D & operator=(const T &a);
66         inline Fortran_Array2D & operator=(const Fortran_Array2D &A);
67         inline Fortran_Array2D & ref(const Fortran_Array2D &A);
68                Fortran_Array2D copy() const;
69                    Fortran_Array2D & inject(const Fortran_Array2D & A);
70         inline T& operator()(int i, int j);
71         inline const T& operator()(int i, int j) const ;
72         inline int dim1() const;
73         inline int dim2() const;
74                ~Fortran_Array2D();
75
76         /* extended interface */
77
78         inline int ref_count() const;
79
80 };
81
82 template <class T>
83 Fortran_Array2D<T>::Fortran_Array2D() : v_(), m_(0), n_(0), data_(0) {}
84
85
86 template <class T>
87 Fortran_Array2D<T>::Fortran_Array2D(const Fortran_Array2D<T> &A) : v_(A.v_),
88                 m_(A.m_), n_(A.n_), data_(A.data_) {}
89
90
91
92 template <class T>
93 Fortran_Array2D<T>::Fortran_Array2D(int m, int n) : v_(m*n), m_(m), n_(n),
94         data_(v_.begin()) {}
95
96 template <class T>
97 Fortran_Array2D<T>::Fortran_Array2D(int m, int n, const T &val) : 
98         v_(m*n), m_(m), n_(n), data_(v_.begin())
99 {
100         set_(data_, data_+m*n, val);
101 }
102
103
104 template <class T>
105 Fortran_Array2D<T>::Fortran_Array2D(int m, int n, T *a) : v_(a),
106         m_(m), n_(n), data_(v_.begin()) {}
107
108
109
110
111 template <class T>
112 inline T& Fortran_Array2D<T>::operator()(int i, int j) 
113
114 #ifdef TNT_BOUNDS_CHECK
115         assert(i >= 1);
116         assert(i <= m_);
117         assert(j >= 1);
118         assert(j <= n_);
119 #endif
120
121         return v_[ (j-1)*m_ + (i-1) ];
122
123 }
124
125 template <class T>
126 inline const T& Fortran_Array2D<T>::operator()(int i, int j) const
127
128 #ifdef TNT_BOUNDS_CHECK
129         assert(i >= 1);
130         assert(i <= m_);
131         assert(j >= 1);
132         assert(j <= n_);
133 #endif
134
135         return v_[ (j-1)*m_ + (i-1) ];
136
137 }
138
139
140 template <class T>
141 Fortran_Array2D<T> & Fortran_Array2D<T>::operator=(const T &a)
142 {
143         set_(data_, data_+m_*n_, a);
144         return *this;
145 }
146
147 template <class T>
148 Fortran_Array2D<T> Fortran_Array2D<T>::copy() const
149 {
150
151         Fortran_Array2D B(m_,n_);
152         
153         B.inject(*this);
154         return B;
155 }
156
157
158 template <class T>
159 Fortran_Array2D<T> & Fortran_Array2D<T>::inject(const Fortran_Array2D &A)
160 {
161         if (m_ == A.m_ && n_ == A.n_)
162                 copy_(data_, A.data_, m_*n_);
163
164         return *this;
165 }
166
167
168
169 template <class T>
170 Fortran_Array2D<T> & Fortran_Array2D<T>::ref(const Fortran_Array2D<T> &A)
171 {
172         if (this != &A)
173         {
174                 v_ = A.v_;
175                 m_ = A.m_;
176                 n_ = A.n_;
177                 data_ = A.data_;
178         }
179         return *this;
180 }
181
182 template <class T>
183 Fortran_Array2D<T> & Fortran_Array2D<T>::operator=(const Fortran_Array2D<T> &A)
184 {
185         return ref(A);
186 }
187
188 template <class T>
189 inline int Fortran_Array2D<T>::dim1() const { return m_; }
190
191 template <class T>
192 inline int Fortran_Array2D<T>::dim2() const { return n_; }
193
194
195 template <class T>
196 Fortran_Array2D<T>::~Fortran_Array2D()
197 {
198 }
199
200 template <class T>
201 inline int Fortran_Array2D<T>::ref_count() const { return v_.ref_count(); }
202
203
204
205
206 template <class T>
207 void Fortran_Array2D<T>::set_(T* begin, T* end, const T& a)
208 {
209         for (T* p=begin; p<end; p++)
210                 *p = a;
211
212 }
213
214 template <class T>
215 void Fortran_Array2D<T>::copy_(T* p, const T* q, int len) 
216 {
217         T *end = p + len;
218         while (p<end )
219                 *p++ = *q++;
220
221 }
222
223
224 } /* namespace TNT */
225
226 #endif
227 /* TNT_FORTRAN_ARRAY2D_H */
228