[lmi-commits] [5778] Improve documentation

[Greg Chicares]

Revision: 5778
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5778
Author:   chicares
Date:     2013-10-03 08:07:20 +0000 (Thu, 03 Oct 2013)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/gpt_commutation_functions.cpp
    lmi/trunk/gpt_commutation_functions.hpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2013-09-30 21:19:16 UTC (rev 5777)
+++ lmi/trunk/ChangeLog 2013-10-03 08:07:20 UTC (rev 5778)
@@ -32610,3 +32610,9 @@
   gpt_commutation_functions.hpp
 Implement special commutation functions for GPT.
 
+20131003T0807Z <address@hidden> [542]
+
+  gpt_commutation_functions.cpp
+  gpt_commutation_functions.hpp
+Improve documentation.
+

Modified: lmi/trunk/gpt_commutation_functions.cpp
===================================================================
--- lmi/trunk/gpt_commutation_functions.cpp     2013-09-30 21:19:16 UTC (rev 
5777)
+++ lmi/trunk/gpt_commutation_functions.cpp     2013-10-03 08:07:20 UTC (rev 
5778)
@@ -62,6 +62,10 @@
 /// effect belong upstream; however, writing them in the body of
 /// gpt_cf_triad::gpt_cf_triad() would cause them to be executed
 /// after the present ctor is called.
+///
+/// We are aware of one old UL policy form that accumulates values
+/// quarterly instead of monthly. This could be accommodated by adding
+/// an extra parameter, but doesn't seem worth the trouble.
 
 gpt_commfns::gpt_commfns
     (std::vector<double> const& qc
@@ -173,7 +177,14 @@
 
 /// Calculate GLP or GSP.
 ///
-/// For GSP, 'dbo' is disregarded.
+/// For GSP, 'dbo' is disregarded because it is irrelevant. That
+/// argument might instead have been written last and defaulted for
+/// calls that calculate GSP, but that's needlessly complicated.
+/// Alternatively, distinct functions might have been provided for
+/// GLP and GSP calculations, but that's not worth the bother; or
+/// a single function might calculate and return a {GLP,GSP} pair,
+/// but then sometimes one would need to be thrown away (as when
+/// specified amount is determined by a GLP or GSP strategy).
 
 double gpt_cf_triad::calculate_premium
     (oenum_glp_or_gsp        glp_or_gsp

Modified: lmi/trunk/gpt_commutation_functions.hpp
===================================================================
--- lmi/trunk/gpt_commutation_functions.hpp     2013-09-30 21:19:16 UTC (rev 
5777)
+++ lmi/trunk/gpt_commutation_functions.hpp     2013-10-03 08:07:20 UTC (rev 
5778)
@@ -44,6 +44,15 @@
 /// conversion from annual to monthly, subject to some maximum or
 /// minimum--so leaving them out makes const objects of this class
 /// potentially more useful.
+///
+/// Vector parameters run from issue age through the 7702(e)(1)(B)
+/// maturity age (thus, neither issue nor maturity age is needed).
+/// They are assumed to include any applicable rating, such as an
+/// occupational extra on an accident benefit.
+///
+/// Term rates on the main insured ('qab_term_rate') apply only to
+/// coverage not treated as "death benefit"; decreasing term is
+/// treated here as level.
 
 struct gpt_vector_parms
 {
@@ -161,6 +170,10 @@
 
 /// Specialized GPT commutation functions on the three required bases.
 ///
+/// '*_ig' (monthly effective death-benefit discount rate for NAAR) is
+/// distinct for GLP and GSP. Often it is the monthly equivalent of
+/// four and six percent, respectively.
+///
 /// Implicitly-declared special member functions do the right thing.
 
 class gpt_cf_triad