linny-r 1.6.1 → 1.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {

package/server.js

@@ -1521,7 +1521,7 @@ function connectionErrorText(msg) {
 //
 
 function commandLineSettings() {
-  // Sets default settings, and then checks the command line arguments
+  // Sets default settings, and then checks the command line arguments.
   const settings = {
       cli_name: (PLATFORM.startsWith('win') ? 'Command Prompt' : 'Terminal'),
       inkscape: '',
@@ -1533,6 +1533,22 @@ function commandLineSettings() {
       solver_path: '',
       user_dir: path.join(WORKING_DIRECTORY, 'user')
     };
+  const
+      cmd = process.argv[0],
+      app = (cmd.endsWith('node.exe') ? 'node' : 'linny-r'),
+      usage = `Usage:  ${app} server [options]
+
+Possible options are:
+  dpi=[number]       will make InkScape render SVGs in the specified resolution
+  help               will display these command line options
+  launch             will open the Linny-R GUI in a browser window
+  port=[number]      will listen at the specified port number
+                     (default is 5050; number must be unique for each server)
+  solver=[name]      will select solver [name], or warn if not found
+                     (name choices: Gurobi, CPLEX, SCIP or LP_solve)
+  verbose            will output solver messages to the console
+  workspace=[path]   will create workspace in [path] instead of (Linny-R)/user
+`;
   for(let i = 2; i < process.argv.length; i++) {
     const lca = process.argv[i].toLowerCase();
     if(lca === 'launch') {
@@ -1541,7 +1557,7 @@ function commandLineSettings() {
       const av = lca.split('=');
       if(av.length === 1) av.push('');
       if(av[0] === 'port') {
-        // Accept any number greater than or equal to 1024
+        // Accept any number greater than or equal to 1024.
         const n = parseInt(av[1]);
         if(isNaN(n) || n < 1024) {
           console.log(`WARNING: Invalid port number ${av[1]}`);
@@ -1555,7 +1571,7 @@ function commandLineSettings() {
           settings.preferred_solver = av[1];
         }
       } else if(av[0] === 'dpi') {
-        // Accept any number greater than or equal to 1024
+        // Accept any number greater than or equal to 1024.
         const n = parseInt(av[1]);
         if(isNaN(n) || n > 1200) {
           console.log(`WARNING: Invalid resolution ${av[1]} (max. 1200 dpi)`);
@@ -1563,7 +1579,7 @@ function commandLineSettings() {
           settings.dpi = n;
         }
       } else if(av[0] === 'workspace') {
-        // User directory must be READ/WRITE-accessible
+        // User directory must be READ/WRITE-accessible.
         try {
           fs.accessSync(av[1], fs.constants.R_OK | fs.constants.W_O);
         } catch(err) {
@@ -1571,10 +1587,15 @@ function commandLineSettings() {
           process.exit();
         }
         settings.user_dir = av[1];
+      } else if(av[0] === 'help') {
+        // Print command line options.
+        console.log(usage);
+        process.exit();
       } else {
-        // Terminate script
+        // Terminate script.
         console.log(
-            `ERROR: Invalid command line argument "${process.argv[i]}"`);
+            `ERROR: Invalid command line argument "${process.argv[i]}"\n`);
+        console.log(usage);
         process.exit();
       }
     }

package/static/index.html

@@ -1765,6 +1765,8 @@ NOTE: * and ? will be interpreted as wildcards"
       <img id="eq-delete-btn" class="btn disab" src="images/delete.png"
            title="Delete selected equation">
     </div>
+    <img id="equation-outcome" class="not-selected" src="images/outcome.png"
+         title="Click to consider/ignore selected equation as experiment outcome">
     <div id="equation-scroll-area">
       <table id="equation-table">
       </table>
@@ -2011,6 +2013,22 @@ NOTE: * and ? will be interpreted as wildcards"
     </div>
   </div>
   
+  <!-- the ADD WILDCARD VARIABLES dialog allows selecting wildcard
+       variables from a list to be added to the current chart -->
+  <div id="add-wildcard-variables-modal" class="modal">
+    <div id="add-wildcard-variables-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Add wildcard matches
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div id="add-wildcard-variables-scroll-area">
+        <table id="add-wildcard-variables-table">
+        </table>
+      </div>
+    </div>
+  </div>
+  
   <!-- the RENAME CHART dialog prompts for the new title for a chart -->
   <div id="rename-chart-modal" class="modal">
     <div id="rename-chart-dlg" class="inp-dlg">

package/static/linny-r.css

@@ -2161,7 +2161,8 @@ div.io-box {
   cursor: pointer;
 }
 
-#dataset-outcome.not-selected {
+#dataset-outcome.not-selected,
+#equation-outcome.not-selected {
   filter: saturate(0) contrast(50%) brightness(170%);
 }
 
@@ -2273,10 +2274,12 @@ div.modif::before {
   margin-right: 2px;
 }
 
-div.outcome::before {
+div.outcome::before,
+span.outcome::before {
   content: ' \25C8';
   color: #b00080;
   margin-right: 1px;
+  font-style: normal;
 }
 
 div.array::before {
@@ -2449,6 +2452,15 @@ td.equation-expression {
   border-top: 1px solid Silver;
 }
 
+#equation-outcome {
+  position: absolute;
+  top: 25px;
+  right: 4px;
+  width: 16px;
+  height: 16px;
+  cursor: pointer;
+}
+
 /* NOTE: Rename equation modal must be above Edit variable modal */
 #rename-equation-modal {
   z-index: 110;
@@ -3098,6 +3110,31 @@ img.v-disab {
   width: calc(100% - 6px);
 }
 
+#add-wildcard-variables-dlg {
+  width: 250px;
+  min-height: 42px;
+  max-height: 50vh;
+}
+
+#add-wildcard-variables-scroll-area {
+  position: absolute;
+  top: 22px;
+  left: 2px;
+  width: calc(100% - 4px);
+  height: calc(100% - 26px);
+  overflow-y: auto;
+  border-top: 1px solid Silver;
+}
+
+#add-wildcard-variables-table {
+  width: 100%;
+  border-collapse: collapse;
+  line-height: 16px;
+  background-color: white;
+  border: 1px solid Silver;
+  border-top: none;
+}
+
 /* the SENSITIVITY DIALOG displays the sensitivity analysis */
 #sensitivity-dlg {
   display: none;

package/static/scripts/linny-r-ctrl.js

@@ -834,12 +834,19 @@ class ChartManager {
   }
   
   resetChartVectors() {
-    // Reset vectors of all charts
+    // Reset vectors of all charts.
     for(let i = 0; i < MODEL.charts.length; i++) {
       MODEL.charts[i].resetVectors();
     }
   }
 
+  promptForWildcardIndices(chart, dsm) {
+    // No GUI dialog, so add *all* vectors for wildcard dataset modifier
+    // `dsm` as variables to `chart`.
+    const indices = Object.keys(dsm.expression.wildcard_vectors);
+    chart.addWildcardVariables(dsm, indices);
+  }
+
   setRunsChart(show) {
     // Indicate whether the chart manager should display a run result chart.
     this.runs_chart = show;

package/static/scripts/linny-r-gui-chart-manager.js

@@ -131,7 +131,7 @@ class GUIChartManager extends ChartManager {
     document.getElementById('chart-narrow-btn').addEventListener(
         'click', () => CHART_MANAGER.stretchChart(-1));
 
-    // The Add variable modal
+    // The Add variable modal.
     this.add_variable_modal = new ModalDialog('add-variable');
     this.add_variable_modal.ok.addEventListener(
         'click', () => CHART_MANAGER.addVariable());
@@ -143,7 +143,7 @@ class GUIChartManager extends ChartManager {
     this.add_variable_modal.element('name').addEventListener(
         'change', () => X_EDIT.updateAttributeSelector('add-'));
 
-    // The Edit variable modal
+    // The Edit variable modal.
     this.variable_modal = new ModalDialog('variable');
     this.variable_modal.ok.addEventListener(
         'click', () => CHART_MANAGER.modifyVariable());
@@ -160,7 +160,7 @@ class GUIChartManager extends ChartManager {
         'mouseleave', () => CHART_MANAGER.hidePasteColor());
     document.getElementById('variable-color').addEventListener(
         'click', (event) => CHART_MANAGER.copyPasteColor(event));
-    // NOTE: uses the color picker developed by James Daniel
+    // NOTE: Uses the color picker developed by James Daniel.
     this.color_picker = new iro.ColorPicker("#color-picker", {
         width: 92,
         height: 92,
@@ -179,13 +179,20 @@ class GUIChartManager extends ChartManager {
             CHART_MANAGER.color_picker.color.hexString;
       });
 
-    // The Rename chart modal
+    // The Rename chart modal.
     this.rename_chart_modal = new ModalDialog('rename-chart');
     this.rename_chart_modal.ok.addEventListener(
         'click', () => CHART_MANAGER.renameChart());
     this.rename_chart_modal.cancel.addEventListener(
         'click', () => CHART_MANAGER.rename_chart_modal.hide());
     
+    // The Add wildcard variables modal.
+    this.add_wildcard_modal = new ModalDialog('add-wildcard-variables');
+    this.add_wildcard_modal.ok.addEventListener(
+        'click', () => CHART_MANAGER.addSelectedWildcardVariables());
+    this.add_wildcard_modal.cancel.addEventListener(
+        'click', () => CHART_MANAGER.add_wildcard_modal.hide());
+    
     // Do not display the time step until cursor moves over chart
     this.time_step.style.display = 'none';
     document.getElementById('table-only-buttons').style.display = 'none';
@@ -326,16 +333,25 @@ class GUIChartManager extends ChartManager {
   }
   
   updateSelector() {
-    // Adds one option to the selector for each chart defined for the model
-    // NOTE: add the "new chart" option if still absent
+    // Adds one option to the selector for each chart defined for the model.
+    // NOTE: Add the "new chart" option if it is not in the list.
     MODEL.addChart(this.new_chart_title);
     if(this.chart_index < 0) this.chart_index = 0;
     const ol = [];
     for(let i = 0; i < MODEL.charts.length; i++) {
-      ol.push('<option value="', i,
-        (i == this.chart_index ? '"selected="selected' : ''),
-        '">', MODEL.charts[i].title , '</option>');
+      const t = MODEL.charts[i].title;
+      ol.push(['<option value="', i,
+          (i == this.chart_index ? '" selected="selected' : ''),
+          '">', t , '</option>'].join(''));
     }
+    // Sort option list by chart title.
+    ol.sort((a, b) => {
+        const
+            re = /<option value="\d+"( selected="selected")?>(.+)<\/option>/,
+            ta = a.replace(re, '$2'),
+            tb = b.replace(re, '$2');
+        return UI.compareFullNames(ta, tb);
+      });
     this.chart_selector.innerHTML = ol.join('');
   }
   
@@ -379,6 +395,11 @@ class GUIChartManager extends ChartManager {
     } else {
       this.variable_index = -1;
     }
+    // Just in case variable index has not been adjusted after some
+    // variables have been deleted
+    if(this.variable_index >= c.variables.length) {
+      this.variable_index = -1;
+    }
     // Set the image of the sort type button.
     if(this.variable_index >= 0) {
       const
@@ -392,11 +413,6 @@ class GUIChartManager extends ChartManager {
         u_btn = 'chart-variable-up ',
         d_btn = 'chart-variable-down ',
         ed_btns = 'chart-edit-variable chart-sort-variable chart-delete-variable ';
-    // Just in case variable index has not been adjusted after some
-    // variables have been deleted
-    if(this.variable_index >= c.variables.length) {
-      this.variable_index = -1;
-    }
     if(this.variable_index < 0) {
       UI.disableButtons(ed_btns + u_btn + d_btn);
     } else {
@@ -713,15 +729,63 @@ class GUIChartManager extends ChartManager {
     }
   }
   
+  promptForWildcardIndices(chart, dsm) {
+    // Prompt modeler with list of vectors for wildcard dataset modifier
+    // `dsm` as variables to `chart`.
+    const
+        md = this.add_wildcard_modal,
+        indices = Object.keys(dsm.expression.wildcard_vectors);
+    // First hide the "Add variable" modal.
+    this.add_variable_modal.hide();
+    // Do not prompt for selection if there is only 1 match.
+    if(indices.length < 2) chart.addWildcardVariables(dsm, indices);
+    md.chart = chart;
+    md.modifier = dsm;
+    md.indices = indices;
+    const
+        tr = [],
+        dn = dsm.displayName,
+        tbl = md.element('table');
+    for(let i = 0; i < indices.length; i++) {
+      tr.push('<tr><td class="v-box"><div id="wcv-box-', indices[i],
+          '" class="box clear" onclick="UI.toggleBox(event);"></td>',
+          '<td class="vname">', dn.replace('??', indices[i]),
+          '</td></tr>');
+      tbl.innerHTML = tr.join('');
+    }
+    md.dialog.style.height = (22 + indices.length * 16) + 'px';
+    md.show();
+  }
+  
+  addSelectedWildcardVariables() {
+    // Let the chart add selected wildcard matches (if any) as chart
+    // variables.
+    const
+        md = this.add_wildcard_modal,
+        c = md.chart,
+        dsm = md.modifier,
+        il = md.indices,
+        indices = [];
+    if(c && dsm && il) {
+      for(let i = 0; i < il.length; i++) {
+        if(UI.boxChecked('wcv-box-'+ il[i])) indices.push(il[i]);
+      }
+    }
+    if(indices.length) c.addWildcardVariables(dsm, indices);
+    // Always hide the dialog.
+    md.hide();
+    this.updateDialog();
+  }
+  
   selectVariable(vi) {
-    // Select variable, and edit it when double-clicked
+    // Select variable, and edit it when double-clicked.
     const
         now = Date.now(),
         dt = now - this.last_time_selected;
     if(vi >= 0 && this.chart_index >= 0) {
       this.last_time_selected = now;
       if(vi === this.variable_index) {
-        // Consider click to be "double" if it occurred less than 300 ms ago
+        // Consider click to be "double" if it occurred less than 300 ms ago.
         if(dt < 300) {
           this.last_time_selected = 0;
           this.editVariable();

package/static/scripts/linny-r-gui-controller.js

@@ -109,7 +109,7 @@ class GroupPropertiesDialog extends ModalDialog {
     // input fields this means `onkeydown` events.
     const fnc = (event) => {
         const id = event.target.id.split('-').shift();
-        // NOTE: add a short delay to permit checkboxes to update their
+        // NOTE: Add a short delay to permit checkboxes to update their
         // status first, before checking for change.
         setTimeout(() => UI.modals[id].highlightModifiedFields(), 100);
       };
@@ -819,8 +819,8 @@ class GUIController extends Controller {
 
     // Add all draggable stay-on-top dialogs as controller properties.
     
-    // Make checkboxes respond to click
-    // NOTE: checkbox-specific events must be bound AFTER this general setting
+    // Make checkboxes respond to click.
+    // NOTE: Checkbox-specific events must be bound AFTER this general setting.
     const
         cbs = document.getElementsByClassName('box'),
         cbf = (event) => UI.toggleBox(event);

package/static/scripts/linny-r-gui-equation-manager.js

@@ -54,6 +54,9 @@ class EquationManager {
         'click', () => EQUATION_MANAGER.editEquation());
     document.getElementById('eq-delete-btn').addEventListener(
         'click', () => EQUATION_MANAGER.deleteEquation());
+    this.outcome_btn = document.getElementById('equation-outcome');
+    this.outcome_btn.addEventListener(
+        'click', () => EQUATION_MANAGER.toggleOutcome());
     
     // Create modal dialogs
     this.new_modal = new ModalDialog('new-equation');
@@ -134,6 +137,11 @@ class EquationManager {
         ml = [],
         msl = ed.selectorList,
         sm = this.selected_modifier;
+    if(sm && sm.outcome_equation) {
+      this.outcome_btn.classList.remove('not-selected'); 
+    } else {
+      this.outcome_btn.classList.add('not-selected'); 
+    }
     let smid = 'eqmtr';
     for(let i = 0; i < msl.length; i++) {
       const
@@ -155,6 +163,7 @@ class EquationManager {
           (m.expression.noMethodObject ? ' no-object' : ''),
           (m.expression.isStatic ? '' : ' it'), issue,
           (wild ? ' wildcard' : ''), clk, ', false);"', mover, '>',
+          (m.outcome_equation ? '<span class="outcome"></span>' : ''),
           (wild ? wildcardFormat(m.selector) : m.selector),
           '</td><td class="equation-expression', issue,
           (issue ? '"title="' +
@@ -201,6 +210,16 @@ class EquationManager {
     this.updateDialog();
   }
   
+  toggleOutcome() {
+    const m = this.selected_modifier;
+    // NOTE: Methods cannot be outcomes.
+    if(m && !m.selector.startsWith(':')) {
+      m.outcome_equation = !m.outcome_equation;
+      this.updateDialog();
+      if(!UI.hidden('experiment-dlg')) EXPERIMENT_MANAGER.updateDialog();
+    }
+  }
+  
   promptForEquation(add=false) {
     this.add_to_chart = add;
     this.new_modal.element('name').value = '';

package/static/scripts/linny-r-gui-experiment-manager.js

@@ -356,7 +356,11 @@ class GUIExperimentManager extends ExperimentManager {
     dim_count.innerHTML = pluralS(x.available_dimensions.length,
         'more dimension');
     x.inferActualDimensions();
+    for(let i = 0; i < x.actual_dimensions.length; i++) {
+      x.actual_dimensions[i].sort(compareSelectors);
+    }
     x.inferCombinations();
+    //x.combinations.sort(compareCombinations);
     combi_count.innerHTML = pluralS(x.combinations.length, 'combination');
     if(x.combinations.length === 0) canview = false;
     header.innerHTML = x.title;
@@ -850,6 +854,9 @@ class GUIExperimentManager extends ExperimentManager {
       }
       // Get the selected statistic for each run so as to get an array of numbers
       const data = [];
+      // Set reference column indices so that values for the reference|
+      // configuration can be displayed in orange.
+      const ref_conf_indices = [];
       for(let i = 0; i < x.runs.length; i++) {
         const
             r = x.runs[i],
@@ -878,7 +885,7 @@ class GUIExperimentManager extends ExperimentManager {
           data.push(rr.last);
         }
       }
-      // Scale data as selected
+      // Scale data as selected.
       const scaled = data.slice();
       // NOTE: scale only after the experiment has been completed AND
       // configurations have been defined (otherwise comparison is pointless)
@@ -896,7 +903,9 @@ class GUIExperimentManager extends ExperimentManager {
           }
           // Set difference for reference configuration itself to 0
           for(let i = 0; i < n; i++) {
-            scaled[rc * n + i] = 0;
+            const index = rc * n + i;
+            scaled[index] = 0;
+            ref_conf_indices.push(index);
           }
         } else if(x.selected_scale === 'reg') {
           // Compute regret: current config - high value config in same scenario
@@ -934,13 +943,15 @@ class GUIExperimentManager extends ExperimentManager {
         formatted.push(VM.sig4Dig(scaled[i]));
       }
       uniformDecimals(formatted);
-      // Display formatted data in cells
+      // Display formatted data in cells.
       for(let i = 0; i < x.combinations.length; i++) {
         const cell = document.getElementById('xr' + i);
         if(i < x.runs.length) {
           cell.innerHTML = formatted[i];
           cell.classList.remove('not-run');
           cell.style.backgroundColor = this.color_scale.rgb(normalized[i]);
+          cell.style.color = (ref_conf_indices.indexOf(i) >= 0 ?
+              'orange' : 'black');
           const
               r = x.runs[i],
               rr = r.results[rri],

package/static/scripts/linny-r-gui-expression-editor.js

@@ -377,7 +377,7 @@ NOTE: Grouping groups results in a single group, e.g., (1;2);(3;4;5) evaluates a
       }
       va.innerHTML = options.join('');
       // NOTE: Chart Manager variable dialog is 60px wider
-      va.style.width = (prefix ? 'calc(100% - 82px)' : 'calc(100% - 142px)');
+      va.style.width = (prefix ? 'calc(100% - 84px)' : 'calc(100% - 142px)');
       return;
     }
     // Add "empty" as first and initial option, as it denotes "use default"

package/static/scripts/linny-r-gui-monitor.js

@@ -280,6 +280,7 @@ class GUIMonitor {
 
   hideCallStack() {
     document.getElementById('call-stack-modal').style.display = 'none';
+    this.call_stack_shown = false;    
   }
 
   logMessage(block, msg) {