[lmi-commits] [4899] Improve documentation

[Greg Chicares]

Revision: 4899
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=4899
Author:   chicares
Date:     2010-05-03 23:14:41 +0000 (Mon, 03 May 2010)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/dbvalue.cpp

Modified: lmi/trunk/dbvalue.cpp
===================================================================
--- lmi/trunk/dbvalue.cpp       2010-05-03 22:53:19 UTC (rev 4898)
+++ lmi/trunk/dbvalue.cpp       2010-05-03 23:14:41 UTC (rev 4899)
@@ -61,7 +61,14 @@
     return z;
 }
 
-//============================================================================
+/// Ascertain whether two database entities are equivalent.
+///
+/// Equivalence here means that the dimensions and data are identical.
+/// For example, these distinct entities:
+///  - DB_PremTaxRate (what the state charges the insurer)
+///  - DB_PremTaxLoad (what the insurer charges the customer)
+/// may be equivalent when premium tax is passed through as a load.
+
 bool TDBValue::Equivalent(TDBValue const& a, TDBValue const& b)
 {
     return(a.axis_lengths_ == b.axis_lengths_ && a.data_values_ == 
b.data_values_);
@@ -225,7 +232,6 @@
         }
 
     int z = 0;
-    // TODO ?? Can we use an STL algorithm instead?
     for(unsigned int j = 0; j < axis_lengths_.size(); j++)
         {
         if(1 != axis_lengths_[j])
@@ -255,7 +261,6 @@
 
     LMI_ASSERT(0 < axis_lengths_.size());
     int z = 0;
-    // TODO ?? Can we use an STL algorithm instead?
     for(unsigned int j = 0; j < axis_lengths_.size() - 1; j++)
         {
         if(1 != axis_lengths_[j])