Changeset 2267 in Sophya for trunk/SophyaLib/TArray/tarray.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/tarray.cc (modified) (1 diff)

trunk/SophyaLib/TArray/tarray.cc

@@ -12 +12 @@
   \class SOPHYA::TArray
   \ingroup TArray
-  Class for template arrays
-
-  This class implements arrays of dimensions up to
+  Class for template arrays with numerical data types (int, float, complex).
+
+  This class implements arrays with number of dimensions up to
   \ref BASEARRAY_MAXNDIMS "BASEARRAY_MAXNDIMS"
+
+  Standard arithmetic operations on numerical arrays are implemented,
+  as well as sub-array manipulation services.
+  \b Array is a typedef for double precision floating point arrays ( TArray<r_8> )
+  \sa SOPHYA::Range
+  \sa SOPHYA::Sequence
+  \sa SOPHYA::MathArray
+
+  \code
+  #include "array.h"
+  // ...
+  // Creating and initialising a 1-D array of integers
+  TArray<int> ia(5);
+  EnumeratedSequence es;
+  es = 24, 35, 46, 57, 68;
+  ia = es;
+  cout << "Array<int> ia = " << ia;
+  // 2-D array of floats 
+  TArray<r_4> b(6,4), c(6,4);
+  // Initializing b with a constant
+  b = 2.71828;
+  // Filling c with random numbers  
+  c = RandomSequence(); 
+  // Arithmetic operations
+  TArray<r_4> d = b+0.3f*c;
+  cout << "Array<float> d = " << d;  
+  \endcode
+
 */