Changeset 788 for trunk/yat

Timestamp:

Mar 10, 2007, 8:59:51 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Improved comparison operator and equal function doxygen doc. Added for self comparison in equal.

Location:

trunk/yat/utility

Files:

• matrix.cc (modified) (1 diff)
• matrix.h (modified) (2 diffs)

trunk/yat/utility/matrix.cc

@@ -189 +189 @@
   bool matrix::equal(const matrix& other, const double d) const
   {
+    if (this==&other)
+      return true;
     if (columns()!=other.columns() || rows()!=other.rows())
       return false;

trunk/yat/utility/matrix.h

@@ -157 +157 @@
     void div_elements(const matrix& b);
 
-    ///
-    /// Check whether matrices are equal within a user defined
-    /// precision, set by \a precision.
-    ///
-    /// @return True if each element deviates less or equal than \a
-    /// d. If any matrix contain a NaN, false is always returned.
-    ///
+    /**
+       \brief Check whether matrices are equal within a user defined
+       precision, set by \a precision.
+
+       \return True if each element deviates less or equal than \a
+       d. If any matrix contain a NaN, false is always returned.
+
+       \see operator== and operator!=
+    */
     bool equal(const matrix&, const double precision=0) const;
 
@@ -289 +291 @@
     const double& operator()(size_t row,size_t column) const;
 
-    ///
-    /// @brief Comparison operator.
-    ///
-    /// @return True if all elements are equal otherwise False.
-    ///
-    /// @see equal
-    ///
+    /**
+       \brief Comparison operator. Takes squared time.
+
+       Checks are performed with exact matching, i.e., rounding off
+       effects may destroy comparison. Use the equal function for
+       comparing elements within a user defined precision.
+
+       \return True if all elements are equal otherwise false.
+
+       \see equal
+    */
     bool operator==(const matrix& other) const;
 
-    ///
-    /// @brief Comparison operator.
-    ///
-    /// @return False if all elements are equal otherwise True.
-    ///
-    /// @see equal
-    ///
+    /**
+       \brief Comparison operator. Takes squared time.
+
+       Checks are performed with exact matching, i.e., rounding off
+       effects may destroy comparison. Use the equal function for
+       comparing elements within a user defined precision.
+
+       \return False if all elements are equal otherwise true.
+
+       \see equal
+    */
     bool operator!=(const matrix& other) const;