linny-r 1.5.8 → 1.6.0

package/package.json

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

package/static/index.html

@@ -304,8 +304,12 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       </svg>
     </div>
   </main>
-  <!-- the footer displays the status bar with X/Y coordinates, zoom in/out buttons, buttons for moving forward/backward
-       in time, and the status line that displays info, notifications, warnings, and error messages
+  <!-- The footer displays the status bar with X/Y coordinates, zoom
+       in/out buttons, buttons for moving forward/backward in time, and
+       the status line that displays info, notifications, warnings, and
+       error messages. The set-up progress bar shows a growing colored
+       needle indicating progress of making Simplex tableau and input
+       file for the solver.
    -->
   <footer>
     <div id="set-up-progress">
@@ -2238,7 +2242,7 @@ NOTE: * and ? will be interpreted as wildcards"
       </div>
       <div id="viewer-selectors">
         <label>Variable:</label>
-        <select id="viewer-variable" style="margin-right: 10px">
+        <select id="viewer-variable">
         </select>
         <label>Statistic:</label>
         <select id="viewer-statistic">

package/static/linny-r.css

@@ -2366,6 +2366,24 @@ td.equation-selector {
   text-overflow: ellipsis;
 }
 
+td.method {
+  color: #1080e0;
+  font-weight: bold;
+}
+
+td.no-object {
+  color: #80a0c0;
+  font-weight: normal;
+}
+
+td.compile-issue {
+  color: #e00000;
+}
+
+td.compute-issue {
+  color: #f08000;
+}
+
 td.wildcard {
   color: #400080;
 }
@@ -3558,6 +3576,7 @@ td.sa-not-run {
 #viewer-variable {
   font-size: 10px;
   max-width: calc(100% - 160px);
+  margin-right: 10px;
 }
 
 #sensitivity-statistic,

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

@@ -304,15 +304,15 @@ class ActorManager {
       if(a.displayName != ali[1]) a.rename(ali[1]);
       // Set its round flags
       a.round_flags = ali[2];
-      // Double-check: parse expression if weight has been changed
+      // Double-check: parse expression if weight has been changed.
       if(a.weight.text != ali[3]) {
-        xp.expr = ali[3];
+        xp.expr = monoSpacedVariables(ali[3]);
         xp.compile();
         if(xp.error) {
           UI.warningInvalidWeightExpression(a, xp.error);
           ok = false;
         } else {
-          a.weight.update(xp);
+          a.weight.update(ali[3]);
         }
       }
       // Update import/export status

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

@@ -574,7 +574,7 @@ class GUIChartManager extends ChartManager {
   }
   
   cloneChart() {
-    // Creates a new chart that is identical to the current one
+    // Create a new chart that is identical to the current one.
     if(this.chart_index >= 0) {
       let c = MODEL.charts[this.chart_index],
           nt = c.title + '-copy';
@@ -582,7 +582,7 @@ class GUIChartManager extends ChartManager {
         nt += '-copy';
       }
       const nc = MODEL.addChart(nt);
-      // Copy properties of c to nc
+      // Copy properties of `c` to `nc`;
       nc.histogram = c.histogram;
       nc.bins = c.bins;
       nc.show_title = c.show_title;
@@ -609,7 +609,7 @@ class GUIChartManager extends ChartManager {
   }
   
   toggleRunStat() {
-    // Toggles the Boolean property that signals charts that they must
+    // Toggle the Boolean property that signals charts that they must
     // plot the selected statistic for the selected runs if they are
     // part of the selected experiment chart set.
     this.setRunsStat(!this.runs_stat);
@@ -618,16 +618,17 @@ class GUIChartManager extends ChartManager {
   }
   
   deleteChart() {
-    // Deletes the shown chart (if any)
+    // Delete the shown chart (if any).
     if(this.chart_index >= 0) {
-      // NOTE: do not delete the default chart, but clear it
+      // NOTE: Do not delete the default chart, but clear it instead.
       if(MODEL.charts[this.chart_index].title === this.new_chart_title) {
         MODEL.charts[this.chart_index].reset();
       } else {
         MODEL.charts.splice(this.chart_index, 1);
         this.chart_index = -1;
       }
-      // Also update the experiment viewer (charts define the output variables)
+      // Also update the experiment viewer, because this chart may be
+      // one of the output charts of the selected experiment.
       UI.updateControllerDialogs('CFX');
     }
   }
@@ -689,8 +690,8 @@ class GUIChartManager extends ChartManager {
   }
 
   addVariable(eq='') {
-    // Adds the variable specified by the add-variable-dialog to the chart
-    // NOTE: when defined, `eq` is the selector of the equation to be added
+    // Add the variable specified by the add-variable-dialog to the chart.
+    // NOTE: When defined, `eq` is the selector of the equation to be added.
     if(this.chart_index >= 0) {
       let o = '',
           a = eq;
@@ -698,7 +699,7 @@ class GUIChartManager extends ChartManager {
         o = this.add_variable_modal.selectedOption('name').text;
         a = this.add_variable_modal.selectedOption('attr').text;
       }
-      // NOTE: when equation is added, object specifier is empty string
+      // NOTE: When equation is added, object specifier is empty string.
       if(!o && a) o = UI.EQUATIONS_DATASET_NAME;
       this.variable_index = MODEL.charts[this.chart_index].addVariable(o, a);
       if(this.variable_index >= 0) {

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

@@ -2608,10 +2608,11 @@ class GUIController extends Controller {
     document.body.className = '';
   }
 
-  setProgressNeedle(fraction) {
+  setProgressNeedle(fraction, color='#500080') {
     // Shows a thin purple line just above the status line to indicate progress
     const el = document.getElementById('set-up-progress-bar');
     el.style.width = Math.round(Math.max(0, Math.min(1, fraction)) * 100) + '%';
+    el.style.backgroundColor = color;
   }
   
   hideStayOnTopDialogs() {

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

@@ -486,12 +486,14 @@ class GUIDatasetManager extends DatasetManager {
           m = sd.modifiers[UI.nameToID(msl[i])],
           wild = m.hasWildcards,
           defsel = (m.selector === sd.default_selector),
+          issue = (m.expression.compile_issue ? ' compile-issue' :
+              (m.expression.compute_issue ? ' compute-issue' : '')),
           clk = '" onclick="DATASET_MANAGER.selectModifier(event, \'' +
               m.selector + '\'';
       if(m === sm) smid += i;
       ml.push(['<tr id="dsmtr', i, '" class="dataset-modif',
           (m === sm ? ' sel-set' : ''),
-          '"><td class="dataset-selector',
+          '"><td class="dataset-selector', issue,
           (wild ? ' wildcard' : ''),
           '" title="Shift-click to ', (defsel ? 'clear' : 'set as'),
           ' default modifier',
@@ -499,7 +501,10 @@ class GUIDatasetManager extends DatasetManager {
           (defsel ? '<img src="images/solve.png" style="height: 14px;' +
               ' width: 14px; margin: 0 1px -3px -1px;">' : ''),
           (wild ? wildcardFormat(m.selector, true) : m.selector),
-          '</td><td class="dataset-expression',
+          '</td><td class="dataset-expression', issue,
+          (issue ? '"title="' +
+              safeDoubleQuotes(m.expression.compile_issue ||
+                  m.expression.compute_issue) : ''),
           clk, ');">', m.expression.text, '</td></tr>'].join(''));
     }
     this.modifier_table.innerHTML = ml.join('');
@@ -654,14 +659,14 @@ class GUIDatasetManager extends DatasetManager {
   }
   
   renameDataset() {
-    // Changes the name of the selected dataset
+    // Change the name of the selected dataset.
     if(this.selected_dataset) {
       const
           inp = this.rename_modal.element('name'),
           n = UI.cleanName(inp.value);
-      // Show modeler the "cleaned" new name
+      // Show modeler the "cleaned" new name.
       inp.value = n;
-      // Then try to rename -- this may generate a warning
+      // Then try to rename -- this may generate a warning.
       if(this.selected_dataset.rename(n)) {
         this.rename_modal.hide();
         if(EXPERIMENT_MANAGER.selected_experiment) {
@@ -670,59 +675,22 @@ class GUIDatasetManager extends DatasetManager {
         UI.updateControllerDialogs('CDEFJX');
       }
     } else if(this.selected_prefix_row) {
-      // Create a list of datasets to be renamed
+      // Create a list of datasets to be renamed.
       let e = this.rename_modal.element('name'),
           prefix = e.value.trim();
       e.focus();
-      // Trim trailing colon if user entered it
+      // Trim trailing colon if user added it.
       while(prefix.endsWith(':')) prefix = prefix.slice(0, -1);
-      // NOTE: prefix may be empty string, but otherwise should be a valid name
+      // NOTE: Prefix may be empty string, but otherwise should be a
+      // valid name.
       if(prefix && !UI.validName(prefix)) {
         UI.warn('Invalid prefix');
         return;
       }
-      // Now add the colon-plus-space prefix separator
+      // Now add the colon-plus-space prefix separator.
       prefix += UI.PREFIXER;
-      const
-          oldpref = this.selectedPrefix,
-          key = oldpref.toLowerCase().split(UI.PREFIXER).join(':_'),
-          newkey = prefix.toLowerCase().split(UI.PREFIXER).join(':_'),
-          dsl = [];
-      // No change if new prefix is identical to old prefix
-      if(oldpref !== prefix) { 
-        for(let k in MODEL.datasets) if(MODEL.datasets.hasOwnProperty(k)) {
-          if(k.startsWith(key)) dsl.push(k);
-        }
-        // NOTE: no check needed for mere upper/lower case changes
-        if(newkey !== key) {
-          let nc = 0;
-          for(let i = 0; i < dsl.length; i++) {
-            let nk = newkey + dsl[i].substring(key.length);
-            if(MODEL.datasets[nk]) nc++;
-          }
-          if(nc) {
-            UI.warn('Renaming ' + pluralS(dsl.length, 'dataset').toLowerCase() +
-                ' would cause ' + pluralS(nc, 'name conflict'));
-            return;
-          }
-        }
-        // Reset counts of effects of a rename operation
-        this.entity_count = 0;
-        this.expression_count = 0;
-        // Rename datasets one by one, suppressing notifications
-        for(let i = 0; i < dsl.length; i++) {
-          const d = MODEL.datasets[dsl[i]];
-          d.rename(d.displayName.replace(oldpref, prefix), false);
-        }
-        let msg = 'Renamed ' + pluralS(dsl.length, 'dataset').toLowerCase();
-        if(MODEL.variable_count) msg += ', and updated ' +
-            pluralS(MODEL.variable_count, 'variable') + ' in ' +
-            pluralS(MODEL.expression_count, 'expression');
-        UI.notify(msg);
-        if(EXPERIMENT_MANAGER.selected_experiment) {
-          EXPERIMENT_MANAGER.selected_experiment.inferVariables();
-        }
-        UI.updateControllerDialogs('CDEFJX');
+      // Perform the renaming operation.
+      if(MODEL.renamePrefixedDatasets(this.selectedPrefix, prefix)) {
         this.selectPrefixRow(prefix);
       }
     }

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

@@ -309,30 +309,50 @@ class DocumentationManager {
   }
 
   update(e, shift) {
-    // Display name of entity under cursor on the infoline, and details in
-    // the documentation dialog
+    // Display name of entity under cursor on the infoline, and details
+    // in the documentation dialog.
     if(!e) return;
-    const
-        et = e.type,
+    let et = e.type,
         edn = e.displayName;
-    // TO DO: when debugging, display additional data for nodes on the infoline 
+    if(et === 'Equation' && e.selector.startsWith(':')) et = 'Method';
+    // TO DO: when debugging, display additional data for nodes on the
+    // infoline. 
     UI.setMessage(
         e instanceof NodeBox ? e.infoLineName : `<em>${et}:</em> ${edn}`);
-    // NOTE: update the dialog ONLY when shift is pressed (this permits modelers
-    // to rapidly browse comments without having to click on entities, and then
-    // release the shift key to move to the documentation dialog to edit)
-    // Moreover, the documentation dialog must be visible, and the entity must
-    // have the `comments` property
-    if(!this.editing && shift && this.visible && e.hasOwnProperty('comments')) {
-      this.title.innerHTML = `<em>${et}:</em>&nbsp;${edn}`;
-      this.entity = e;
-      this.markup = (e.comments ? e.comments : '');
-      this.editor.value = this.markup;
-      this.viewer.innerHTML = this.markdown;
-      this.edit_btn.classList.remove('disab');
-      this.edit_btn.classList.add('enab');
-      // NOTE: permit documentation of the model by raising the dialog
-      if(this.entity === MODEL) this.dialog.style.zIndex = 101;
+    // NOTE: Update the dialog ONLY when shift is pressed. This permits
+    // modelers to rapidly browse comments without having to click on
+    // entities, and then release the shift key to move to the documentation
+    // dialog to edit. Moreover, the documentation dialog must be visible,
+    // and the entity must have the `comments` property.
+    // NOTE: Equations constitute an exception, as DatasetModifiers do
+    // not have the `comments` property. Now that methods can be defined
+    // (since version 1.6.0), the documentation window displays the eligible
+    // prefixes when the cursor is Shift-moved over the name of a method
+    // (in the Equation Manager).
+    if(!this.editing && shift && this.visible) {
+      if(e.hasOwnProperty('comments')) {
+        this.title.innerHTML = `<em>${et}:</em>&nbsp;${edn}`;
+        this.entity = e;
+        this.markup = (e.comments ? e.comments : '');
+        this.editor.value = this.markup;
+        this.viewer.innerHTML = this.markdown;
+        this.edit_btn.classList.remove('disab');
+        this.edit_btn.classList.add('enab');
+        // NOTE: permit documentation of the model by raising the dialog
+        if(this.entity === MODEL) this.dialog.style.zIndex = 101;
+      } else if(e instanceof DatasetModifier) {
+        this.title.innerHTML = e.selector;
+        this.viewer.innerHTML = 'Method <tt>' + e.selector +
+            '</tt> does not apply to any entity';
+        if(e.expression.eligible_prefixes) {
+          const el = Object.keys(e.expression.eligible_prefixes)
+              .sort(compareSelectors);
+          if(el.length > 0) this.viewer.innerHTML = 'Method <tt>' +
+              e.selector + '</tt> applies to ' +
+              pluralS(el.length, 'prefixed entity group').toLowerCase() +
+              ':<ul><li>' + el.join('</li><li>') + '</li></ul>';
+        }
+      }
     }
   }
   

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

@@ -139,16 +139,27 @@ class EquationManager {
       const
           m = ed.modifiers[UI.nameToID(msl[i])],
           wild = (m.selector.indexOf('??') >= 0),
+          method = m.selector.startsWith(':'),
+          issue = (m.expression.compile_issue ? ' compile-issue' :
+              (m.expression.compute_issue ? ' compute-issue' : '')),
           clk = '" onclick="EQUATION_MANAGER.selectModifier(event, \'' +
-              m.selector + '\'';
+              m.selector + '\'',
+          mover = (method ? ' onmouseover="EQUATION_MANAGER.showInfo(\'' +
+              m.identifier + '\', event.shiftKey);"' : '');
       if(m === sm) smid += i;
       ml.push(['<tr id="eqmtr', i, '" class="dataset-modif',
           (m === sm ? ' sel-set' : ''),
           '"><td class="equation-selector',
-          (m.expression.isStatic ? '' : ' it'),
-          (wild ? ' wildcard' : ''), clk, ', false);">',
+          (method ? ' method' : ''),
+          // Display in gray when method cannot be applied
+          (m.expression.noMethodObject ? ' no-object' : ''),
+          (m.expression.isStatic ? '' : ' it'), issue,
+          (wild ? ' wildcard' : ''), clk, ', false);"', mover, '>',
           (wild ? wildcardFormat(m.selector) : m.selector),
-          '</td><td class="equation-expression',
+          '</td><td class="equation-expression', issue,
+          (issue ? '"title="' +
+              safeDoubleQuotes(m.expression.compile_issue ||
+                  m.expression.compute_issue) : ''),
           clk, ');">', m.expression.text, '</td></tr>'].join(''));
     }
     this.table.innerHTML = ml.join('');
@@ -164,6 +175,8 @@ class EquationManager {
   
   showInfo(id, shift) {
     // @@TO DO: Display documentation for the equation => extra comments field?
+    const d = MODEL.equations_dataset.modifiers[id];
+    if(d) DOCUMENTATION_MANAGER.update(d, shift);
   }
   
   selectModifier(event, id, x=true) {

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

@@ -114,11 +114,14 @@ class GUIExperimentManager extends ExperimentManager {
     document.getElementById('xv-download-btn').addEventListener(
         'click', () => EXPERIMENT_MANAGER.promptForDownload());
     // The viewer's drop-down selectors
-    document.getElementById('viewer-variable').addEventListener( 
+    this.viewer_variable = document.getElementById('viewer-variable');
+    this.viewer_variable.addEventListener( 
         'change', () => EXPERIMENT_MANAGER.setVariable());
-    document.getElementById('viewer-statistic').addEventListener( 
+    this.viewer_statistic = document.getElementById('viewer-statistic');
+    this.viewer_statistic.addEventListener( 
         'change', () => EXPERIMENT_MANAGER.setStatistic());
-    document.getElementById('viewer-scale').addEventListener( 
+    this.viewer_scale = document.getElementById('viewer-scale');
+    this.viewer_scale.addEventListener( 
         'change', () => EXPERIMENT_MANAGER.setScale());
     // The spin buttons
     document.getElementById('xp-cd-minus').addEventListener( 
@@ -272,12 +275,12 @@ class GUIExperimentManager extends ExperimentManager {
   
   updateDialog() {
     this.updateChartList();
-    // Warn modeler if no meaningful experiments can be defined
+    // Warn modeler if no meaningful experiments can be defined.
     if(MODEL.outcomeNames.length === 0 && this.suitable_charts.length === 0) {
       this.default_message.style.display = 'block';
       this.params_div.style.display = 'none';
       this.selected_experiment = null;
-      // Disable experiment dialog menu buttons
+      // Disable experiment dialog menu buttons.
       UI.disableButtons('xp-new xp-rename xp-view xp-delete xp-ignore');
     } else {
       this.default_message.style.display = 'none';
@@ -388,7 +391,7 @@ class GUIExperimentManager extends ExperimentManager {
           x.charts[i].title, '</td></tr>'].join(''));
     }
     this.chart_table.innerHTML = tr.join('');
-    // Do not show viewer unless at least 1 dependent variable has been defined
+    // Do not show viewer unless at least 1 dependent variable has been defined.
     if(x.charts.length === 0 && MODEL.outcomeNames.length === 0) canview = false;
     if(tr.length >= this.suitable_charts.length) {
       document.getElementById('xp-c-add-btn').classList.add('v-disab');
@@ -409,7 +412,7 @@ class GUIExperimentManager extends ExperimentManager {
       dbtn.classList.add('v-disab');
       cbtn.classList.add('v-disab');
     }
-    // Enable viewing only if > 1 dimensions and > 1 outcome variables
+    // Enable viewing only if > 1 dimensions and > 1 outcome variables.
     if(canview) {
       UI.enableButtons('xp-view');
     } else {
@@ -478,38 +481,51 @@ class GUIExperimentManager extends ExperimentManager {
     if(x) {
       this.design.style.display = 'none';
       document.getElementById('viewer-title').innerHTML = x.title;
-      document.getElementById('viewer-statistic').value = x.selected_statistic;
+      this.viewer_statistic.value = x.selected_statistic;
       this.updateViewerVariable();
       // NOTE: calling updateSpinner with dir=0 will update without changes
       this.updateSpinner('c', 0);
       this.drawTable(); 
-      document.getElementById('viewer-scale').value = x.selected_scale;
+      this.viewer_scale.value = x.selected_scale;
       this.setColorScale(x.selected_color_scale);
       this.viewer.style.display = 'block';
     }
   }
   
   updateViewerVariable() {
-    // Update the variable drop-down selector of the viewer
+    // Update the variable drop-down selector of the viewer.
     const x = this.selected_experiment;
     if(x) {
       x.inferVariables();
       const
           ol = [],
-          vl = MODEL.outcomeNames;
+          ov = MODEL.outcomeNames,
+          vl = [...ov];
       for(let i = 0; i < x.variables.length; i++) {
-        addDistinct(x.variables[i].displayName, vl); 
+        const
+            vn = x.variables[i].displayName,
+            oi = ov.indexOf(vn);
+        // If an outcome dataset or equation is plotted in an experiment
+        // chart, remove its name from the outcome variable list.
+        if(oi >= 0) ov.splice(oi, 1);
+        addDistinct(vn, vl); 
       }
       vl.sort((a, b) => UI.compareFullNames(a, b));
       for(let i = 0; i < vl.length; i++) {
-        ol.push(['<option value="', vl[i], '"',
-            (vl[i] == x.selected_variable ? ' selected="selected"' : ''),
-            '>', vl[i], '</option>'].join(''));
-      }
-      document.getElementById('viewer-variable').innerHTML = ol.join('');
-      if(x.selected_variable === '') {
-        x.selected_variable = vl[0];
+        const vn = vl[i];
+        // NOTE: FireFox selector dropdown areas have a pale gray
+        // background that darkens when color is set, so always set it
+        // to white (like Chrome). Then set color of outcome variables
+        // to fuchsia to differentiate from variables for which time
+        // series are stored as experiment run results.
+        ol.push(['<option value="', vn, '" style="background-color: white',
+            (ov.indexOf(vn) >= 0 ? '; color: #b00080"' : '"'),
+            (vn == x.selected_variable ? ' selected="selected"' : ''),
+            '>', vn, '</option>'].join(''));
       }
+      this.viewer_variable.innerHTML = ol.join('');
+      // Initially, select the first variable on the list.
+      if(x.selected_variable === '') x.selected_variable = vl[0];
     }
   }
   
@@ -684,8 +700,10 @@ class GUIExperimentManager extends ExperimentManager {
         for(let j = 0; j < n; j++) {
           const
               c = r + j + i * nrows,
+              run = x.runs[c],
               ic = x.chart_combinations.indexOf(c);
-          if(add) {
+          // NOTE: Only add if run has been executed and stored.
+          if(add && run) {
             if(ic < 0) x.chart_combinations.push(c);
           } else {
             if(ic >= 0) x.chart_combinations.splice(ic, 1);        
@@ -952,7 +970,7 @@ N = ${rr.N}, vector length = ${rr.vector.length}` : '')].join('');
     // Update view for selected variable
     const x = this.selected_experiment;
     if(x) {
-      x.selected_variable = document.getElementById('viewer-variable').value;
+      x.selected_variable = this.viewer_variable.value;
       this.updateData();
     }
   }
@@ -961,7 +979,7 @@ N = ${rr.N}, vector length = ${rr.vector.length}` : '')].join('');
     // Update view for selected variable.
     const x = this.selected_experiment;
     if(x) {
-      x.selected_statistic = document.getElementById('viewer-statistic').value;
+      x.selected_statistic = this.viewer_statistic.value;
       this.updateData();
       // NOTE: Update of Chart Manager is needed only when it is showing
       // run statistics.
@@ -1027,7 +1045,7 @@ N = ${rr.N}, vector length = ${rr.vector.length}` : '')].join('');
     // Update view for selected scale
     const x = this.selected_experiment;
     if(x) {
-      x.selected_scale = document.getElementById('viewer-scale').value;
+      x.selected_scale = this.viewer_scale.value;
       this.updateData();
       // NOTE: Update of Chart Manager is needed when it is showing
       // run statistics because solver times may be plotted.