Changeset 935 in Sophya for trunk/SophyaLib/TArray/sopemtx.cc

Timestamp:

Apr 14, 2000, 4:03:40 PM (25 years ago)

Author:

ansari

Message:

doc + inversion de matrice template real+complex

File:

• trunk/SophyaLib/TArray/sopemtx.cc (modified) (6 diffs)

trunk/SophyaLib/TArray/sopemtx.cc

@@ -110 +110 @@
 
 
-//! Multiply two TMatrixRC
+//! Scalar product of two TMatrixRC
+/*!
+  \return sum[ a(i) * b(i) ]
+ */
 template <class T>
 inline T operator * (const TMatrixRC<T>& a, const TMatrixRC<T>& b)
@@ -123 +126 @@
   }
 
-//! Get the step in datas for a TMatrix for type rckind (line/col/diag)
+//! Get the step in datas for a TMatrix for type rckind
+/*!
+  \param rckind : line, column or diagonal
+  \return step in TMatrix along TMatrixRC
+ */
 template <class T>
 inline uint_4 TMatrixRC<T>::Step(const TMatrix<T>& m, TRCKind rckind)
@@ -131 +138 @@
     return 0; }
 
-/*! Get the origin of datas for a TMatrix for type rckind and
-  number index (line/col/diag). ex: origine for line "index". */
+//! Get the origin of datas.
+/*!
+  Get the origin of datas in the TMatrix for a TMatrixRC for type
+  \b rckind and index \b index .
+  \param rckind : line, column or diagonal
+  \param index : index of the line or column.
+  \return adress of the first element in datas.
+ */
 template <class T>
 inline T* TMatrixRC<T>::Org(const TMatrix<T>& m, TRCKind rckind, uint_4 index)
@@ -156 +169 @@
 
 ////////////////////////////////////////////////////////////////
-//! Typedef to simplifier TMatrixRC<r_8>
+//! Typedef to simplify TMatrixRC<r_8> writing
 typedef TMatrixRC<r_8> MatrixRC;
 
@@ -428 +441 @@
 //! Gaussian pivoting
 /*!
-  Diagonalize matrix \b a, doing the same opreations on matrix \b b
-  \return determinat of \b a
+  Diagonalize matrix \b a, doing the same operations on matrix \b b
+  \return determinat of \b a.
+
+  If \b b is identity matrix, return inverse of \b a
  */  
 template <class T>
@@ -712 +727 @@
 template class SimpleMatrixOperation< complex<r_8> >;
 #endif
+
+
+
+
+
+
+
+
+
+
+
+
+