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

Timestamp:

Feb 18, 2007, 1:01:39 AM (16 years ago)

Author:

Jari Häkkinen

Message:

Addresses #2 and #65. Continued adding GSL_error exceptions, and added doxygen briefs.

File:

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

trunk/yat/utility/vector.h

@@ -228 +228 @@
     void add(double term);
 
-    ///
-    /// This function performs element-wise division, \f$ this_i =
-    /// this_i/other_i \; \forall i \f$.
-    ///
-    /// @return GSL_SUCCESS on normal exit.
-    ///
-    // Jari, doxygen group as Vector operators
-    int div(const vector& other);
+    /**
+       \brief This function performs element-wise division, \f$ this_i =
+       this_i/other_i \; \forall i \f$.
+
+       \throw GSL_error if dimensions mis-match.
+    */
+    void div(const vector& other);
 
     ///
@@ -303 +302 @@
     std::pair<size_t,size_t> minmax_index(void) const;
 
-    ///
-    /// This function performs element-wise multiplication, \f$ this_i =
-    /// this_i * other_i \; \forall i \f$.
-    ///
-    /// @return GSL_SUCCESS on normal exit.
-    ///
-    // Jari, doxygen group as Vector operators
-    int mul(const vector& other);
-
-    ///
-    /// Reverse the order of elements in the vector.
-    ///
-    /// @return GSL_SUCCESS on normal exit.
-    ///
-    // Jari, doxygen group as Exchanging elements
-    int reverse(void);
+    /**
+       \brief This function performs element-wise multiplication, \f$
+       this_i = this_i * other_i \; \forall i \f$.
+
+       \throw GSL_error if dimensions mis-match.
+    */
+    void mul(const vector& other);
+
+    /**
+       \brief Reverse the order of elements in the vector.
+    */
+    void reverse(void);
 
     /**
@@ -384 +379 @@
     double sum(void) const;
 
-    ///
-    /// Swap vector elements by copying. The two vectors must have the
-    /// same length.
-    ///
-    /// @return GSL_SUCCESS on normal exit.
-    ///
-    int swap(vector& other);
-
-    ///
-    /// Exchange elements \a i and \a j.
-    ///
-    /// @return GSL_SUCCESS on normal exit.
-    ///
-    // Jari, doxygen group as Exchanging elements
-    int swap_elements(size_t i,size_t j);
-
-    ///
-    /// Element access operator.
-    ///
-    /// @return Reference to element \a i.
-    ///
-    // Jari, doxygen group as Accessing vector elements
+    /**
+       \brief Swap vector elements by copying.
+
+       The two vectors must have the same length.
+
+       \throw GSL_error if vector lengths differs.
+    */
+    void swap(vector& other);
+
+    /**
+       \brief Exchange elements \a i and \a j.
+
+       \throw GSL_error if vector lengths differs.
+    */
+    void swap_elements(size_t i, size_t j);
+
+    /**
+       \brief Element access operator.
+
+       \return Reference to element \a i.
+
+       \throw If GSL range checks are enabled in the underlying GSL
+       library a GSL_error exception is thrown if either index is out
+       of range.
+    */
     double& operator()(size_t i);
 
-    ///
-    /// Const element access operator.
-    ///
-    /// @return The value of element \a i.
-    ///
-    // Jari, doxygen group as Accessing vector elements
+    /**
+       \brief Element access operator.
+
+       \return Const reference to element \a i.
+
+       \throw If GSL range checks are enabled in the underlying GSL
+       library a GSL_error exception is thrown if either index is out
+       of range.
+    */
     const double& operator()(size_t i) const;