Changeset 914 in Sophya for trunk/SophyaLib/TArray/triangmtx.h

Timestamp:

Apr 13, 2000, 6:04:50 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 13/4/00

File:

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

trunk/SophyaLib/TArray/triangmtx.h

@@ -1 +1 @@
 // This may look like C code, but it is really -*- C++ -*-
-/*! Class for inferior triangular matrix (base class for the class Alm) */
 
 #ifndef TRIANGMTX_H_SEEN
@@ -10 +9 @@
 namespace SOPHYA {
 
+//! Class for inferior triangular matrix (base class for the class Alm)
 template <class T>
-class TriangularMatrix 
-  {
-    
-  public :
+class TriangularMatrix {
+public :
 
+//! Default constructor
 TriangularMatrix()   {};
-  /* instanciate a triangular matrix from the number of rows */
+//! instanciate a triangular matrix from the number of rows
 TriangularMatrix(int rowSize)  : long_diag_((uint_4)rowSize) {elem_.ReSize((uint_4) (rowSize*(rowSize+1)/2) ); };
+//! Copy constructor (possibility of sharing datas)
 TriangularMatrix(const TriangularMatrix<T>& a,  bool share=false)  : elem_(a.elem_, share),  long_diag_(a.long_diag_) {;}
-/*! resize the matrix with a new number of rows */
+
+//! resize the matrix with a new number of rows
 inline void ReSizeRow(int rowSize) 
   {
@@ -28 +29 @@
  inline void SetTemp(bool temp=false) const {elem_.SetTemp(temp);}
 
+//! Equal operator
 inline TriangularMatrix<T>& operator = (const TriangularMatrix<T>& a)
 {
@@ -34 +36 @@
   return *this;
 }
+
+//! () operator : access to elements row \b l and column \b m
 inline T& operator()(int l, int m) 
   {
       return  elem_(adr_ij(l,m));
   }
+//! () operator : access to elements row \b l and column \b m
 inline T const& operator()(int l, int m) const 
   {
       return *(elem_.Begin()+ adr_ij(l,m));
   }
- inline  int_4  rowNumber() const {return (int_4)long_diag_;}
-  private: 
- /*! compute the address of an element in the single array representing the matrix */
+
+//! Return number of rows
+inline  int_4  rowNumber() const {return (int_4)long_diag_;}
+
+private: 
+//! compute the address of an element in the single array representing the matrix
 inline uint_4 adr_ij(int i,int j) const 
 {
@@ -56 +64 @@
 }
 
- uint_4 long_diag_;
- NDataBlock<T> elem_;
+uint_4 long_diag_;    //!< size of the square matrix
+NDataBlock<T> elem_;  //!< Data block
 
   };