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

Timestamp:

Nov 15, 2002, 10:35:44 AM (23 years ago)

Author:

ansari

Message:

MAJ documentation + methode Read/WriteASCII() en virtuelle pure ds BaseArray - Reza 15/11/2002

File:

• trunk/SophyaLib/TArray/tvector.cc (modified) (2 diffs)

trunk/SophyaLib/TArray/tvector.cc

@@ -1 @@
-// $Id: tvector.cc,v 1.14 2001-08-06 22:48:43 cmv Exp $
+// $Id: tvector.cc,v 1.15 2002-11-15 09:35:44 ansari Exp $
 //                         C.Magneville          04/99
 #include "machdefs.h"
@@ -9 +9 @@
   \class SOPHYA::TVector
   \ingroup TArray
-  Class of vector (line or column)
-  \sa TMatrix TArray
-  */
+
+  The TVector class specializes the TMatrix class for representing 
+  row or column vectors.
+
+  \b Vector is a typedef for double precision floating point vectors ( TVector<r_8> ).
+
+  \sa SOPHYA::TArray SOPHYA::TMatrix
+  \sa SOPHYA::Range SOPHYA::Sequence
+  \sa SOPHYA::MathArray
+
+  The following sample code illustrates sub-vector manipulation:
+  \code
+  #include "array.h"
+  // ...
+  // Input Vector containing a noisy periodic signal
+  Vector in(1024), out(1024);
+  in = RandomSequence(RandomSequence::Gaussian, 0., 1.);
+  for(int kk=0; kk<in.Size(); kk++)
+    in(kk) += 2*sin(kk*0.05);
+  // Compute the output vector by a simple low pass filter
+  Vector out(1024);
+  int w = 2;
+  for(int k=w; k<in.Size()-w; k++)
+    out(k) = in(Range(k-w, k+w).Sum()/(2.*w+1.);
+  \endcode
+*/
 
 ////////////////////////////////////////////////////////////////