Changeset 3838 in Sophya for trunk/SophyaLib/TArray/spesqmtx.cc

Timestamp:

Aug 9, 2010, 7:31:12 PM (15 years ago)

Author:

ansari

Message:

MAJ commentaires pour doxygen, passage methode Next() en pure virtual (=0), Reza 09/08/2010

File:

• trunk/SophyaLib/TArray/spesqmtx.cc (modified) (1 diff)

trunk/SophyaLib/TArray/spesqmtx.cc

@@ -9 +9 @@
 #include "tmatrix.h"
 
-// doit etre mis en dehors du namespace
+namespace SOPHYA {
 /*!
-  \class SOPHYA::SpecialSquareMatrix
+  \class SpecialSquareMatrix
   \ingroup TArray
   \brief The base class for representing and manipulating special square matrices
   Diagonal matrix, Symmetric matrix, Triangular matrix
-
   This class implements the common operations for special square matrices. Only objects 
+
   from the sub-classes (DiagonalMatrix<T>, LowerTriangularMatrix<T>, SymmetricMatrix<T>) 
   can be instanciated. Theses classes offer similar functionalities to the TArray<T> / TMatrix<T> 
   classes, like reference sharing and arithmetic operations. However, no sub-matrix extraction 
   method is provided. 
-  sub matrix extraction method.
+
+  \code 
+  // Create and initialize a diagonal matrix
+  DiagonalMatrix<double> diag(3);
+  diag(0,0)=1.;  diag(1,1)=2.;  diag(2,2)=3.;
+  // use of multiplication by a constant operator
+  diag *= 10.;
+  // check the diagonal matrix
+  cout << diag << diag.ConvertToStdMatrix() << endl;
+  // define and initialize a general matrix
+  TMatrix<double> mx(3,3);
+  mx=RegularSequence();
+  cout << mx;
+  // check the result of a matrix mutiplication
+  cout << mx*diag;
+  \endcode
 */
-
-namespace SOPHYA {
 
 //! Default constructor - SpecialSquareMatrix of size 0, SetSize() should be called before the object is used