Changeset 69 in pacpusframework for trunk/include/Pacpus/PacpusTools/matrice.h

Timestamp:

01/10/13 00:04:42 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/PacpusTools/matrice.h (modified) (2 diffs)

trunk/include/Pacpus/PacpusTools/matrice.h

@@ -21 +21 @@
 } t_m;
 
+/// Simple matrix.
+/// @todo Documentation
 class matrice
 {
@@ -29 +31 @@
 
 public:
-    //constructeurs
+    /// Ctor
     matrice();
+    /// Ctor
     matrice(unsigned short int nl, unsigned short int nc);
+    /// Ctor
     matrice(unsigned short int nl, unsigned short int nc,t_m type);
+    /// Copy ctor
     matrice(const matrice &source); //constructeur par copie
-    //destructeur
+    /// Dtor
     virtual ~matrice(void);
-    void Alloue(unsigned short int nl, unsigned short int nc); //allocation de la matrice
 
-    // fonction pour le calcul de matrice 
+    /// Allocates matrix data
+    /// @todo Rename
+    void Alloue(unsigned short int nl, unsigned short int nc);
+
+    /// Assignment operator for matrix operand
     matrice &operator=(const matrice &m);//m=m1
+    /// Assignment operator for scalar operand
     matrice &operator=(double x); //m=x
-    operator double()const{return **lignes;}
+    /// Conversion operator to double
+    /// @todo FIXME
+    operator double() const
+    {
+        return **lignes;
+    }
 
     matrice &operator+=(const matrice &m); //m+=m1