Changeset 1058

Timestamp:

Feb 8, 2008, 10:26:06 PM (16 years ago)

Author:

Peter

Message:

some dox on vector - refs #256

File:

• trunk/yat/utility/vector.h (modified) (6 diffs)

trunk/yat/utility/vector.h

@@ -48 +48 @@
      @brief This is the yat interface to GSL vector. 
 
-     For time being 'double' is the only type supported.
-
      \par File streams:
      Reading and writing vectors to file streams are of course
@@ -55 +53 @@
      and thus binary read and write to streams are not supported.
 
-     \par Vector views:
-     GSL vector views are supported and these are disguised as
-     ordinary utility::vectors. A support function is added,
-     utility::vector::isview(), that can be used to check if a vector
-     object is a view. Note that view vectors do not own the
-     underlying data, and a view is not valid if the vector/matrix
-     owing the data is deallocated.
+     \par Vector views: GSL vector views are supported in classes
+     VectorView and VectorConstView
 
-     \par
-     Currently there is no restriction on how a vector is used when
-     the vector is a const view into another vector or matrix. To
-     avoid unexpected runtime errors, the programmer must declare
-     const view vectors as 'const' in order to get compile time
-     diagnostics about improper use of a const view vector object. If
-     'const' is not used and the const view vector is used erroneously
-     (such as on the left hand side in assignments), the compiler will
-     not catch the error and runtime error will occur. assert(3) is
-     used to catch the runtime error during development. Example on
-     bad and proper use of const view vectors:
-     @code
-  const vector vm(13,1.0);
-  vector v1(vm,2,4);       // bad code! not const!
-  v1(0)=-123;              // accepted by compiler, runtime abort will occur
-                           // or catched by assert depending on compiler flags
-  const vector v2(vm,2,4); // proper code
-  v2(0)=-123;              // not acceptable for the compiler
-     @endcode
   */
 
@@ -87 +61 @@
   {
   public:
-
     /**
        \brief The default constructor.
@@ -104 +77 @@
        \brief The copy constructor.
 
-       \note If the object to be copied is a vector view, the values
-       of the view will be copied, i.e. the view is not copied.
-
        \throw A GSL_error is indirectly thrown if memory allocation
        fails.
@@ -113 +83 @@
 
     /**
-       \brief The copy constructor.
-
-       \note If the object to be copied is a vector view, the values
-       of the view will be copied, i.e. the view is not copied.
+       \brief Copy a VectorBase.
 
        \throw A GSL_error is indirectly thrown if memory allocation
@@ -158 +125 @@
   private:
     const vector& assign(const VectorBase& other);
-    //const VectorBase& assign(VectorBase& other);
 
     /**