Changeset 894 in Sophya for trunk/SophyaLib/TArray/basarr.h

Timestamp:

Apr 12, 2000, 7:42:33 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/basarr.h (modified) (5 diffs)

trunk/SophyaLib/TArray/basarr.h

@@ -13 +13 @@
 
 
-//! Maximum number of dimensions for an array
+//! Maximum number of dimensions for an array 
+/*! \anchor BASEARRAY_MAXNDIMS */
 #define BASEARRAY_MAXNDIMS  5
 
@@ -21 +22 @@
 //! Base class for template arrays
 /*!
-  Define base methods, enum and defaults for TArray , TMatrix and TVector
+  No data are connected to this class.
+
+  Define base methods, enum and defaults for TArray , TMatrix and TVector.
 */
 class BaseArray : public AnyDataObj {
@@ -51 +54 @@
   static inline uint_4 GetPrintLevel() { return prt_lev_; }
 
-  //! Set Default Memory Mapping
   static short   SetDefaultMemoryMapping(short mm=CMemoryMapping);
   //! Get Default Memory Mapping
   static inline short GetDefaultMemoryMapping() { return default_memory_mapping; }
-  //! Set Default Vector Type
   static short   SetDefaultVectorType(short vt=ColumnVector);
   //! Get Default Vector Type
@@ -146 +147 @@
   virtual string InfoString() const;
 
-  //  Objet DVList info 
-  DVList&       Info();
+  // DVList info Object
+  DVList& Info();
 
 protected:
@@ -166 +167 @@
   virtual void UpdateSubArraySizes(BaseArray & ra, uint_4 ndim, uint_4 * siz, uint_4 * pos, uint_4 * step) const;
 
-  uint_4 ndim_; //! number of dimensions of array
-  uint_4 size_[BASEARRAY_MAXNDIMS]; //! array of the size in each dimension
-  uint_8 totsize_; //! Total number of elements
+  uint_4 ndim_; //!< number of dimensions of array
+  uint_4 size_[BASEARRAY_MAXNDIMS]; //!< array of the size in each dimension
+  uint_8 totsize_; //!< Total number of elements
   //! two consecutive elements distance in a given dimension 
   uint_4 step_[BASEARRAY_MAXNDIMS];
-  uint_4 minstep_; //! minimal step (in any axes)
-  uint_4 moystep_; //! mean step, if == 0 --\> non regular steps
-  uint_8 offset_;  //! global offset -\> position of elem[0] in DataBlock
-  uint_4 marowi_; //! For matrices, Row index in dimensions
-  uint_4 macoli_; //! For matrices, Column index in dimensions
-  uint_4 veceli_; //! For vectors, dimension index = marowi_/macoli_ (Row/Col vectors)
-  bool ck_memo_vt_; //! if true, check MemoryOrg./VectorType for CompareSize
-  DVList* mInfo;    //! Infos (variables) attached to the array
-
-  static char * ck_op_msg_[6]; //! Operation messages for CheckDI() CheckBound()
-  static uint_4 max_nprt_; //! Nb maximum number of printed elements
-  static uint_4 prt_lev_;  //! Print level
-  static short default_memory_mapping; //! Default memory mapping
-  static short default_vector_type;    //! Default vector type Row/Column
-  static uint_8 openmp_size_threshold; //! Size limit for parallel routine calls
+  uint_4 minstep_; //!< minimal step (in any axes)
+  uint_4 moystep_; //!< mean step, if == 0 --\> non regular steps
+  uint_8 offset_;  //!< global offset -\> position of elem[0] in DataBlock
+  uint_4 marowi_; //!< For matrices, Row index in dimensions
+  uint_4 macoli_; //!< For matrices, Column index in dimensions
+  uint_4 veceli_; //!< For vectors, dimension index = marowi_/macoli_ (Row/Col vectors)
+  bool ck_memo_vt_; //!< if true, check MemoryOrg./VectorType for CompareSize
+  DVList* mInfo;    //!< Infos (variables) attached to the array
+
+  static char * ck_op_msg_[6]; //!< Operation messages for CheckDI() CheckBound()
+  static uint_4 max_nprt_; //!< maximum number of printed elements
+  static uint_4 prt_lev_;  //!< Print level
+  static short default_memory_mapping; //!< Default memory mapping
+  static short default_vector_type;    //!< Default vector type Row/Column
+  static uint_8 openmp_size_threshold; //!< Size limit for parallel routine calls
 };