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

Timestamp:

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

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/tvector.h (modified) (7 diffs)

trunk/SophyaLib/TArray/tvector.h

@@ -8 +8 @@
 namespace SOPHYA {
 
+//! Class of vector (line or column)
+/*!
+  \sa TMatrix TArray
+  */
 template <class T>
 class TVector : public TMatrix<T> {
@@ -21 +25 @@
   virtual ~TVector();
 
+  //! Operator =
   inline  TVector<T>& operator = (const TVector<T>& a)
                        { Set(a);  return(*this); }
@@ -31 +36 @@
   // Sub-Vector extraction $CHECK$ Reza 03/2000  Doit-on declarer cette methode const ?
   TVector<T> SubVector(Range relt) const ;
+  //! Extract a vector define by Range \b relt
   inline TVector<T> operator () (Range relt) const 
                     { return SubVector(relt); }
 
   // Informations pointeur/data
+  //! return the number of elements
   inline uint_4 NElts() const {return Size(); }
   
@@ -42 +49 @@
 
   // Operateur d'affectation
+  //! Fill the 
   inline  TMatrix<T>&  operator = (Sequence seq)    { SetSeq(seq); return(*this); }
 
   // Operations diverses  avec une constante
+  //! Set vector elements to constant value \b x
   inline  TVector<T>&  operator = (T x)             { SetT(x); return(*this); }
+  //! Add constant value \b x to vector elements
   inline  TVector<T>&  operator += (T x)            { Add(x); return(*this); }
+  //! Substract constant value \b x to vector elements
   inline  TVector<T>&  operator -= (T x)            { Sub(x); return(*this); }
+  //! Multiply vector elements by constant value \b x
   inline  TVector<T>&  operator *= (T x)            { Mul(x); return(*this); }
+  //! Divide vector elements by constant value \b x
   inline  TVector<T>&  operator /= (T x)            { Div(x); return(*this); }
 
   //  operations avec matrices 
+  //! += : add a vector in place
   inline  TVector<T>&  operator += (const TVector<T>& a)  { AddElt(a); return(*this); }
+  //! += : substract a vector in place
   inline  TVector<T>&  operator -= (const TVector<T>& a)  { SubElt(a); return(*this); }
 
@@ -63 +78 @@
 
 //  ---- inline acces methods ------
+
+//! Return the value of element \b n
 template <class T>
 inline T const& TVector<T>::operator()(uint_4 n) const
@@ -73 +90 @@
 }
 
+//! Return the value of element \b n
 template <class T>
 inline T & TVector<T>::operator()(uint_4 n) 
@@ -84 +102 @@
 
 // Typedef pour simplifier et compatibilite Peida
+//! Define Vector to be TVector<r_8>
 typedef TVector<r_8> Vector;