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

Timestamp:

01/10/13 11:24:23 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/PacpusTools/matrice.h (modified) (1 diff)

trunk/include/Pacpus/PacpusTools/matrice.h

@@ -57 +57 @@
     }
 
+    /// @todo Documentation
     matrice &operator+=(const matrice &m); //m+=m1
+    /// @todo Documentation
     matrice &operator-=(const matrice &m); //m-=m1
 
+    /// @todo Documentation
     matrice operator+(const matrice &m1) const; //m=m1+m2
+    /// @todo Documentation
     matrice operator-(const matrice &m1) const; //m=m1-m2
+    /// @todo Documentation
     matrice operator*(const matrice &m1) const; //m=m1*m2
 
+    /// @todo Documentation
     matrice &operator+=(double x); //m+=x
+    /// @todo Documentation
     matrice &operator-=(double x); //m-=x
 
+    /// @todo Documentation
     matrice operator+(double x)const; //m+x
+    /// @todo Documentation
     matrice operator-(double x)const; //m-x
+    /// @todo Documentation
     matrice operator*(double x)const; //m*x
+    /// @todo Documentation
     matrice operator/(double x)const; //m/x
 
+    /// @todo Documentation
     friend matrice operator+(double x,matrice m1) {return m1+x ;} // x+m ;
+    /// @todo Documentation
     friend matrice operator-(double x,matrice m1) {return m1-x ;} // x-m ;
+    /// @todo Documentation
     friend matrice operator*(double x,matrice m1) {return m1*x ;} // x*m ;
 
-    matrice T(); //transposition
-    matrice I(); //inversion
+    /// Matrix transpose.
+    matrice T();
+    /// Matrix inverse.
+    matrice I();
 
+    /// @todo Documentation
     double &operator()(unsigned short int i, unsigned short int j); // ecriture m(i,j)=x
+    /// @todo Documentation
     double operator()(unsigned short int i, unsigned short int j) const; //lecture x=m(i,j)
+    /// @todo Documentation
     double &operator()(unsigned short int i); // ecriture m(i)=x
+    /// @todo Documentation
     double operator()(unsigned short int i) const; //lecture x=m(i)
 
+    /// @todo Documentation
     void print(const char *nom);
 };