Changeset 755 for trunk/yat/utility/matrix.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/matrix.h (modified) (4 diffs)

trunk/yat/utility/matrix.h

@@ -168 +168 @@
     size_t columns(void) const;
 
-    ///
-    /// Elementwise division of the elemnts of the calling matrix by
-    /// the elements of matrix \a b, \f$ a_{ij} = a_{ij} / b_{ij} \;
-    /// \forall i,j \f$. The result is stored into the calling matrix.
-    ///
-    /// @return Whatever GSL returns.
-    ///
-    int div_elements(const matrix& b);
+    /**
+       Elementwise division of the elemnts of the calling matrix by
+       the elements of matrix \a b, \f$ a_{ij} = a_{ij} / b_{ij} \;
+       \forall i,j \f$. The result is stored into the calling matrix.
+
+       \throw GSL_error if dimensions mis-match.
+    */
+    void div_elements(const matrix& b);
 
     ///
@@ -238 +238 @@
     bool nan(matrix&) const;
 
-    ///
-    /// Multiply the elements of matrix \a b with the elements of the
-    /// calling matrix ,\f$ a_{ij} = a_{ij} * b_{ij} \; \forall
-    /// i,j \f$. The result is stored into the calling matrix.
-    ///
-    /// @return Whatever GSL returns.
-    ///
-    int
-    mul_elements(const matrix& b);
+    /**
+       Multiply the elements of matrix \a b with the elements of the
+       calling matrix ,\f$ a_{ij} = a_{ij} * b_{ij} \; \forall i,j
+       \f$. The result is stored into the calling matrix.
+
+       \throw GSL_error if dimensions mis-match.
+    */
+    void mul_elements(const matrix& b);
 
     ///
@@ -305 +304 @@
     void sub(const matrix& b);
 
-    ///
-    /// Exchange the elements of the this and \a other by copying. The
-    /// two matrices must have the same size.
-    ///
-    /// @return Whatever GSL returns.
-    ///
-    int swap(matrix& other);
-
-    ///
-    /// @brief Swap columns \a i and \a j.
-    ///
-    int swap_columns(const size_t i,const size_t j);
-
-    ///
-    /// @brief Swap row \a i and column \a j.
-    ///
-    int swap_rowcol(const size_t i,const size_t j);
-
-    ///
-    /// @brief Swap rows \a i and \a j.
-    ///
-    int swap_rows(const size_t i, const size_t j);
+    /**
+       \brief Exchange the elements of the this and \a other by copying.
+
+       The two matrices must have the same size.
+
+       \throw GSL_error if either index is out of bounds.
+    */
+    void swap(matrix& other);
+
+    /**
+       \brief Swap columns \a i and \a j.
+
+       \throw GSL_error if either index is out of bounds.
+    */
+    void swap_columns(const size_t i,const size_t j);
+
+    /**
+       \brief Swap row \a i and column \a j.
+
+       \throw GSL_error if either index is out of bounds, or if matrix
+       is not square.
+    */
+    void swap_rowcol(const size_t i,const size_t j);
+
+    /**
+       \brief Swap rows \a i and \a j.
+
+       \throw GSL_error if either index is out of bounds.
+    */
+    void swap_rows(const size_t i, const size_t j);
 
     /**
@@ -336 +343 @@
     void transpose(void);
 
-    ///
-    /// @return Reference to the element position (\a row, \a column).
-    ///
+    /**
+       \brief Element access operator.
+
+       \return Reference to the element position (\a row, \a column).
+
+       \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 row,size_t column);
 
-    ///
-    /// @return Const reference to the element position (\a row, \a
-    /// column).
-    ///
+    /**
+       \brief Element access operator.
+
+       \return Const reference to the element position (\a row, \a
+       column).
+
+       \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 row,size_t column) const;