Changeset 790 for trunk/yat/utility/vector.h

Timestamp:

Mar 10, 2007, 9:49:31 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Addresses #193. Fixing doxygen docs, and operator=.

File:

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

trunk/yat/utility/vector.h

@@ -59 +59 @@
      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 owing the
-     data is deallocated.
+     underlying data, and a view is not valid if the vector/matrix
+     owing the data is deallocated.
 
      \par
@@ -81 +81 @@
   v2(0)=-123;              // not acceptable for the compiler
      @endcode
-
-     @note Missing support to underlying GSL vector features can in
-     principle be included to this class if requested by the user
-     community.
   */
 
@@ -349 +345 @@
        \return True if all elements are equal otherwise false.
 
-       \see equal
+       \see equal(const vector&, const double precision=0)
     */
     bool operator==(const vector&) const;
@@ -362 +358 @@
        \return False if all elements are equal otherwise true.
 
-       \see equal
+       \see equal(const vector&, const double precision=0)
     */
     bool operator!=(const vector&) const;
@@ -374 +370 @@
        \brief The assignment operator.
 
-       There is no requirements on dimensions, i.e. the vector is
-       remapped in memory if necessary. This implies that in general
-       views cannot be assigned using this operator. Views will be
-       mutated into normal vectors. The only exception to this
-       behaviour on views is when self-assignemnt is done, since
-       self-assignment is ignored.
+       Dimensions of the vectors must match. If the LHS vector is a
+       view, the underlying data will be changed.
 
        \return A const reference to the resulting vector.
@@ -385 +377 @@
        \see void set(const vector&).
 
-       \throw A GSL_error is indirectly thrown if memory allocation
-       fails, or if dimensions mis-match.
+       \throw GSL_error if dimensions mis-match.
     */
     const vector& operator=(const vector&);