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

Timestamp:

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

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/tmatrix.h (modified) (8 diffs)

trunk/SophyaLib/TArray/tmatrix.h

@@ -8 +8 @@
 
 namespace SOPHYA {
+
+//! Class of matrixes
+/*!
+  \sa TArray
+ */
 
 template <class T>
@@ -23 +28 @@
   //  Pour verifiez la compatibilite de dimensions lors de l'affectation
   virtual TArray<T>& Set(const TArray<T>& a);
+  //! Operator = between matrices
   inline  TMatrix<T>& operator = (const TMatrix<T>& a)
-                       { Set(a);  return(*this); }
+                     { Set(a);  return(*this); }
 
   // Size - Changing the Size 
+  //! return number of rows
   inline uint_4 NRows() const {return Size(marowi_); }
+  //! return number of columns
   inline uint_4 NCols() const {return Size(macoli_); }
+  //! return number of columns
   inline uint_4 NCol()  const {return Size(macoli_); } // back-compat Peida
 
@@ -36 +45 @@
   // Sub-matrix extraction $CHECK$ Reza 03/2000  Doit-on declarer ces methode const ?
   TMatrix<T> SubMatrix(Range rline, Range rcol) const ;
+  //! () : Return submatrix define by \b Range \b rline and \b rcol
   inline TMatrix<T> operator () (Range rline, Range rcol) const 
                     { return SubMatrix(rline, rcol); }
   // Lignes et colonnes de la matrice
+  //! Return submatrix define by line \b ir (line vector)
   inline TMatrix<T> Row(uint_4 ir) const
                     { return SubMatrix(Range(ir,ir), Range(0,NCols()-1)); }
+  //! Return submatrix define by column \b ic (column vector)
   inline TMatrix<T> Column(uint_4 ic) const
                     { return SubMatrix(Range(0,NRows()-1), Range(ic,ic)); }
@@ -58 +70 @@
   // A = x (matrice diagonale Identite)
   virtual TMatrix<T>& SetIdentity(IdentityMatrix imx);
+  // = : fill matrix with an identity matrix \b imx
   inline  TMatrix<T>& operator = (IdentityMatrix imx) { return SetIdentity(imx); }
 
+  // = : fill matrix with a Sequence \b seq
   inline  TMatrix<T>&  operator = (Sequence seq)    { SetSeq(seq); return(*this); }
 
   // Operations diverses  avec une constante
+  //! = : fill matrix with constant value \b x
   inline  TMatrix<T>&  operator = (T x)             { SetT(x); return(*this); }
+  //! += : add constant value \b x to matrix
   inline  TMatrix<T>&  operator += (T x)            { Add(x); return(*this); }
+  //! -= : substract constant value \b x to matrix
   inline  TMatrix<T>&  operator -= (T x)            { Sub(x); return(*this); }
+  //! *= : multiply matrix by constant value \b x
   inline  TMatrix<T>&  operator *= (T x)            { Mul(x); return(*this); }
+  //! /= : divide matrix by constant value \b x
   inline  TMatrix<T>&  operator /= (T x)            { Div(x); return(*this); }
 
   //  operations avec matrices 
+  //! += : add a matrix
   inline  TMatrix<T>&  operator += (const TMatrix<T>& a)  { AddElt(a); return(*this); }
+  //! -= : substract a matrix
   inline  TMatrix<T>&  operator -= (const TMatrix<T>& a)  { SubElt(a); return(*this); }
-  // Produit matriciel Multiply : C = (*this)*B
   TMatrix<T>  Multiply(const TMatrix<T>& b, short mm=SameMemoryMapping) const;
+  //! *= : matrix product : C = (*this)*B
   inline  TMatrix<T>&  operator *= (const TMatrix<T>& b)
           { this->Set(Multiply(b));  return(*this); }
@@ -85 +106 @@
 
 //  ---- inline acces methods ------
+ //! () : return element for line \b r and column \b c
 template <class T>
 inline T const& TMatrix<T>::operator()(uint_4 r, uint_4 c) const
@@ -96 +118 @@
 }
 
+//! () : return element for line \b r and column \b c
 template <class T>
 inline T & TMatrix<T>::operator()(uint_4 r, uint_4 c) 
@@ -113 +136 @@
 // Doit-on le faire aussi pour les constantes ? - Fin de $CHECK$ Reza 3/4/2000
 
+//! + : add matrixes \b a and \b b
 template <class T>
 inline TMatrix<T> operator + (const TMatrix<T>& a,const TMatrix<T>& b)
     {TMatrix<T> result(a); result.SetTemp(true); result.AddElt(b); return result;}
 
+//! - : substract matrixes \b a and \b b
 template <class T>
 inline TMatrix<T> operator - (const TMatrix<T>& a,const TMatrix<T>& b)
@@ -122 +147 @@
 
 // Surcharge d'operateurs C = A * B
-
+//! - : multiply matrixes \b a and \b b
 template <class T> inline TMatrix<T> operator * (const TMatrix<T>& a, const TMatrix<T>& b)
 { TMatrix<T> result(a); result.SetTemp(true); return(result.Multiply(b)); }
 
+//! Define Matrix to be TMatrix<r_8>
 typedef TMatrix<r_8> Matrix;