gdlc 2.6.0.1 → 3.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0919c15afe48e744fce7a1da83d32c81beb3d1
-  data.tar.gz: 35e531d611f2d27d745c5e9a94e127a10ec75cfb
+  metadata.gz: 583f4e7997192e155acd950c48ee1d09d608aa8f
+  data.tar.gz: 9f5a38af7959c8db2fb03aad4b31af90c4fd56d2
 SHA512:
-  metadata.gz: 37226573050c34f0920513e036d209e2771db6ce4df748f85f5bd1da81dda1138e5f8eb59fb3a6b60efcd3556bf83e868989b04bf5bcb1da0210e604e85415ee
-  data.tar.gz: 9db01034212947ee4fb77d86251910752da4f1b6567ee7d7c674cbb2f4ecf59c9f3729f866ec3699ddd0fcf798f0b3fb4ac8d17e84a8b945ced6b5b2666e88b1
+  metadata.gz: 0b9f116e45993071a4ef3983f32d9c2ee39fdadd1be5a1c903c1083a11a37df06c644e38020faa2c4c981efbe53c93a11ee5f79a961c94b13ff95da124a78bbc
+  data.tar.gz: e14439eb69dad310a9bb89d971b31da34fd7ceece8d0cf159dabda529d9878d707132a38436040b50b2be7afae85be9eb6a1f841b64a2ca5ef3a761321203ae4

data/docs/GDLC_manual.html

@@ -162,6 +162,7 @@
 <li><span class="h4toc"><a href="#Definitions.0">Definitions</a></span></li>
 <li><span class="h5toc"><a href="#Examples.0">Examples</a></span></li>
 <li><span class="h5toc"><a href="#Types.0">Types</a></span></li>
+<li><span class="h5toc"><a href="#Example">Example</a></span></li>
 <li><span class="h4toc"><a href="#References">References</a></span></li>
 <li><span class="h3toc"><a href="#DSMs">DSMs</a></span></li>
 <li><span class="h4toc"><a href="#Definitions.1">Definitions</a></span></li>
@@ -468,7 +469,17 @@ dpm money loanAmount "Loan Amount";
 </ul>
 
 
-<p>TODO: NUMERIC PRECISION</p>
+<p>To specify the <em>visible</em> precision of a numeric value, surround the desired
+precision with parens immediately after the <code>numeric</code> keyword.</p>
+
+<p>Note that this doesn't affect the actual precision of the variable's value
+when used in calculations (16 places), only how it is displayed to the user.</p>
+
+<a name="Example"></a>
+<h5>Example</h5>
+
+<pre><code>dpm numeric(2) loanAmount "Loan Amount";
+</code></pre>
 
 <a name="References"></a>
 <h4>References</h4>
@@ -514,16 +525,27 @@ level error will be thrown.</p>
 <a name="Definitions.2"></a>
 <h3>Definitions</h3>
 
+<p><em>Prior to 3.0:</em></p>
+
 <pre><code>lookup("Lookup Name", xParameterVariable, yParameterVariable);
 </code></pre>
 
+<p><em>3.0 +</em></p>
+
+<pre><code>lookup("Lookup Name");
+</code></pre>
+
+<p>The <code>Xparameter</code> and <code>Yparameter</code> details are now included as part of the Lookup
+data. Previously, the parameters were defined in the <code>lookup</code> declaration
+statement (above).</p>
+
 <a name="References.1"></a>
 <h3>References</h3>
 
 <p>This statement defines a lookup and returns the looked-up value. It can be used
 on the right hand side of an assignment ( <code>=</code> ) statement.</p>
 
-<pre><code>aValue = lookup("FHA-ClosingCostState", pSubjectPropertyState, globalParam);
+<pre><code>aValue = lookup("FHA-ClosingCostState");
 </code></pre>
 
 <p>When a lookup is defined, the compiler searches for the lookup data in memory.
@@ -540,14 +562,21 @@ for how to load lookup data.</p>
 <a name="Definitions.3"></a>
 <h3>Definitions</h3>
 
-<p>TODO: Need more info here.</p>
-
-<pre><code>Example needed.
-</code></pre>
+<p>PowerLookups are just <code>Ruleset</code>s defined within a <code>xls/csv</code> file.
+As such, there are no special definition statements for PLKs.</p>
 
 <a name="References.2"></a>
 <h3>References</h3>
 
+<p>Because PowerLookups are simply Rulesets, they are referenced the
+same way any other ruleset is referenced:</p>
+
+<pre><code>ruleset SomeRuleset();
+</code></pre>
+
+<p>Prior to referencing a PowerLookup ruleset, the ruleset must be
+<code>import</code>ed.</p>
+
 <hr>
 
 <a name="Rules"></a>
@@ -716,7 +745,7 @@ has already been defined, use this syntax:</p>
 <a name="Definitions.5"></a>
 <h3>Definitions</h3>
 
-<p>TODO: Missing info about 'PL' modifier keyword.</p>
+<p><em>TODO: Missing info about 'PL' modifier keyword.</em></p>
 
 <pre><code>ruleset InitAppraisedValue(continue)
 
@@ -919,9 +948,9 @@ When using DPM variables within messages, if the DPM/DSM has an alias
 defined, the alias must be used; the engine only recognizes/knows about the
 alias.</p>
 
-<p>TODO: IS THIS STILL TRUE (ABOUT ALIASES)?</p>
+<p><em>TODO: IS THIS STILL TRUE (ABOUT ALIASES)?</em></p>
 
-<p>TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.</p>
+<p><em>TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.</em></p>
 
 <p>Message definition statements must be terminated with a <code>;</code>.</p>
 
@@ -1135,6 +1164,22 @@ as part of the filename.</p>
 
 <p>The <code>lookup</code> import type will import Lookup matricies from a CSV file.</p>
 
+<p><em>Prior to 3.0</em></p>
+
+<p>The expected format of a lookup table is:</p>
+
+<p><img src="img/old_lookup_format.png" title="Pre 3.0 Lookup Format" alt="Old Lookup format"></p>
+
+<p><em>3.0 +</em></p>
+
+<p>The expected format is now:</p>
+
+<p><img src="img/new_lookup_format.png" title="3.0 Lookup Format" alt="New Lookup format"></p>
+
+<p>The <code>Xparameter</code> and <code>Yparameter</code> details are now included as part of the Lookup
+data. Previously, the parameters were defined in the <code>lookup</code> declaration
+statement.</p>
+
 <hr>
 
 <a name="PowerLookup.Files"></a>

data/docs/GDLC_manual.md

@@ -206,7 +206,15 @@ The type of data the variable will contain:
 + `text`
 + `datetime`
 
-TODO: NUMERIC PRECISION
+To specify the _visible_ precision of a numeric value, surround the desired
+precision with parens immediately after the `numeric` keyword.
+
+Note that this doesn't affect the actual precision of the variable's value
+when used in calculations (16 places), only how it is displayed to the user.
+
+##### Example
+
+    dpm numeric(2) loanAmount "Loan Amount";
 
 #### References
 
@@ -241,14 +249,24 @@ _This restriction does not apply to the AMS Guideline Engine._
 
 ### Definitions
 
+_Prior to 3.0:_
+
     lookup("Lookup Name", xParameterVariable, yParameterVariable);
 
+_3.0 +_
+
+    lookup("Lookup Name");
+
+The `Xparameter` and `Yparameter` details are now included as part of the Lookup
+data. Previously, the parameters were defined in the `lookup` declaration
+statement (above).
+
 ### References
 
 This statement defines a lookup and returns the looked-up value. It can be used
 on the right hand side of an assignment ( `=` ) statement.
 
-    aValue = lookup("FHA-ClosingCostState", pSubjectPropertyState, globalParam);
+    aValue = lookup("FHA-ClosingCostState");
 
 When a lookup is defined, the compiler searches for the lookup data in memory.
 An error will be thrown if the data does not exist. See the `import` statement
@@ -262,12 +280,19 @@ All lookup definition/reference statements must be terminated with a `;`.
 
 ### Definitions
 
-TODO: Need more info here.
-
-    Example needed.
+PowerLookups are just `Ruleset`s defined within a `xls/csv` file.
+As such, there are no special definition statements for PLKs.
 
 ### References
 
+Because PowerLookups are simply Rulesets, they are referenced the
+same way any other ruleset is referenced:
+
+    ruleset SomeRuleset();
+
+Prior to referencing a PowerLookup ruleset, the ruleset must be
+`import`ed.
+
 - - -
 ## Rules
 
@@ -420,7 +445,7 @@ has already been defined, use this syntax:
 
 ### Definitions
 
-TODO: Missing info about 'PL' modifier keyword.
+_TODO: Missing info about 'PL' modifier keyword._
 
     ruleset InitAppraisedValue(continue)
 
@@ -590,9 +615,9 @@ When using DPM variables within messages, if the DPM/DSM has an alias
 defined, the alias must be used; the engine only recognizes/knows about the
 alias.
 
-TODO: IS THIS STILL TRUE (ABOUT ALIASES)?
+_TODO: IS THIS STILL TRUE (ABOUT ALIASES)?_
 
-TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.
+_TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS._
 
 Message definition statements must be terminated with a `;`.
 
@@ -771,6 +796,24 @@ Imported files must also be on the inclusion path.
 
 The `lookup` import type will import Lookup matricies from a CSV file.
 
+_Prior to 3.0_
+
+The expected format of a lookup table is:
+
+![Old Lookup format](img/old_lookup_format.png "Pre 3.0 Lookup Format")
+
+_3.0 +_
+
+The expected format is now:
+
+
+![New Lookup format](img/new_lookup_format.png "3.0 Lookup Format")
+
+
+The `Xparameter` and `Yparameter` details are now included as part of the Lookup
+data. Previously, the parameters were defined in the `lookup` declaration
+statement.
+
 - - -
 ### PowerLookup Files
 

data/lib/gdlc/version.rb

@@ -16,7 +16,7 @@
 #
 
 module Gdlc
-  VERSION = "2.6.0.1" unless constants.include?("VERSION")
+  VERSION = "3.0.0.0" unless constants.include?("VERSION")
   APPNAME = "GDLC" unless constants.include?("APPNAME")
   COPYRIGHT = "Copyright (c) 2016 Jeff McAffee. All rights reserved" unless constants.include?("COPYRIGHT")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gdlc
 version: !ruby/object:Gem::Version
-  version: 2.6.0.1
+  version: 3.0.0.0
 platform: ruby
 authors:
 - Jeff McAffee