source: Sophya/trunk/SophyaLib/TArray/tarray.h@ 2806

Last change on this file since 2806 was 2589, checked in by ansari, 21 years ago

Correction petite faute de frappe (bug) trouve par compilateur g++ / Reza 30 Juillet 2004
File size: 18.0 KB
Line 
1// This may look like C code, but it is really -*- C++ -*-
2// template array class for numerical types
3// R. Ansari, C.Magneville 03/2000
4
5#ifndef TArray_SEEN
6#define TArray_SEEN
7
8#include "machdefs.h"
9#include <math.h>
10#include <iostream>
11#include "basarr.h"
12#include "ndatablock.h"
13#include <complex>
14#include "utilarr.h"
15
16
17namespace SOPHYA {
18
19// Forward declaration
20template <class T> class FIO_TArray;
21
22// --------------------------- classe template Array -----------------------
23// ( See BaseArray class for data organisation in memory and related methods )
24
25//! Class for template arrays
26template <class T>
27class TArray : public BaseArray {
28public:
29 // Creation / destruction
30 TArray();
31 TArray(int_4 ndim, const sa_size_t * siz, sa_size_t step =1, bool fzero=true);
32 TArray(sa_size_t nx, sa_size_t ny=0, sa_size_t nz=0, sa_size_t nt=0, sa_size_t nu=0, bool fzero=true);
33 TArray(int_4 ndim, const sa_size_t * siz, NDataBlock<T> & db, bool share=false, sa_size_t step=1, sa_size_t offset=0);
34 TArray(int_4 ndim, const sa_size_t * siz, T* values, sa_size_t step=1, sa_size_t offset=0, Bridge* br=NULL);
35 TArray(const TArray<T>& a);
36 TArray(const TArray<T>& a, bool share);
37 TArray(const BaseArray& a);
38
39 virtual ~TArray();
40
41 // A = B
42 //! = operator between TArray
43 /*! \warning Datas are copied (cloned) from \b a.
44 \sa Set \sa NDataBlock::operator=(const NDataBlock<T>&) */
45 inline TArray<T>& operator = (const TArray<T>& a) { return Set(a); }
46 virtual TArray<T>& Set(const TArray<T>& a);
47
48 //! = operator between TArray 's with different types - Elements are converted.
49 inline TArray<T>& operator = (const BaseArray& a) { return SetBA(a); }
50 virtual TArray<T>& SetBA(const BaseArray& a);
51
52 // Gestion taille/Remplissage
53 virtual void Clone(const TArray<T>& a);
54 // partage les donnees si "a" temporaire, clone sinon.
55 void CloneOrShare(const TArray<T>& a);
56 // Share: partage les donnees de "a"
57 void Share(const TArray<T>& a);
58
59 void ReSize(int_4 ndim, sa_size_t * siz, sa_size_t step=1, bool fzero=true);
60 void ReSize(const BaseArray& a, bool pack=false, bool fzero=true);
61 //! a synonym (alias) for method ReSize(int_4, ...)
62 inline void SetSize(int_4 ndim, sa_size_t * siz, sa_size_t step=1, bool fzero=true)
63 { ReSize(ndim, siz, step, fzero); }
64 //! a synonym (alias) for method ReSize(const BaseArray&)
65 inline void SetSize(const BaseArray& a, bool pack=false, bool fzero=true)
66 { ReSize(a, pack, fzero); }
67 void Realloc(int_4 ndim, sa_size_t * siz, sa_size_t step=1, bool force=false);
68
69 // Compacts size=1 array dimensions
70 virtual TArray<T>& CompactAllDimensions();
71 virtual TArray<T>& CompactTrailingDimensions();
72
73 // Packing array elements in memory
74 virtual TArray<T> PackElements(bool force=false) const ;
75
76 // SubArrays - $CHECK$ Reza 03/2000 je ne sais pas s'il faut declarer ca const ??
77 TArray<T> SubArray(Range rx, Range ry, Range rz, Range rt, Range ru) const ;
78
79 //! () operator for Sub arrays extraction
80 /*! \sa SubArray */
81 inline TArray<T> operator () (Range rx, Range ry, Range rz) const
82 { return SubArray(rx, ry, rz, Range(0), Range(0)); }
83 inline TArray<T> operator () (Range rx, Range ry, Range rz, Range rt) const
84 { return SubArray(rx, ry, rz, rt, Range(0)); }
85 inline TArray<T> operator () (Range rx, Range ry, Range rz, Range rt, Range ru) const
86 { return SubArray(rx, ry, rz, rt, ru); }
87
88 // ---- Access to data
89 // Definition of virtual element acces method inherited from BaseArray class
90 virtual MuTyV & ValueAtPosition(sa_size_t ip) const;
91
92 // Data Access: operator overloaded inline acces methods
93 inline T const& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz) const ;
94 inline T& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz);
95 inline T const& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu=0) const ;
96 inline T& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu=0);
97 inline T const& operator[](sa_size_t ip) const ;
98 inline T& operator[](sa_size_t ip);
99
100 inline T const& Elem(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it=0, sa_size_t iu=0) const ;
101 inline T& Elem(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it=0, sa_size_t iu=0);
102 inline T const& ElemCheckBound(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it=0, sa_size_t iu=0) const ;
103 inline T& ElemCheckBound(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it=0, sa_size_t iu=0);
104
105 //! Return pointer to first element adress
106 inline T* Data() {return mNDBlock.Begin()+offset_;}
107 //! Return pointer to first element adress
108 inline const T* Data() const {return mNDBlock.Begin()+offset_;}
109 //! Return reference to datablock NDataBlock
110 inline NDataBlock<T>& DataBlock() {return mNDBlock;}
111 //! Return reference to datablock NDataBlock
112 inline const NDataBlock<T>& DataBlock() const {return mNDBlock;}
113
114 // Temporaire?
115 //! Are the array temporay ?
116 inline bool IsTemp(void) const {return mNDBlock.IsTemp();}
117 //! Set the array as temporay
118 inline void SetTemp(bool temp=false) const {mNDBlock.SetTemp(temp);}
119
120// Operations diverses = , +=, ...
121// Conversion en type T, if Size() == 1
122 inline T toScalar();
123// Met les elements a une suite de valeurs
124 virtual TArray<T>& SetSeq(Sequence const & seq);
125 //! Fill TArray with Sequence \b seq
126 inline TArray<T>& operator = (Sequence const & seq) { return SetSeq(seq); }
127
128// A = x (tous les elements a x)
129 virtual TArray<T>& SetCst(T x);
130 //! Fill an array with a constant value \b x ( alias for \b SetCst() method )
131 inline TArray<T>& SetT(T x) { return SetCst(x); }
132 //! Fill TArray with all elements equal to \b x
133 inline TArray<T>& operator = (T x) { return SetT(x); }
134
135// addition et soustraction de constante
136 virtual TArray<T>& AddCst(T x, TArray<T>& res) const ;
137 virtual TArray<T>& SubCst(T x, TArray<T>& res, bool fginv=false) const ;
138// Multiplication et division par une constante
139 virtual TArray<T>& MulCst(T x, TArray<T>& res) const ;
140 virtual TArray<T>& DivCst(T x, TArray<T>& res, bool fginv=false) const ;
141
142// A += -= *= /= x (ajoute, soustrait, ... x a tous les elements)
143 // Methodes Add/Sub/Mul/Div() sont la pour compatibilite avant V=2 (1.818)
144 // Faut-il les garder ? Reza, Juillet 2004
145 inline TArray<T>& Add(T x) { return AddCst(x, *this); }
146 inline TArray<T>& Sub(T x, bool fginv=false) { return SubCst(x, *this, fginv); }
147 inline TArray<T>& Mul(T x) { return MulCst(x, *this); }
148 inline TArray<T>& Div(T x, bool fginv=false) { return DivCst(x, *this, fginv); }
149
150 //! Add \b x to all elements
151 inline TArray<T>& operator += (T x) { return AddCst(x, *this); }
152 //! Substract \b x to all elements
153 inline TArray<T>& operator -= (T x) { return SubCst(x, *this); }
154 //! Multiply all elements by \b x
155 inline TArray<T>& operator *= (T x) { return MulCst(x, *this); }
156 //! Divide all elements by \b x
157 inline TArray<T>& operator /= (T x) { return DivCst(x, *this); }
158
159// applique le signe moins a tous les elements
160 virtual TArray<T>& NegateElt(TArray<T>& res) const ;
161//! Replace array elements values by their opposite ( (*this)(i) -> -(*this)(i) )
162 inline TArray<T>& NegateElt() { return NegateElt(*this); }
163
164// A += -= (ajoute, soustrait element par element les deux tableaux )
165 virtual TArray<T>& AddElt(const TArray<T>& a, TArray<T>& res) const ;
166 virtual TArray<T>& SubElt(const TArray<T>& a, TArray<T>& res, bool fginv=false) const ;
167// Multiplication, division element par element les deux tableaux
168 virtual TArray<T>& MulElt(const TArray<T>& a, TArray<T>& res) const ;
169 virtual TArray<T>& DivElt(const TArray<T>& a, TArray<T>& res, bool fginv=false, bool divzero=false) const ;
170
171 //! Operator TArray += TArray (element by element addition in place)
172 inline TArray<T>& operator += (const TArray<T>& a) { return AddElt(a, *this); }
173 //! Operator TArray -= TArray (element by element subtraction in place)
174 inline TArray<T>& operator -= (const TArray<T>& a) { return SubElt(a, *this); }
175
176 // Doit-on definir les operateur *= /= TArray ? Reza, Juillet 2004
177 //! Element by element multiplication in place TArray *= TArray (element by element)
178 inline TArray<T>& Mul(const TArray<T>& a) { return MulElt(a, *this); }
179 //! Element by element division in place TArray *= TArray (element by element)
180 inline TArray<T>& Div(const TArray<T>& a, bool divzero=false)
181 { return DivElt(a, *this, false, divzero); }
182
183// Recopie des valeurs, element par element
184 virtual TArray<T>& CopyElt(const TArray<T>& a);
185// Recopie des valeurs avec conversion prealable, element par element
186 virtual TArray<T>& ConvertAndCopyElt(const BaseArray& a);
187
188// Calcul du produit scalaire ( Somme_i (*this)(i)*a(i) )
189 virtual T ScalarProduct(const TArray<T>& a) const ;
190// Norme(^2)
191 //! Returns the squarred of the array norm, defined as Sum_k (*this)(k)*(*this)(k)
192 inline T Norm2() const { return ScalarProduct(*this); }
193
194// Somme et produit des elements
195 virtual T Sum() const ;
196 virtual T Product() const ;
197// Somme du carre des elements
198 virtual T SumX2() const;
199// Valeur min et max des elements
200 virtual void MinMax(T& min, T& max) const ;
201
202// Impression, I/O, ...
203 virtual string InfoString() const;
204 virtual void Print(ostream& os, sa_size_t maxprt=-1,
205 bool si=false, bool ascd=false) const ;
206
207// Lecture,Ecriture sur fichier ASCII
208 virtual sa_size_t ReadASCII(istream& is, sa_size_t & nr, sa_size_t & nc,
209 char clm='#', const char* sep=" \t");
210 virtual void WriteASCII(ostream& os) const;
211
212// Pour la gestion de persistance
213 friend class FIO_TArray<T>;
214
215protected:
216
217 NDataBlock<T> mNDBlock; //!< Block for datas
218 mutable MuTyV my_mtv; //!< for use by ValueAtPosition()
219};
220
221////////////////////////////////////////////////////////////////
222// Surcharge d'operateur <<
223//! Print TArray \b a on stream \b os
224template <class T>
225inline ostream& operator << (ostream& os, const TArray<T>& a)
226 { a.Print(os); return(os); }
227
228// Surcharge d'operateur >>
229//! Decodes the ASCII input stream \b is , filling TArray \b a elements
230template <class T>
231inline istream& operator >> (istream& is, TArray<T>& a)
232 { sa_size_t nr, nc;
233 a.ReadASCII(is, nr, nc); return(is); }
234
235
236////////////////////////////////////////////////////////////////
237// Surcharge d'operateurs A (+,-,*,/) (T) x
238
239/*! \ingroup TArray \fn operator+(const TArray<T>&,T)
240 \brief Operator TArray = TArray + constant */
241template <class T> inline TArray<T> operator + (const TArray<T>& a, T b)
242 {TArray<T> result; result.SetTemp(true);
243 a.AddCst(b, result); return result;}
244
245/*! \ingroup TArray \fn operator+(T,const TArray<T>&)
246 \brief Operator TArray = constant + TArray */
247template <class T> inline TArray<T> operator + (T b,const TArray<T>& a)
248 {TArray<T> result; result.SetTemp(true);
249 a.AddCst(b, result); return result;}
250
251/*! \ingroup TArray \fn operator-(const TArray<T>&,T)
252 \brief Operator TArray = TArray - constant */
253template <class T> inline TArray<T> operator - (const TArray<T>& a, T b)
254 {TArray<T> result; result.SetTemp(true);
255 a.SubCst(b,result); return result;}
256
257/*! \ingroup TArray \fn operator-(T,const TArray<T>&)
258 \brief Operator TArray = constant - TArray */
259template <class T> inline TArray<T> operator - (T b,const TArray<T>& a)
260 {TArray<T> result; result.SetTemp(true);
261 a.SubCst(b,result,true); return result;}
262
263/*! \ingroup TArray \fn operator*(const TArray<T>&,T)
264 \brief Operator TArray = TArray * constant */
265template <class T> inline TArray<T> operator * (const TArray<T>& a, T b)
266 {TArray<T> result; result.SetTemp(true);
267 a.MulCst(b, result); return result;}
268
269/*! \ingroup TArray \fn operator*(T,const TArray<T>&)
270 \brief Operator TArray = constant * TArray */
271template <class T> inline TArray<T> operator * (T b,const TArray<T>& a)
272 {TArray<T> result; result.SetTemp(true);
273 a.MulCst(b,result); return result;}
274
275/*! \ingroup TArray \fn operator/(const TArray<T>&,T)
276 \brief Operator TArray = TArray / constant */
277template <class T> inline TArray<T> operator / (const TArray<T>& a, T b)
278 {TArray<T> result; result.SetTemp(true);
279 a.DivCst(b,result); return result;}
280
281/*! \ingroup TArray \fn operator/(T,const TArray<T>&)
282 \brief Operator TArray = constant / TArray */
283template <class T> inline TArray<T> operator / (T b, const TArray<T>& a)
284 {TArray<T> result; result.SetTemp(true);
285 a.DivCst(b, result, true); return result;}
286
287////////////////////////////////////////////////////////////////
288// Surcharge d'operateurs B = -A
289
290/*! \ingroup TArray \fn operator - (const TArray<T>&)
291 \brief Operator - Returns an array with elements equal to the opposite of
292 the original array elements. */
293template <class T> inline TArray<T> operator - (const TArray<T>& a)
294 {TArray<T> result; result.SetTemp(true);
295 a.NegateElt(result); return result;}
296
297////////////////////////////////////////////////////////////////
298// Surcharge d'operateurs C = A (+,-) B
299
300/*! \ingroup TArray \fn operator+(const TArray<T>&,const TArray<T>&)
301 \brief Operator TArray = TArray + TArray (element by element addition) */
302template <class T>
303inline TArray<T> operator + (const TArray<T>& a,const TArray<T>& b)
304 { TArray<T> result; result.SetTemp(true);
305 a.AddElt(b, result); return result; }
306
307/*! \ingroup TArray \fn operator-(const TArray<T>&,const TArray<T>&)
308 \brief Operator TArray = TArray - TArray (element by element subtraction) */
309template <class T>
310inline TArray<T> operator - (const TArray<T>& a,const TArray<T>& b)
311 { TArray<T> result; result.SetTemp(true);
312 a.SubElt(b, result); return result; }
313
314/*! \ingroup TArray \fn MultiplyElt((const TArray<T>&,const TArray<T>&)
315 \brief Element by element multiplication of two arrays TArray = TArray * TArray */
316
317template <class T>
318inline TArray<T> MultiplyElt(const TArray<T>& a,const TArray<T>& b)
319 { TArray<T> result; result.SetTemp(true);
320 a.MulElt(b, result); return result; }
321
322/*! \ingroup TArray \fn DivideElt((const TArray<T>&,const TArray<T>&)
323 \brief Element by element division of two arrays TArray = TArray * TArray */
324template <class T>
325inline TArray<T> DivideElt(const TArray<T>& a,const TArray<T>& b, bool divzero=false)
326 { TArray<T> result; result.SetTemp(true);
327 a.DivElt(b, result, false, divzero); return result; }
328
329// --------------------------------------------------
330// inline element acces methods
331// --------------------------------------------------
332
333//! Return element (ix,iy,iz,it,iu) value
334template <class T>
335inline T const& TArray<T>::Elem(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu) const
336{
337 return ( *( mNDBlock.Begin()+ offset_+
338 ix*step_[0] + iy*step_[1] + iz*step_[2] +
339 it*step_[3] + iu*step_[4]) );
340}
341
342//! Return element (ix,iy,iz,it,iu) value
343template <class T>
344inline T & TArray<T>::Elem(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
345{
346 return ( *( mNDBlock.Begin()+ offset_+
347 ix*step_[0] + iy*step_[1] + iz*step_[2] +
348 it*step_[3] + iu*step_[4]) );
349}
350
351//! Return element (ix,iy,iz,it,iu) value with Check of indexes bound first
352template <class T>
353inline T const& TArray<T>::ElemCheckBound(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu) const
354{
355 CheckBound(ix, iy, iz, it, iu, 4);
356 return(Elem(ix, iy, iz, it, iu));
357}
358
359//! Return element (ix,iy,iz,it,iu) value with Check of indexes bound first
360template <class T>
361inline T & TArray<T>::ElemCheckBound(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
362{
363 CheckBound(ix, iy, iz, it, iu, 4);
364 return(Elem(ix, iy, iz, it, iu));
365}
366
367//! Return element (ix,iy,iz) value
368template <class T>
369inline T const& TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz) const
370{
371#ifdef SO_BOUNDCHECKING
372 CheckBound(ix, iy, iz, 0, 0, 4);
373#endif
374 return ( *( mNDBlock.Begin()+ offset_+
375 ix*step_[0] + iy*step_[1] + iz*step_[2]) );
376}
377
378//! Return element (ix,iy,iz) value
379template <class T>
380inline T & TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz)
381{
382#ifdef SO_BOUNDCHECKING
383 CheckBound(ix, iy, iz, 0, 0, 4);
384#endif
385 return ( *( mNDBlock.Begin()+ offset_+
386 ix*step_[0] + iy*step_[1] + iz*step_[2]) );
387}
388
389//! Operator () : return element (ix,iy,iz,it,iu) value
390template <class T>
391inline T const& TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu) const
392{
393#ifdef SO_BOUNDCHECKING
394 CheckBound(ix, iy, iz, it, iu, 4);
395#endif
396 return ( *( mNDBlock.Begin()+ offset_+
397 ix*step_[0] + iy*step_[1] + iz*step_[2] +
398 it*step_[3] + iu*step_[4]) );
399}
400
401//! Operator () : return element (ix,iy,iz,it,iu) value
402template <class T>
403inline T & TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
404{
405#ifdef SO_BOUNDCHECKING
406 CheckBound(ix, iy, iz, it, iu, 4);
407#endif
408 return ( *( mNDBlock.Begin()+ offset_+
409 ix*step_[0] + iy*step_[1] + iz*step_[2] +
410 it*step_[3] + iu*step_[4]) );
411}
412
413
414//! Operator [] : return element at positon ip
415template <class T>
416inline T const& TArray<T>::operator[](sa_size_t ip) const
417{
418#ifdef SO_BOUNDCHECKING
419 if (ip >= totsize_) throw( ParmError("TArray<T>::operator[] Out-of-bound Error") );
420#endif
421return *(mNDBlock.Begin()+Offset(ip));
422}
423
424//! Operator [] : return element at positon ip
425template <class T>
426inline T & TArray<T>::operator[](sa_size_t ip)
427{
428#ifdef SO_BOUNDCHECKING
429 if (ip >= totsize_) throw( ParmError("TArray<T>::operator[] Out-of-bound Error") );
430#endif
431return *(mNDBlock.Begin()+Offset(ip));
432}
433
434
435//! Converts to a scalar (value of first element) if the array size is equal to 1
436template <class T>
437inline T TArray<T>::toScalar()
438{
439 if (Size() != 1) throw(SzMismatchError("TArray<T>::operator T() Size() != 1")) ;
440 return ( (*this)[0] );
441}
442
443// Typedef pour simplifier
444/*! \ingroup TArray
445 \typedef Array
446 \brief To simplified TArray<r_8> writing
447*/
448typedef TArray<r_8> Array;
449
450} // Fin du namespace
451
452#endif
Note: See TracBrowser for help on using the repository browser.