Changeset 774 for trunk/yat/utility/matrix.h

Timestamp:

Mar 1, 2007, 10:52:48 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #194.

File:

• trunk/yat/utility/matrix.h (modified) (4 diffs)

trunk/yat/utility/matrix.h

@@ -177 +177 @@
 
     ///
-    /// @return True if all elements in the matrix is zero, false
-    /// othwerwise;
-    ///
-    bool isnull(void) const;
-
-    ///
     /// @brief Check if the matrix object is a view (sub-matrix) to
     /// another matrix.
@@ -189 +183 @@
     ///
     bool isview(void) const;
-
-    ///
-    /// @return The maximum value of the matrix.
-    ///
-    double max(void) const;
-
-    ///
-    /// @return The minimum value of the matrix.
-    ///
-    double min(void) const;
-
-    ///
-    /// @return The indecies to the element with the minimum and
-    /// maximum values of the matrix, respectively. The lowest index
-    /// has precedence (searching in row-major order).
-    ///
-    void minmax_index(std::pair<size_t,size_t>& min,
-                      std::pair<size_t,size_t>& max) const;
-
-    ///
-    /// The argument is changed into a matrix containing 1's and 0's
-    /// only. 1 means element in matrix is valid and a zero means
-    /// element is a NaN.
-    ///
-    /// @return true if matrix contains at least one NaN.
-    ///
-    bool nan(matrix&) const;
 
     /**
@@ -266 +233 @@
     */
     void set_row(const size_t row, const vector& vec);
-
-    /**
-       \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);
 
     /**
@@ -453 +411 @@
   };
 
-  ///
-  /// The output operator for the matrix class.
-  ///
+  /**
+     \brief Check if all elements of the matrix are zero.
+
+     \return True if all elements in the matrix is zero, false othwerwise
+  */
+  bool isnull(const matrix&);
+
+  /**
+     \brief Get the maximum value in the matrix.
+
+     \return The maximum value of the matrix.
+  */
+  double max(const matrix&);
+
+  /**
+     \brief Get the minimum value in the matrix.
+
+     \return The minimum value of the matrix.
+  */
+  double min(const matrix&);
+
+  /**
+     \brief Locate the maximum and minumum element in the matrix.
+
+     \return The indecies to the element with the minimum and maximum
+     values of the matrix, respectively.
+
+     \note The lowest index has precedence (searching in row-major
+     order).
+  */
+  void minmax_index(const matrix&,
+                    std::pair<size_t,size_t>& min,
+                    std::pair<size_t,size_t>& max);
+
+  /**
+     \brief Create a matrix \a flag indicating NaN's in another matrix
+     \a templat.
+
+     The \a flag matrix is changed to contain 1's and 0's only. A 1
+     means that the corresponding element in the \a templat matrix is
+     valid and a zero means that the corresponding element is a NaN.
+
+     \note Space for matrix \a flag is reallocated to fit the size of
+     matrix \a templat if sizes mismatch.
+
+     \return True if the \a templat matrix contains at least one NaN.
+  */
+  bool nan(const matrix& templat, matrix& flag);
+
+  /**
+     \brief Exchange all elements between the matrices by copying.
+
+     The two matrices must have the same size.
+
+     \throw GSL_error if either index is out of bounds.
+  */
+  void swap(matrix&, matrix&);
+
+  /**
+     \brief The output operator for the matrix class.
+  */
   std::ostream& operator<< (std::ostream& s, const matrix&);