Added (currently unused) grouping and sort keys

simshadows · simshadows · commit e3a5944ea4ba · 2022-08-15T17:18:31.000+10:00
diff --git a/package.json b/package.json
@@ -7,11 +7,11 @@
   "keywords": [],
   "packageManager": "yarn@3.2.0",
   "scripts": {
-    "devdebug": "yarn solves -s ./test/social-golfer.yml",
-    "devdebug2": "yarn solves -s ./test/sample-spec.yml",
-    "devdebug3": "yarn solves -s ./test/cnf-sat.yml",
-    "devdebug3alt": "yarn solves -s ./test/cnf-sat-alt.yml",
-    "devdebug4": "yarn solves -s ./test/vertex-cover.yml",
+    "devdebug": "yarn solves -s ./sample-specs/social-golfer.yml",
+    "devdebug2": "yarn solves -s ./sample-specs/graph-colouring.yml",
+    "devdebug3": "yarn solves -s ./sample-specs/cnf-sat.yml",
+    "devdebug3alt": "yarn solves -s ./sample-specs/cnf-sat-alt.yml",
+    "devdebug4": "yarn solves -s ./sample-specs/vertex-cover.yml",
     "test": "yarn workspace solves test",
     "build": "yarn workspace solves build",
     "compile": "yarn workspace solves compile",
diff --git a/solves/sample-specs/README.txt b/solves/sample-specs/README.txt
diff --git a/solves/sample-specs/cnf-sat-alt.yml b/solves/sample-specs/cnf-sat-alt.yml
@@ -49,6 +49,9 @@ output:
       - Variable
       - Dummy1
       - Dummy2
+    format:
+      groupBy: []
+      sortBy: []
 
 constraints: |
   sign(pos).
diff --git a/solves/sample-specs/cnf-sat.yml b/solves/sample-specs/cnf-sat.yml
@@ -32,6 +32,9 @@ output:
     title: Assignment
     fieldLabels:
       - Variable
+    format:
+      groupBy: []
+      sortBy: []
 
 constraints: |
   sign(pos).
diff --git a/solves/sample-specs/graph-colouring.yml b/solves/sample-specs/graph-colouring.yml
@@ -39,6 +39,9 @@ output:
     fieldLabels:
       - Vertex
       - Colour
+    format:
+      groupBy: []
+      sortBy: []
 
 constraints: |
   domainok(edge(V1,V2)) :- base(vertex,V1), base(vertex,V2), V1 != V2, instance(edge(V1,V2)).
diff --git a/solves/sample-specs/social-golfer.yml b/solves/sample-specs/social-golfer.yml
@@ -50,12 +50,23 @@ output:
   assign:
     title: Selection
     fieldLabels:
-      - Player
       - Round
       - Group
+      - Players
+    format:
+      groupBy:
+        - Round
+        - Group
+      sortBy:
+        - Round
+        - Group
 
 constraints: |
-  domainok(disallowed(P1,P2)) :- base(player,P1), base(player,P2), P1 != P2, instance(disallowed(P1,P2)).
+  domainok(disallowed(P1,P2)) :-
+      base(player,P1),
+      base(player,P2),
+      P1 != P2,
+      instance(disallowed(P1,P2)).
 
 encoding: |
   round(1..R) :- integer(rounds,R).
@@ -67,8 +78,10 @@ encoding: |
   :- same(P1,P2, R), instance(disallowed(P1,P2)).
   :- same(P1,P2, R), instance(disallowed(P2,P1)).
 
-  :- same(P1, P2, R), same(P1, P2, S), R < S. %%% satisfaction constraint
-  %#minimize { 1,P1,P2,R,S : same(P1, P2, R), same(P1, P2, S), R < S }. %%% optimization constraint
+  %%% satisfaction constraint
+  :- same(P1, P2, R), same(P1, P2, S), R < S.
+  %%% optimization constraint
+  %#minimize { 1,P1,P2,R,S : same(P1, P2, R), same(P1, P2, S), R < S }.
 
-  solution(assign(P,R,G)) :- assign(P,R,G).
+  solution(assign(R,G,P)) :- assign(P,R,G).
 
diff --git a/solves/sample-specs/vertex-cover.yml b/solves/sample-specs/vertex-cover.yml
diff --git a/solves/src/spec-parse.ts b/solves/src/spec-parse.ts
@@ -25,6 +25,22 @@ function ensureInt(obj: any, argName: string): number {
         throw new Error(`'${argName}' spec key is not a safe integer.`);
     return obj;
 }
+function ensureUniqueStrArray(obj: any, argName: string): string[] {
+    if (!Array.isArray(obj)) {
+        throw new Error(`'${argName}' spec key is not an array of strings.`);
+    }
+    const newArr: string[] = [];
+    for (const e of obj) {
+        if (typeof e !== "string") {
+            throw new Error(`'${argName}' spec key must be an array of strings.`);
+        }
+        newArr.push(e);
+    }
+    if ((new Set(newArr)).size !== newArr.length) {
+        throw new Error(`'${argName}' spec key must contain unique strings.`);
+    }
+    return newArr;
+}
 //function ensureNum(obj: any, argName: string): number {
 //    if (typeof obj === "number") return obj;
 //    throw new Error(`'${argName}' spec key is not a number.`);
@@ -60,12 +76,30 @@ function inputIntegerTransform(obj: any): InputIntegerPartialSpec {
     };
 }
 
-/********************************************************************/
+function fieldLabelsToIndices(
+    arr:       string[],
+    reference: string[],
+    argName:   string,
+    refName:   string,
+): number[] {
+    const indices: number[] = arr.map(x => reference.indexOf(x));
+    if (indices.some(x => (x < 0))) {
+        throw new Error(`'${argName}' spec key must contain strings found in ${refName}.`);
+    }
 
-interface OutputFieldSpec {
-    label: string;
+    // Sanity checks
+    if ((new Set(indices)).size !== indices.length) {
+        throw new Error(`Critical bug: arr must map to unique indices.`);
+    }
+    if (indices.some(x => x >= reference.length)) {
+        throw new Error(`Critical bug: arr must map to indices within range.`);
+    }
+    
+    return indices;
 }
 
+/********************************************************************/
+
 interface InputPartialSpec {
     title:         string;
     parameters:    number;
@@ -78,11 +112,27 @@ interface InputIntegerPartialSpec {
     initial: number;
 }
 
+/*** ***/
+
+//type OutputFieldSortBy = "ascending" | "descending";
+
+interface OutputFieldSpec {
+    label: string;
+
+    //sortBy: OutputFieldSortBy; // We are always ascending for now
+}
+
 interface OutputPartialSpec {
     title:  string;
     fields: OutputFieldSpec[];
+
+    // Formatting
+    groupPriority: number[]; // closer to front = higher-priority
+    sortPriority: number[]; // closer to front = higher-priority
 }
 
+/*** ***/
+
 export interface SpecValues {
     name:            string;
     appTitle:        string;
@@ -157,17 +207,39 @@ export function getSpecValues(specPath: string): SpecValues {
 
         output: objectValueMap(output, (obj: any) => {
             const title: string = ensureStr(obj.title, "output[].title");
-            const fieldLabels: any = obj.fieldLabels;
-            if (!Array.isArray(fieldLabels)) {
-                throw new Error(`Output ${obj.title} must provide a fields specification array.`);
-            }
+            const fieldLabels: string[] = ensureUniqueStrArray(
+                obj.fieldLabels, "output[].fieldLabels",
+            );
+            const groupBy: string[] = ensureUniqueStrArray(
+                obj.format?.groupBy, "output[].format.groupBy",
+            );
+            const sortBy: string[] = ensureUniqueStrArray(
+                obj.format?.sortBy, "output[].format.sortBy",
+            );
+
+            const fields: OutputFieldSpec[] = fieldLabels.map(x => ({label: x}));
 
-            const fields: OutputFieldSpec[] = fieldLabels.map(
-                x => ({label: ensureStr(x, `output[].fields[].label`)})
+            const groupPriority: number[] = fieldLabelsToIndices(
+                groupBy,
+                fieldLabels,
+                "output[].format.groupBy",
+                "output[].fieldLabels",
             );
+            const sortPriority: number[] = fieldLabelsToIndices(
+                sortBy,
+                fieldLabels,
+                "output[].format.sortBy",
+                "output[].fieldLabels",
+            );
+
+            // We want to sort all fields, so we fill more values
+            for (let i = 0; i < fieldLabels.length; ++i) {
+                if (!sortPriority.includes(i)) sortPriority.push(i);
+            }
+            console.log(groupPriority);
+            console.log(sortPriority);
 
-            const outputObj = {title, fields};
-            return outputObj;
+            return {title, fields, groupPriority, sortPriority};
         }),
     };
 }
