[lmi-commits] [lmi] master dd6ee0a 9/9: Improve documentation

[Greg Chicares]

branch: master
commit dd6ee0ac9972446fe25ea0735c52195ef4ca77cd
Author: Gregory W. Chicares <gchicares@sbcglobal.net>
Commit: Gregory W. Chicares <gchicares@sbcglobal.net>

    Improve documentation
---
 i7702.cpp      | 16 ++--------------
 i7702_init.cpp |  2 +-
 2 files changed, 3 insertions(+), 15 deletions(-)

diff --git a/i7702.cpp b/i7702.cpp
index 808b661..8f2c91c 100644
--- a/i7702.cpp
+++ b/i7702.cpp
@@ -152,8 +152,8 @@
 /// such charges on asset or premium tiers, which D cannot do.
 ///
 /// For contracts that require an irrevocable choice, before delivery,
-/// between a fixed and a variable loan rate, the path not chosen need
-/// not be considered.
+/// between a fixed and a variable loan rate, the loan path not chosen
+/// need not be considered (but lmi doesn't yet implement VLR).
 ///
 /// Idea not implemented: optionally set all ig* equal to E. The SOA
 /// textbook (page 52) supports treating it as "a contractual element
@@ -162,18 +162,6 @@
 /// interpretation, which most often produces materially the same
 /// result. If a contract specifies E as the monthly equivalent of
 /// any rate other than Bgen, that's presumably just a mistake.
-///
-/// Present shortcomings of the code in this file:
-///   [first change names to follow scheme above, adding new ones]
-///   implementation is too simplistic:
-///     igross: max(A0, Bmax)
-///     iglp:   max(A0, Bmax) - D
-///     igsp:   max(A1, Bmax) - D
-///     ig:     max(A0, E)
-///   ig problems:
-///     A1 ignored: must reflect +2% for GSP
-///       and that 2% extra should be parameterized
-///     use contractual rates if greater
 
 i7702::i7702
     (int                        length
diff --git a/i7702_init.cpp b/i7702_init.cpp
index fcabe4c..b454775 100644
--- a/i7702_init.cpp
+++ b/i7702_init.cpp
@@ -130,7 +130,7 @@ i7702::i7702
     //   [0V + P - Q(1/(1 + ig) - OV - P)] (1 + ic) = 1V
     // where it is the monthly (i upper 12 over 12) equivalent of
     // the annual 'Bgen_' rate above. Specifying a discount based on
-    // any other rate is presumably an error.
+    // any other rate is presumably a product-design error.
     //
     // In lmi's product database, DB_GuarInt is i. DB_NaarDiscount is
     // (i upper 12)/12, rounded iff the contract specifies a rounded