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

Last change on this file since 3175 was 3173, checked in by ansari, 19 years ago

Ajout methodes TArray::ZeroSize() RenewObjId() - Reza 05/02/2007
File size: 18.5 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 //! To clear the array sizes - corresponding to an unallocated array.
70 virtual TArray<T>& ZeroSize();
71
72 // Compacts size=1 array dimensions
73 virtual TArray<T>& CompactAllDimensions();
74 virtual TArray<T>& CompactTrailingDimensions();
75
76 // Packing array elements in memory
77 virtual TArray<T> PackElements(bool force=false) const ;
78
79 // SubArrays - $CHECK$ Reza 03/2000 je ne sais pas s'il faut declarer ca const ??
80 TArray<T> SubArray(Range rx, Range ry, Range rz, Range rt, Range ru, bool compact=true) const ;
81
82 //! Extract the first 3D subarray specified by rx, ry, rz. (see SubArray() )
83 inline TArray<T> operator () (Range rx, Range ry, Range rz) const
84 { return SubArray(rx, ry, rz, Range::first(), Range::first()); }
85 //! Extract the first 4D subarray specified by rx, ry, rz. (see SubArray() )
86 inline TArray<T> operator () (Range rx, Range ry, Range rz, Range rt) const
87 { return SubArray(rx, ry, rz, rt, Range::first()); }
88 //! Extract the subarray specified by rx, ry, rz. (see SubArray() )
89 inline TArray<T> operator () (Range rx, Range ry, Range rz, Range rt, Range ru) const
90 { return SubArray(rx, ry, rz, rt, ru); }
91
92 // ---- Access to data
93 // Definition of virtual element acces method inherited from BaseArray class
94 virtual MuTyV & ValueAtPosition(sa_size_t ip) const;
95 virtual MuTyV & ValueAtPositionDB(sa_size_t ip) const;
96
97 // Data Access: operator overloaded inline acces methods
98 inline T const& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz) const ;
99 inline T& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz);
100 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 ;
101 inline T& operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu=0);
102 inline T const& operator[](sa_size_t ip) const ;
103 inline T& operator[](sa_size_t ip);
104
105 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 ;
106 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);
107 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 ;
108 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);
109
110 //! Return pointer to first element adress
111 inline T* Data() {return mNDBlock.Begin()+offset_;}
112 //! Return pointer to first element adress
113 inline const T* Data() const {return mNDBlock.Begin()+offset_;}
114 //! Return reference to datablock NDataBlock
115 inline NDataBlock<T>& DataBlock() {return mNDBlock;}
116 //! Return reference to datablock NDataBlock
117 inline const NDataBlock<T>& DataBlock() const {return mNDBlock;}
118
119 // Temporaire?
120 //! Are the array temporay ?
121 inline bool IsTemp(void) const {return mNDBlock.IsTemp();}
122 //! Set the array as temporay
123 inline void SetTemp(bool temp=false) const {mNDBlock.SetTemp(temp);}
124
125// Operations diverses = , +=, ...
126// Conversion en type T, if Size() == 1
127 inline T toScalar();
128// Met les elements a une suite de valeurs
129 virtual TArray<T>& SetSeq(Sequence const & seq);
130 //! Fill TArray with Sequence \b seq
131 inline TArray<T>& operator = (Sequence const & seq) { return SetSeq(seq); }
132
133// A = x (tous les elements a x)
134 virtual TArray<T>& SetCst(T x);
135 //! Fill an array with a constant value \b x ( alias for \b SetCst() method )
136 inline TArray<T>& SetT(T x) { return SetCst(x); }
137 //! Fill TArray with all elements equal to \b x
138 inline TArray<T>& operator = (T x) { return SetT(x); }
139
140// addition et soustraction de constante
141 virtual TArray<T>& AddCst(T x, TArray<T>& res) const ;
142 virtual TArray<T>& SubCst(T x, TArray<T>& res, bool fginv=false) const ;
143// Multiplication et division par une constante
144 virtual TArray<T>& MulCst(T x, TArray<T>& res) const ;
145 virtual TArray<T>& DivCst(T x, TArray<T>& res, bool fginv=false) const ;
146
147// A += -= *= /= x (ajoute, soustrait, ... x a tous les elements)
148 // Methodes Add/Sub/Mul/Div() sont la pour compatibilite avant V=2 (1.818)
149 // Faut-il les garder ? Reza, Juillet 2004
150 inline TArray<T>& Add(T x) { return AddCst(x, *this); }
151 inline TArray<T>& Sub(T x, bool fginv=false) { return SubCst(x, *this, fginv); }
152 inline TArray<T>& Mul(T x) { return MulCst(x, *this); }
153 inline TArray<T>& Div(T x, bool fginv=false) { return DivCst(x, *this, fginv); }
154
155 //! Add \b x to all elements
156 inline TArray<T>& operator += (T x) { return AddCst(x, *this); }
157 //! Substract \b x to all elements
158 inline TArray<T>& operator -= (T x) { return SubCst(x, *this); }
159 //! Multiply all elements by \b x
160 inline TArray<T>& operator *= (T x) { return MulCst(x, *this); }
161 //! Divide all elements by \b x
162 inline TArray<T>& operator /= (T x) { return DivCst(x, *this); }
163
164// applique le signe moins a tous les elements
165 virtual TArray<T>& NegateElt(TArray<T>& res) const ;
166//! Replace array elements values by their opposite ( (*this)(i) -> -(*this)(i) )
167 inline TArray<T>& NegateElt() { return NegateElt(*this); }
168
169// A += -= (ajoute, soustrait element par element les deux tableaux )
170 virtual TArray<T>& AddElt(const TArray<T>& a, TArray<T>& res) const ;
171 virtual TArray<T>& SubElt(const TArray<T>& a, TArray<T>& res, bool fginv=false) const ;
172// Multiplication, division element par element les deux tableaux
173 virtual TArray<T>& MulElt(const TArray<T>& a, TArray<T>& res) const ;
174 virtual TArray<T>& DivElt(const TArray<T>& a, TArray<T>& res, bool fginv=false, bool divzero=false) const ;
175
176 //! Operator TArray += TArray (element by element addition in place)
177 inline TArray<T>& operator += (const TArray<T>& a) { return AddElt(a, *this); }
178 //! Operator TArray -= TArray (element by element subtraction in place)
179 inline TArray<T>& operator -= (const TArray<T>& a) { return SubElt(a, *this); }
180
181 // Doit-on definir les operateur *= /= TArray ? Reza, Juillet 2004
182 //! Element by element multiplication in place TArray *= TArray (element by element)
183 inline TArray<T>& Mul(const TArray<T>& a) { return MulElt(a, *this); }
184 //! Element by element division in place TArray *= TArray (element by element)
185 inline TArray<T>& Div(const TArray<T>& a, bool divzero=false)
186 { return DivElt(a, *this, false, divzero); }
187
188// Recopie des valeurs, element par element
189 virtual TArray<T>& CopyElt(const TArray<T>& a);
190// Recopie des valeurs avec conversion prealable, element par element
191 virtual TArray<T>& ConvertAndCopyElt(const BaseArray& a);
192
193// Calcul du produit scalaire ( Somme_i (*this)(i)*a(i) )
194 virtual T ScalarProduct(const TArray<T>& a) const ;
195// Norme(^2)
196 //! Returns the squarred of the array norm, defined as Sum_k (*this)(k)*(*this)(k)
197 inline T Norm2() const { return ScalarProduct(*this); }
198
199// Somme et produit des elements
200 virtual T Sum() const ;
201 virtual T Product() const ;
202// Somme du carre des elements
203 virtual T SumX2() const;
204// Valeur min et max des elements
205 virtual void MinMax(T& min, T& max) const ;
206
207// Impression, I/O, ...
208 virtual string InfoString() const;
209 virtual void Print(ostream& os, sa_size_t maxprt=-1,
210 bool si=false, bool ascd=false) const ;
211
212// Lecture,Ecriture sur fichier ASCII
213 virtual sa_size_t ReadASCII(istream& is, sa_size_t & nr, sa_size_t & nc,
214 char clm='#', const char* sep=" \t");
215 virtual void WriteASCII(ostream& os) const;
216
217//! assign a new object Id (or DataRef Id) - useful for PPF write operations
218 inline void RenewObjId() { mNDBlock.RenewObjId(); }
219// Pour la gestion de persistance
220 friend class FIO_TArray<T>;
221
222protected:
223
224 NDataBlock<T> mNDBlock; //!< Block for datas
225 mutable MuTyV my_mtv; //!< for use by ValueAtPosition()
226};
227
228////////////////////////////////////////////////////////////////
229// Surcharge d'operateur <<
230//! Print TArray \b a on stream \b os
231template <class T>
232inline ostream& operator << (ostream& os, const TArray<T>& a)
233 { a.Print(os); return(os); }
234
235// Surcharge d'operateur >>
236//! Decodes the ASCII input stream \b is , filling TArray \b a elements
237template <class T>
238inline istream& operator >> (istream& is, TArray<T>& a)
239 { sa_size_t nr, nc;
240 a.ReadASCII(is, nr, nc); return(is); }
241
242
243////////////////////////////////////////////////////////////////
244// Surcharge d'operateurs A (+,-,*,/) (T) x
245
246/*! \ingroup TArray \fn operator+(const TArray<T>&,T)
247 \brief Operator TArray = TArray + constant */
248template <class T> inline TArray<T> operator + (const TArray<T>& a, T b)
249 {TArray<T> result; result.SetTemp(true);
250 a.AddCst(b, result); return result;}
251
252/*! \ingroup TArray \fn operator+(T,const TArray<T>&)
253 \brief Operator TArray = constant + TArray */
254template <class T> inline TArray<T> operator + (T b,const TArray<T>& a)
255 {TArray<T> result; result.SetTemp(true);
256 a.AddCst(b, result); return result;}
257
258/*! \ingroup TArray \fn operator-(const TArray<T>&,T)
259 \brief Operator TArray = TArray - constant */
260template <class T> inline TArray<T> operator - (const TArray<T>& a, T b)
261 {TArray<T> result; result.SetTemp(true);
262 a.SubCst(b,result); return result;}
263
264/*! \ingroup TArray \fn operator-(T,const TArray<T>&)
265 \brief Operator TArray = constant - TArray */
266template <class T> inline TArray<T> operator - (T b,const TArray<T>& a)
267 {TArray<T> result; result.SetTemp(true);
268 a.SubCst(b,result,true); return result;}
269
270/*! \ingroup TArray \fn operator*(const TArray<T>&,T)
271 \brief Operator TArray = TArray * constant */
272template <class T> inline TArray<T> operator * (const TArray<T>& a, T b)
273 {TArray<T> result; result.SetTemp(true);
274 a.MulCst(b, result); return result;}
275
276/*! \ingroup TArray \fn operator*(T,const TArray<T>&)
277 \brief Operator TArray = constant * TArray */
278template <class T> inline TArray<T> operator * (T b,const TArray<T>& a)
279 {TArray<T> result; result.SetTemp(true);
280 a.MulCst(b,result); return result;}
281
282/*! \ingroup TArray \fn operator/(const TArray<T>&,T)
283 \brief Operator TArray = TArray / constant */
284template <class T> inline TArray<T> operator / (const TArray<T>& a, T b)
285 {TArray<T> result; result.SetTemp(true);
286 a.DivCst(b,result); return result;}
287
288/*! \ingroup TArray \fn operator/(T,const TArray<T>&)
289 \brief Operator TArray = constant / TArray */
290template <class T> inline TArray<T> operator / (T b, const TArray<T>& a)
291 {TArray<T> result; result.SetTemp(true);
292 a.DivCst(b, result, true); return result;}
293
294////////////////////////////////////////////////////////////////
295// Surcharge d'operateurs B = -A
296
297/*! \ingroup TArray \fn operator - (const TArray<T>&)
298 \brief Operator - Returns an array with elements equal to the opposite of
299 the original array elements. */
300template <class T> inline TArray<T> operator - (const TArray<T>& a)
301 {TArray<T> result; result.SetTemp(true);
302 a.NegateElt(result); return result;}
303
304////////////////////////////////////////////////////////////////
305// Surcharge d'operateurs C = A (+,-,&&,/) B
306
307/*! \ingroup TArray \fn operator+(const TArray<T>&,const TArray<T>&)
308 \brief Operator TArray = TArray + TArray (element by element addition) */
309template <class T>
310inline TArray<T> operator + (const TArray<T>& a,const TArray<T>& b)
311 { TArray<T> result; result.SetTemp(true);
312 a.AddElt(b, result); return result; }
313
314/*! \ingroup TArray \fn operator-(const TArray<T>&,const TArray<T>&)
315 \brief Operator TArray = TArray - TArray (element by element subtraction) */
316template <class T>
317inline TArray<T> operator - (const TArray<T>& a,const TArray<T>& b)
318 { TArray<T> result; result.SetTemp(true);
319 a.SubElt(b, result); return result; }
320
321/*! \ingroup TArray \fn operator && (const TArray<T>&,const TArray<T>&)
322 \brief Element by element multiplication of two arrays TArray = TArray * TArray */
323
324template <class T>
325inline TArray<T> operator && (const TArray<T>& a,const TArray<T>& b)
326 { TArray<T> result; result.SetTemp(true);
327 a.MulElt(b, result); return result; }
328
329/*! \ingroup TArray \fn operator / (const TArray<T>&,const TArray<T>&)
330 \brief Element by element division of two arrays TArray = TArray / TArray */
331template <class T>
332inline TArray<T> operator / (const TArray<T>& a,const TArray<T>& b)
333 { TArray<T> result; result.SetTemp(true);
334 a.DivElt(b, result, false, false); return result; }
335
336// --------------------------------------------------
337// inline element acces methods
338// --------------------------------------------------
339
340//! Return element (ix,iy,iz,it,iu) value
341template <class T>
342inline 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
343{
344 return ( *( mNDBlock.Begin()+ offset_+
345 ix*step_[0] + iy*step_[1] + iz*step_[2] +
346 it*step_[3] + iu*step_[4]) );
347}
348
349//! Return element (ix,iy,iz,it,iu) value
350template <class T>
351inline T & TArray<T>::Elem(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
352{
353 return ( *( mNDBlock.Begin()+ offset_+
354 ix*step_[0] + iy*step_[1] + iz*step_[2] +
355 it*step_[3] + iu*step_[4]) );
356}
357
358//! Return element (ix,iy,iz,it,iu) value with Check of indexes bound first
359template <class T>
360inline 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
361{
362 CheckBound(ix, iy, iz, it, iu, 4);
363 return(Elem(ix, iy, iz, it, iu));
364}
365
366//! Return element (ix,iy,iz,it,iu) value with Check of indexes bound first
367template <class T>
368inline T & TArray<T>::ElemCheckBound(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
369{
370 CheckBound(ix, iy, iz, it, iu, 4);
371 return(Elem(ix, iy, iz, it, iu));
372}
373
374//! Return element (ix,iy,iz) value
375template <class T>
376inline T const& TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz) const
377{
378#ifdef SO_BOUNDCHECKING
379 CheckBound(ix, iy, iz, 0, 0, 4);
380#endif
381 return ( *( mNDBlock.Begin()+ offset_+
382 ix*step_[0] + iy*step_[1] + iz*step_[2]) );
383}
384
385//! Return element (ix,iy,iz) value
386template <class T>
387inline T & TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz)
388{
389#ifdef SO_BOUNDCHECKING
390 CheckBound(ix, iy, iz, 0, 0, 4);
391#endif
392 return ( *( mNDBlock.Begin()+ offset_+
393 ix*step_[0] + iy*step_[1] + iz*step_[2]) );
394}
395
396//! Operator () : return element (ix,iy,iz,it,iu) value
397template <class T>
398inline 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
399{
400#ifdef SO_BOUNDCHECKING
401 CheckBound(ix, iy, iz, it, iu, 4);
402#endif
403 return ( *( mNDBlock.Begin()+ offset_+
404 ix*step_[0] + iy*step_[1] + iz*step_[2] +
405 it*step_[3] + iu*step_[4]) );
406}
407
408//! Operator () : return element (ix,iy,iz,it,iu) value
409template <class T>
410inline T & TArray<T>::operator()(sa_size_t ix, sa_size_t iy, sa_size_t iz, sa_size_t it, sa_size_t iu)
411{
412#ifdef SO_BOUNDCHECKING
413 CheckBound(ix, iy, iz, it, iu, 4);
414#endif
415 return ( *( mNDBlock.Begin()+ offset_+
416 ix*step_[0] + iy*step_[1] + iz*step_[2] +
417 it*step_[3] + iu*step_[4]) );
418}
419
420
421//! Operator [] : return element at positon ip
422template <class T>
423inline T const& TArray<T>::operator[](sa_size_t ip) const
424{
425#ifdef SO_BOUNDCHECKING
426 if (ip >= totsize_) throw( ParmError("TArray<T>::operator[] Out-of-bound Error") );
427#endif
428return *(mNDBlock.Begin()+Offset(ip));
429}
430
431//! Operator [] : return element at positon ip
432template <class T>
433inline T & TArray<T>::operator[](sa_size_t ip)
434{
435#ifdef SO_BOUNDCHECKING
436 if (ip >= totsize_) throw( ParmError("TArray<T>::operator[] Out-of-bound Error") );
437#endif
438return *(mNDBlock.Begin()+Offset(ip));
439}
440
441
442//! Converts to a scalar (value of first element) if the array size is equal to 1
443template <class T>
444inline T TArray<T>::toScalar()
445{
446 if (Size() != 1) throw(SzMismatchError("TArray<T>::operator T() Size() != 1")) ;
447 return ( (*this)[0] );
448}
449
450// Typedef pour simplifier
451/*! \ingroup TArray
452 \typedef Array
453 \brief To simplified TArray<r_8> writing
454*/
455typedef TArray<r_8> Array;
456
457} // Fin du namespace
458
459#endif
Note: See TracBrowser for help on using the repository browser.