documentation

src/main/java/edu/rpi/legup/puzzle/skyscrapers/rules/TODO.md

@@ -1,16 +1,22 @@
 ## TODO
 
+spreadsheet : https://docs.google.com/spreadsheets/d/1l7aUZtavtysM8dtGnaEIXhBKMRGxekhnLIVoYIHYZi8/edit#gid=0
+
  1. Basic Rules:
-	 - Last Cell
-	 - Last Number
-	 - 1-Edge
-	 - N-Edge
-	 - Fixed Max
+     - Check spreadsheet
  2. Contradiction Rules:
-	 - Duplicate Number
-	 - Unresolved Cell
-	 - Exceeding Visibility
-	 - Insufficient Visibility
+     - check spreadsheet
+     - UnresovedCell vs. NoNumberForCell (don't need both)
+     - No Cell for Number - implement w/ flags
  3. Case Rules:
-	 - Possible Contents
-	 - Possible Places
+     - Cell for number - waiting on ui, needs checkrule
+ 4. Refactoring:
+    - Remove references to lightup and treetent in variable names
+    - document utility functions in the reference sheet, COMMENTS!
+    - review and identify dead code
+    - create and add rule icons
+    - check for overrides of by cell functions (ie checkContradiction)
+ 5. Flags
+    - add to all case rules
+    - review all basic/contradiction rules to put in terms of the new cases / add flags
+    - edit importer and exporter to include flags in xml file format

src/main/java/edu/rpi/legup/puzzle/skyscrapers/rules/skyscrapers_reference_sheet.txt

@@ -1,12 +1,27 @@
-SKYS-BASC-0001 : FixedMaxBasicRule
-SKYS-BASC-0002 : LastCellBasicRule
-SKYS-BASC-0003 : LastNUmberBasicRule
-SKYS-BASC-0004 : NEdgeBasicRule
-SKYS-BASC-0005 : OneEdgeBasicRule
-
-SKYS-CONT-0001 : DuplicateNumbersContradictionRule
-SKYS-CONT-0002 : ExceedingVisibilityContradictionRule
-SKYS-CONT-0003 : InsufficientVisibilityContradictionRule
-SKYS-CONT-0004 : UnresolvedCellContradictionRule
-
-SKYS-CASE-0001 : PossibleContentsCaseRule
+RULE LIST:
+    SKYS-BASC-0001 : FixedMaxBasicRule
+    SKYS-BASC-0002 : LastCellBasicRule
+    SKYS-BASC-0003 : LastNumberBasicRule
+    SKYS-BASC-0004 : NEdgeBasicRule
+    SKYS-BASC-0005 : OneEdgeBasicRule
+
+    SKYS-CONT-0001 : DuplicateNumbersContradictionRule
+    SKYS-CONT-0002 : ExceedingVisibilityContradictionRule
+    SKYS-CONT-0003 : InsufficientVisibilityContradictionRule
+    SKYS-CONT-0004 : NoNumberForCellContradictionRule/UnresoveldCell
+    SKYS-CONT-0005 : NoCellForNumberContradictionRule/UnresoveldNumber
+
+    SKYS-CASE-0001 : NumberForCellCaseRule
+    SKYS-CASE-0002 : CellForNumberCaseRule
+
+HELPER FUNCTIONS:
+    -getRowCol
+        Location: skyscrapersBoard
+        Use: returns all elements in a row or col
+        Notes: more than one element type?
+
+CODE MOURGE:
+    - isForced, getDefaultBoard
+      Locations:
+      Uses?: Unknown
+      Notes: