gdlc 2.6.0.1 → 3.0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1a0919c15afe48e744fce7a1da83d32c81beb3d1
4
- data.tar.gz: 35e531d611f2d27d745c5e9a94e127a10ec75cfb
3
+ metadata.gz: 583f4e7997192e155acd950c48ee1d09d608aa8f
4
+ data.tar.gz: 9f5a38af7959c8db2fb03aad4b31af90c4fd56d2
5
5
  SHA512:
6
- metadata.gz: 37226573050c34f0920513e036d209e2771db6ce4df748f85f5bd1da81dda1138e5f8eb59fb3a6b60efcd3556bf83e868989b04bf5bcb1da0210e604e85415ee
7
- data.tar.gz: 9db01034212947ee4fb77d86251910752da4f1b6567ee7d7c674cbb2f4ecf59c9f3729f866ec3699ddd0fcf798f0b3fb4ac8d17e84a8b945ced6b5b2666e88b1
6
+ metadata.gz: 0b9f116e45993071a4ef3983f32d9c2ee39fdadd1be5a1c903c1083a11a37df06c644e38020faa2c4c981efbe53c93a11ee5f79a961c94b13ff95da124a78bbc
7
+ data.tar.gz: e14439eb69dad310a9bb89d971b31da34fd7ceece8d0cf159dabda529d9878d707132a38436040b50b2be7afae85be9eb6a1f841b64a2ca5ef3a761321203ae4
@@ -162,6 +162,7 @@
162
162
  <li><span class="h4toc"><a href="#Definitions.0">Definitions</a></span></li>
163
163
  <li><span class="h5toc"><a href="#Examples.0">Examples</a></span></li>
164
164
  <li><span class="h5toc"><a href="#Types.0">Types</a></span></li>
165
+ <li><span class="h5toc"><a href="#Example">Example</a></span></li>
165
166
  <li><span class="h4toc"><a href="#References">References</a></span></li>
166
167
  <li><span class="h3toc"><a href="#DSMs">DSMs</a></span></li>
167
168
  <li><span class="h4toc"><a href="#Definitions.1">Definitions</a></span></li>
@@ -468,7 +469,17 @@ dpm money loanAmount "Loan Amount";
468
469
  </ul>
469
470
 
470
471
 
471
- <p>TODO: NUMERIC PRECISION</p>
472
+ <p>To specify the <em>visible</em> precision of a numeric value, surround the desired
473
+ precision with parens immediately after the <code>numeric</code> keyword.</p>
474
+
475
+ <p>Note that this doesn't affect the actual precision of the variable's value
476
+ when used in calculations (16 places), only how it is displayed to the user.</p>
477
+
478
+ <a name="Example"></a>
479
+ <h5>Example</h5>
480
+
481
+ <pre><code>dpm numeric(2) loanAmount "Loan Amount";
482
+ </code></pre>
472
483
 
473
484
  <a name="References"></a>
474
485
  <h4>References</h4>
@@ -514,16 +525,27 @@ level error will be thrown.</p>
514
525
  <a name="Definitions.2"></a>
515
526
  <h3>Definitions</h3>
516
527
 
528
+ <p><em>Prior to 3.0:</em></p>
529
+
517
530
  <pre><code>lookup("Lookup Name", xParameterVariable, yParameterVariable);
518
531
  </code></pre>
519
532
 
533
+ <p><em>3.0 +</em></p>
534
+
535
+ <pre><code>lookup("Lookup Name");
536
+ </code></pre>
537
+
538
+ <p>The <code>Xparameter</code> and <code>Yparameter</code> details are now included as part of the Lookup
539
+ data. Previously, the parameters were defined in the <code>lookup</code> declaration
540
+ statement (above).</p>
541
+
520
542
  <a name="References.1"></a>
521
543
  <h3>References</h3>
522
544
 
523
545
  <p>This statement defines a lookup and returns the looked-up value. It can be used
524
546
  on the right hand side of an assignment ( <code>=</code> ) statement.</p>
525
547
 
526
- <pre><code>aValue = lookup("FHA-ClosingCostState", pSubjectPropertyState, globalParam);
548
+ <pre><code>aValue = lookup("FHA-ClosingCostState");
527
549
  </code></pre>
528
550
 
529
551
  <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>
540
562
  <a name="Definitions.3"></a>
541
563
  <h3>Definitions</h3>
542
564
 
543
- <p>TODO: Need more info here.</p>
544
-
545
- <pre><code>Example needed.
546
- </code></pre>
565
+ <p>PowerLookups are just <code>Ruleset</code>s defined within a <code>xls/csv</code> file.
566
+ As such, there are no special definition statements for PLKs.</p>
547
567
 
548
568
  <a name="References.2"></a>
549
569
  <h3>References</h3>
550
570
 
571
+ <p>Because PowerLookups are simply Rulesets, they are referenced the
572
+ same way any other ruleset is referenced:</p>
573
+
574
+ <pre><code>ruleset SomeRuleset();
575
+ </code></pre>
576
+
577
+ <p>Prior to referencing a PowerLookup ruleset, the ruleset must be
578
+ <code>import</code>ed.</p>
579
+
551
580
  <hr>
552
581
 
553
582
  <a name="Rules"></a>
@@ -716,7 +745,7 @@ has already been defined, use this syntax:</p>
716
745
  <a name="Definitions.5"></a>
717
746
  <h3>Definitions</h3>
718
747
 
719
- <p>TODO: Missing info about 'PL' modifier keyword.</p>
748
+ <p><em>TODO: Missing info about 'PL' modifier keyword.</em></p>
720
749
 
721
750
  <pre><code>ruleset InitAppraisedValue(continue)
722
751
 
@@ -919,9 +948,9 @@ When using DPM variables within messages, if the DPM/DSM has an alias
919
948
  defined, the alias must be used; the engine only recognizes/knows about the
920
949
  alias.</p>
921
950
 
922
- <p>TODO: IS THIS STILL TRUE (ABOUT ALIASES)?</p>
951
+ <p><em>TODO: IS THIS STILL TRUE (ABOUT ALIASES)?</em></p>
923
952
 
924
- <p>TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.</p>
953
+ <p><em>TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.</em></p>
925
954
 
926
955
  <p>Message definition statements must be terminated with a <code>;</code>.</p>
927
956
 
@@ -1135,6 +1164,22 @@ as part of the filename.</p>
1135
1164
 
1136
1165
  <p>The <code>lookup</code> import type will import Lookup matricies from a CSV file.</p>
1137
1166
 
1167
+ <p><em>Prior to 3.0</em></p>
1168
+
1169
+ <p>The expected format of a lookup table is:</p>
1170
+
1171
+ <p><img src="img/old_lookup_format.png" title="Pre 3.0 Lookup Format" alt="Old Lookup format"></p>
1172
+
1173
+ <p><em>3.0 +</em></p>
1174
+
1175
+ <p>The expected format is now:</p>
1176
+
1177
+ <p><img src="img/new_lookup_format.png" title="3.0 Lookup Format" alt="New Lookup format"></p>
1178
+
1179
+ <p>The <code>Xparameter</code> and <code>Yparameter</code> details are now included as part of the Lookup
1180
+ data. Previously, the parameters were defined in the <code>lookup</code> declaration
1181
+ statement.</p>
1182
+
1138
1183
  <hr>
1139
1184
 
1140
1185
  <a name="PowerLookup.Files"></a>
@@ -206,7 +206,15 @@ The type of data the variable will contain:
206
206
  + `text`
207
207
  + `datetime`
208
208
 
209
- TODO: NUMERIC PRECISION
209
+ To specify the _visible_ precision of a numeric value, surround the desired
210
+ precision with parens immediately after the `numeric` keyword.
211
+
212
+ Note that this doesn't affect the actual precision of the variable's value
213
+ when used in calculations (16 places), only how it is displayed to the user.
214
+
215
+ ##### Example
216
+
217
+ dpm numeric(2) loanAmount "Loan Amount";
210
218
 
211
219
  #### References
212
220
 
@@ -241,14 +249,24 @@ _This restriction does not apply to the AMS Guideline Engine._
241
249
 
242
250
  ### Definitions
243
251
 
252
+ _Prior to 3.0:_
253
+
244
254
  lookup("Lookup Name", xParameterVariable, yParameterVariable);
245
255
 
256
+ _3.0 +_
257
+
258
+ lookup("Lookup Name");
259
+
260
+ The `Xparameter` and `Yparameter` details are now included as part of the Lookup
261
+ data. Previously, the parameters were defined in the `lookup` declaration
262
+ statement (above).
263
+
246
264
  ### References
247
265
 
248
266
  This statement defines a lookup and returns the looked-up value. It can be used
249
267
  on the right hand side of an assignment ( `=` ) statement.
250
268
 
251
- aValue = lookup("FHA-ClosingCostState", pSubjectPropertyState, globalParam);
269
+ aValue = lookup("FHA-ClosingCostState");
252
270
 
253
271
  When a lookup is defined, the compiler searches for the lookup data in memory.
254
272
  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 `;`.
262
280
 
263
281
  ### Definitions
264
282
 
265
- TODO: Need more info here.
266
-
267
- Example needed.
283
+ PowerLookups are just `Ruleset`s defined within a `xls/csv` file.
284
+ As such, there are no special definition statements for PLKs.
268
285
 
269
286
  ### References
270
287
 
288
+ Because PowerLookups are simply Rulesets, they are referenced the
289
+ same way any other ruleset is referenced:
290
+
291
+ ruleset SomeRuleset();
292
+
293
+ Prior to referencing a PowerLookup ruleset, the ruleset must be
294
+ `import`ed.
295
+
271
296
  - - -
272
297
  ## Rules
273
298
 
@@ -420,7 +445,7 @@ has already been defined, use this syntax:
420
445
 
421
446
  ### Definitions
422
447
 
423
- TODO: Missing info about 'PL' modifier keyword.
448
+ _TODO: Missing info about 'PL' modifier keyword._
424
449
 
425
450
  ruleset InitAppraisedValue(continue)
426
451
 
@@ -590,9 +615,9 @@ When using DPM variables within messages, if the DPM/DSM has an alias
590
615
  defined, the alias must be used; the engine only recognizes/knows about the
591
616
  alias.
592
617
 
593
- TODO: IS THIS STILL TRUE (ABOUT ALIASES)?
618
+ _TODO: IS THIS STILL TRUE (ABOUT ALIASES)?_
594
619
 
595
- TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS.
620
+ _TODO: DISCUSS THE ABILITY TO UNDERSTAND ALIAS' WHEN PULLING FROM PLKS._
596
621
 
597
622
  Message definition statements must be terminated with a `;`.
598
623
 
@@ -771,6 +796,24 @@ Imported files must also be on the inclusion path.
771
796
 
772
797
  The `lookup` import type will import Lookup matricies from a CSV file.
773
798
 
799
+ _Prior to 3.0_
800
+
801
+ The expected format of a lookup table is:
802
+
803
+ ![Old Lookup format](img/old_lookup_format.png "Pre 3.0 Lookup Format")
804
+
805
+ _3.0 +_
806
+
807
+ The expected format is now:
808
+
809
+
810
+ ![New Lookup format](img/new_lookup_format.png "3.0 Lookup Format")
811
+
812
+
813
+ The `Xparameter` and `Yparameter` details are now included as part of the Lookup
814
+ data. Previously, the parameters were defined in the `lookup` declaration
815
+ statement.
816
+
774
817
  - - -
775
818
  ### PowerLookup Files
776
819
 
@@ -16,7 +16,7 @@
16
16
  #
17
17
 
18
18
  module Gdlc
19
- VERSION = "2.6.0.1" unless constants.include?("VERSION")
19
+ VERSION = "3.0.0.0" unless constants.include?("VERSION")
20
20
  APPNAME = "GDLC" unless constants.include?("APPNAME")
21
21
  COPYRIGHT = "Copyright (c) 2016 Jeff McAffee. All rights reserved" unless constants.include?("COPYRIGHT")
22
22
  end
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gdlc
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.6.0.1
4
+ version: 3.0.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jeff McAffee