Changeset 944 in Sophya for trunk/SophyaLib/BaseTools/ndatablock.h

Timestamp:

Apr 16, 2000, 1:49:13 PM (25 years ago)

Author:

ansari

Message:

doc + nouvelle gestion debug cmv 16/04/00

File:

• trunk/SophyaLib/BaseTools/ndatablock.h (modified) (7 diffs)

trunk/SophyaLib/BaseTools/ndatablock.h

@@ -12 +12 @@
 namespace SOPHYA {
 
+////////////////////////////////////////////////////////////////
+//// ------------------- Class Bridge ----------------------- //
+////////////////////////////////////////////////////////////////
+/*!
+  \class Bridge
+  \ingroup SysTools
+  This class is use by NDataBlock. It allows sharing of datas
+  with external structures : by example, if you want to connect
+  a Blitz data structure with a NDataBlock or a TMatrix or ...
+  \sa NDataBlock
+*/
+
 // Classe pour permettre de partager des donnees avec 
 // un autre systeme de gestion de references (ex avec Blitz)
+//! Empty class which allows data sharing with external structures (for NDataBlock)
 class Bridge {
 public:
@@ -20 +33 @@
 };
 
+////////////////////////////////////////////////////////////////
+//// ----------------- Class NDataBlock --------------------- //
+////////////////////////////////////////////////////////////////
+
 // classe de container avec partage de reference
+//! Container of data with reference sharing
 template <class T>
 class NDataBlock : public AnyDataObj {
 
 public:
+
+  // Methodes statiques pour debug.
+  static void SetPrintDebug(int prtdbglevel=1);
+  static void ResetDebug(size_t nallocdata=0, size_t nallocsref=0);
+  static void PrintDebug();
 
   // Creation / destruction 
@@ -35 +58 @@
 
   // Temporaire?
+  //! Return true if data block is temporay
   inline bool IsTemp(void) const {return mIsTemp;}
+  //! Set temporary caracter of data block
   inline void SetTemp(bool temp=false) const {mIsTemp = temp;}
 
@@ -43 +68 @@
   void Share(const NDataBlock<T>& a);
   void FillFrom(size_t n,T* data);
+  //! Re-set all data values to \b v
   inline void Reset(T v=0)
          {if(mSz==0) return; T *p=Begin(),*pe=End(); while(p<pe) *p++=v;}
@@ -50 +76 @@
   // et le nouveau tableau mis a zero. La nouvelle structure de
   // donnees n'a qu'une reference (celle de cette classe).
+  //! Re-size the data structure
+  /*! Old datas are lost (for this class). The new values are set to zero.
+    The new data structure has only one reference (itself!). */
   inline void ReSize(size_t n) {Alloc(n);}
 
@@ -55 +84 @@
   
   // Informations pointeur/data
+  //! Return pointer on data structure.
   inline T* Data()
          {if(mSRef) return mSRef->data; else return NULL;}
+  //! Return pointer on data structure.
   inline T* Data() const
          {if(mSRef) return mSRef->data; else return NULL;}
+  //! Return the size of the data structure
   inline size_t Size() const    {return mSz;}
+  //! Return the \b i th element of  the data structure
   inline T& operator()(size_t i)       {return *(mSRef->data+i);}
+  //! Return the \b i th element of  the data structure
   inline T  operator()(size_t i) const {return *(mSRef->data+i);}
+  //! Return pointer to the beginning of the data structure.
   inline T*        Begin()        {return mSRef->data;}
+  //! Return pointer to the beginning of the data structure.
   inline T const*  Begin() const  {return mSRef->data;} 
+  //! Return pointer to the end of the data structure.
   inline T*        End()          {return mSRef->data+mSz;}
+  //! Return pointer to the end of the data structure.
   inline T const*  End() const    {return mSRef->data+mSz;}
+  //! Return the number of references to the data structure
   inline size_t NRef() const {if(mSRef) return 0; else return mSRef->nref;}
 
   // Impression
   void Print(ostream& os, size_t i1=0,size_t n=10) const;
+  //! print infos and datas (from \b i1 to \b i2) on stdout.
   inline void Print(size_t i1=0,size_t n=0) const {Print(cout,i1,n);}
 
@@ -106 +146 @@
 
 protected:
-  typedef struct {size_t nref; T* data; Bridge* bridge; } NDREF;
+  //! NDREF structure for reference management
+  typedef struct {
+    size_t nref;      //!< Number of references to the data structure
+    T* data;          //!< Pointer to data structure itself
+    Bridge* bridge;   //!< Pointer to a bridge for the data structure
+  } NDREF;
 
   void Alloc(size_t n,T* data=NULL,Bridge* br=NULL, bool zero=true);
   void Delete(void);
 
-  size_t       mSz;
-  NDREF*       mSRef;
-  mutable bool mIsTemp;
+  static int Debug_NDataBlock; //!< DEBUG: set debug level (all type<T> classes)
+  static size_t NallocData; //!< DEBUG: number of allocations (all type<T> classes)
+  static size_t NallocSRef; //!< DEBUG: number of references (all type<T> classes)
+
+  size_t       mSz;      //!< size of data structure
+  NDREF*       mSRef;    //!< NDREF structure for reference management
+  mutable bool mIsTemp;  //!< true if class is temporary
 };
 
-
+//! Define operator \<\< for printing
 template<class T>
 inline ostream& operator << (ostream& os, const NDataBlock<T>& a)
                       {a.Print(os); return(os);}
+
+//! Add a constant to datas and return NDataBlock : ND = NDa + b
 template<class T>
 inline NDataBlock<T> operator + (const NDataBlock<T>& a,T b)
                       {return a.Add(b);}
+//! Add a constant to datas and return NDataBlock : ND = b + NDa
 template<class T>
 inline NDataBlock<T> operator + (T b,const NDataBlock<T>& a)
                       {return a.Add(b);}
+//! Substract a constant to datas and return NDataBlock : ND = NDa - b
 template<class T>
 inline NDataBlock<T> operator - (const NDataBlock<T>& a,T b)
                       {return a.Sub(b);}
+//! Substract a constant to datas and return NDataBlock : ND = b - NDa
 template<class T>
 inline NDataBlock<T> operator - (T b,const NDataBlock<T>& a)
                       {return a.SubInv(b);}
+//! Multiply datas by a constant and return NDataBlock : ND = NDa * b
 template<class T>
 inline NDataBlock<T> operator * (const NDataBlock<T>& a,T b)
                       {return a.Mul(b);}
+//! Multiply datas by a constant and return NDataBlock : ND = b * NDa
 template<class T>
 inline NDataBlock<T> operator * (T b,const NDataBlock<T>& a)
                       {return a.Mul(b);}
+//! Divide datas by a constant and return NDataBlock : ND = NDa / b
 template<class T>
 inline NDataBlock<T> operator / (const NDataBlock<T>& a,T b)
                       {return a.Div(b);}
+//! Divide a constant by datas and return NDataBlock : ND = b / NDa
 template<class T>
 inline NDataBlock<T> operator / (T b,const NDataBlock<T>& a)
                       {return a.DivInv(b);}
 
+//! Add datas of two data blocks and return NDataBlock : ND = NDa + NDb
 template<class T>
 inline NDataBlock<T> operator + (const NDataBlock<T>& a,const NDataBlock<T>& b)
                       {return a.Add(b);}
+//! Substract datas of two data blocks and return NDataBlock : ND = NDa - NDb
 template<class T>
 inline NDataBlock<T> operator - (const NDataBlock<T>& a,const NDataBlock<T>& b)
                       {return a.Sub(b);}
+//! Multiply datas of two data blocks and return NDataBlock : ND = NDa * NDb
 template<class T>
 inline NDataBlock<T> operator * (const NDataBlock<T>& a,const NDataBlock<T>& b)
                       {return a.Mul(b);}
+//! Divide datas of two data blocks and return NDataBlock : ND = NDa / NDb
 template<class T>
 inline NDataBlock<T> operator / (const NDataBlock<T>& a,const NDataBlock<T>& b)
                       {return a.Div(b);}
 
-
-
 } // Fin du namespace