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


Ignore:
Timestamp:
Apr 12, 2000, 7:42:33 PM (25 years ago)
Author:
ansari
Message:

documentation cmv 12/4/00

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SophyaLib/TArray/tvector.cc

    r813 r894  
    1 // $Id: tvector.cc,v 1.3 2000-04-05 15:44:17 ansari Exp $
     1// $Id: tvector.cc,v 1.4 2000-04-12 17:42:30 ansari Exp $
    22//                         C.Magneville          04/99
    33#include "machdefs.h"
    … …  
    99//**** Createur, Destructeur
    1010
     11//! Default constructor
    1112template <class T>
    1213TVector<T>::TVector()
    … …  
    1516}
    1617
     18//! construct a vector
     19/*!
     20  \param n : number of elements
     21  \param lcv : line or column vector ?
     22  \param mm : memory mapping type
     23  \sa SelectVectorType
     24 */
    1725template <class T>
    1826TVector<T>::TVector(uint_4 n, short lcv, short mm)
    … …  
    2432}
    2533
    26 
     34//! Constructor by copy (share if \b a is temporary)
    2735template <class T>
    2836TVector<T>::TVector(const TVector<T>& a)
    … …  
    3240}
    3341
     42//! Constructor by copy
     43/*!
     44  \param share : if true, share data. If false copy data
     45 */
    3446template <class T>
    3547TVector<T>::TVector(const TVector<T>& a, bool share)
    … …  
    3951}
    4052
     53//! Constructor from a TArray
    4154template <class T>
    4255TVector<T>::TVector(const TArray<T>& a)
    … …  
    4861
    4962
     63//! Constructor of a vector from a TArray \b a
     64/*!
     65  \param a : TArray to be copied or shared
     66  \param share : if true, share data. If false copy data
     67  \param mm : define the memory mapping type
     68  \param lcv : line or column vector ?
     69  \sa SelectVectorType
     70 */
    5071template <class T>
    5172TVector<T>::TVector(const TArray<T>& a, bool share, short mm, short lcv )
    … …  
    6182}
    6283
     84//! Destructor
    6385template <class T>
    6486TVector<T>::~TVector()
    65 // Destructeur
    6687{
    67 
    6888}
    6989
     90//! Resize the vector
     91/*!
     92  \param n : number of elements
     93  \param lcv : line or column vector ?
     94  \sa SelectVectorType
     95 */
    7096template <class T>
    7197void TVector<T>::ReSize(uint_4 n, short lcv)
    … …  
    82108}
    83109
     110//! Re-allocate space for the vector
     111/*!
     112  \param n : number of elements
     113  \param lcv : line or column vector ?
     114  \param force : if true re-allocation is forced, if not it occurs
     115          only if the required space is greater than the old one.
     116  \sa ReSize SelectVectorType
     117 */
    84118template <class T>
    85119void TVector<T>::Realloc(uint_4 n, short lcv, bool force)
    … …  
    97131
    98132// $CHECK$ Reza 03/2000  Doit-on declarer cette methode const ?
     133//! Return a subvector define by \b Range \b relt
    99134template <class T>
    100135TVector<T> TVector<T>::SubVector(Range relt) const
    … …  
    109144}
    110145
     146//! Return the norm \f$ \sum{V(i)^2} \f$
    111147template <class T>
    112148T TVector<T>::Norm2() const
    … …  
    117153}
    118154
     155//! Return info on number of rows, column and type \b T
    119156template <class T>
    120157string TVector<T>::InfoString() const
Note: See TracChangeset for help on using the changeset viewer.