linny-r 1.4.4 → 1.4.6

package/package.json

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

package/static/index.html

@@ -1754,6 +1754,8 @@ NOTE: * and ? will be interpreted as wildcards"
            title="New equation">
       <img id="eq-rename-btn" class="btn disab" src="images/rename.png"
            title="Rename selected equation">
+      <img id="eq-clone-btn" class="btn disab" src="images/clone.png"
+           title="Clone selected equation">
       <img id="eq-edit-btn" class="btn disab" src="images/edit.png"
            title="Edit selected equation">
       <img id="eq-delete-btn" class="btn disab" src="images/delete.png"
@@ -1790,6 +1792,18 @@ NOTE: * and ? will be interpreted as wildcards"
     </div>
   </div>
 
+  <!-- the CLONE EQUATION dialog prompts for the new name of an equation -->
+  <div id="clone-equation-modal" class="modal">
+    <div id="clone-equation-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Clone equation
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <input id="clone-equation-name" type="text" autocomplete="off">
+    </div>
+  </div>
+
 
   <!-- the CHART dialog allows definition of charts and displays them -->
   <div id="chart-dlg" class="inp-dlg">

package/static/linny-r.css

@@ -2439,7 +2439,8 @@ td.equation-expression {
 #new-dataset-dlg,
 #rename-dataset-dlg,
 #new-equation-dlg,
-#rename-equation-dlg {
+#rename-equation-dlg,
+#clone-equation-dlg {
   width: 240px;
   height: 45px;
 }
@@ -2447,7 +2448,8 @@ td.equation-expression {
 #new-dataset-name,
 #rename-dataset-name,
 #new-equation-name,
-#rename-equation-name {
+#rename-equation-name,
+#clone-equation-name {
   position: absolute;
   bottom: 2px;
   left: 2px;

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

@@ -1261,7 +1261,7 @@ class ExperimentManager {
   }
 
   processRestOfRun() {   
-    // Performs post-processing after run results have been added
+    // Performs post-processing after run results have been added.
     const x = MODEL.running_experiment;
     if(!x) return;
     const aci = x.active_combination_index;

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

@@ -48,6 +48,8 @@ class EquationManager {
         'click', () => EQUATION_MANAGER.promptForEquation());
     document.getElementById('eq-rename-btn').addEventListener(
         'click', () => EQUATION_MANAGER.promptForName());
+    document.getElementById('eq-clone-btn').addEventListener(
+        'click', () => EQUATION_MANAGER.promptToClone());
     document.getElementById('eq-edit-btn').addEventListener(
         'click', () => EQUATION_MANAGER.editEquation());
     document.getElementById('eq-delete-btn').addEventListener(
@@ -66,6 +68,12 @@ class EquationManager {
     this.rename_modal.cancel.addEventListener(
         'click', () => EQUATION_MANAGER.rename_modal.hide());
 
+    this.clone_modal = new ModalDialog('clone-equation');
+    this.clone_modal.ok.addEventListener(
+        'click', () => EQUATION_MANAGER.cloneEquation());
+    this.clone_modal.cancel.addEventListener(
+        'click', () => EQUATION_MANAGER.clone_modal.hide());
+
     // Initialize the dialog properties
     this.reset();
   }
@@ -146,7 +154,7 @@ class EquationManager {
     this.table.innerHTML = ml.join('');
     this.scroll_area.style.display = 'block';
     if(sm) UI.scrollIntoView(document.getElementById(smid));
-    const btns = 'eq-rename eq-edit eq-delete';
+    const btns = 'eq-rename eq-clone eq-edit eq-delete';
     if(sm) {
       UI.enableButtons(btns);
     } else {
@@ -294,6 +302,43 @@ class EquationManager {
     this.updateDialog();
   }
   
+  promptToClone() {
+    // Prompts the modeler for the name of the clone to make of the
+    // selected equation (if any).
+    if(this.selected_modifier) {
+      this.clone_modal.element('name').value = this.selected_modifier.selector;
+      this.clone_modal.show('name');
+    }
+  }
+  
+  cloneEquation() {
+    if(!this.selected_modifier) return;
+    const
+        s = this.clone_modal.element('name').value,
+        // New equation identifier must not equal some entity ID
+        obj = MODEL.objectByName(s);
+    if(obj) {
+      // NOTE: also pass selector, or warning will display dataset name.
+      UI.warningEntityExists(obj);
+      return null;
+    }
+    // Name is new and unique, so try to use it
+    const m = MODEL.equations_dataset.addModifier(s);
+    // NULL indicates invalid name, and modeler will have been warned.
+    if(!m) return;
+    // Give the new modifier the same expression as te selected one.
+    m.expression.text = this.selected_modifier.expression.text;
+    // Compile the expression. This may generate a warning when the new
+    // name does not provide adequate context.
+    m.expression.compile();
+    // 
+    this.selected_modifier = m;
+    // Even if warning was given, close the name prompt dialog, and update
+    // the equation manager.
+    this.clone_modal.hide();
+    this.updateDialog();
+  }
+  
   deleteEquation() {
     const m = this.selected_modifier;
     if(m) {

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

@@ -205,7 +205,8 @@ NOTE: Grouping groups results in a single group, e.g., (1;2);(3;4;5) evaluates a
         }
       }
       if(a) n += ` (${a})`;
-      UI.edited_object = MODEL.objectByName(n);
+      // NOTE: Names may contain ampersand as HTML entity.
+      UI.edited_object = MODEL.objectByName(n.replace('&', '&'));
       this.edited_input_id = UI.edited_object.type.toLowerCase() + '-' + ids[1];
       this.edited_expression = UI.edited_object.attributeExpression(ids[1]);
     }

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

@@ -2963,7 +2963,7 @@ class LinnyRModel {
             const cv = new ChartVariable(null);
             cv.setProperties(v.object, v.attribute, false, '#000000');
             vbls.push(cv);
-            names.push(uvn);
+            names.push(vn);
           }
         } else if(names.indexOf(vn) < 0) {
           // Keep track of the dataset and dataset modifier variables,
@@ -2988,7 +2988,8 @@ class LinnyRModel {
           if(names.indexOf(n) < 0) {
             // Here, too, NULL can be used as "owner chart". 
             const cv = new ChartVariable(null);
-            cv.setProperties(ds, dm.selector, false, '#000000');
+            // NOTE: For equations, the object is the dataset modifier.
+            cv.setProperties(eq ? dm : ds, dm.selector, false, '#000000');
             vbls.push(cv);
           }
         }
@@ -8433,15 +8434,26 @@ class Dataset {
   }
 
   get plainSelectors() {
-    // Returns sorted list of selectors that do not contain wildcards
-    const sl = this.selectorList;
-    // NOTE: wildcard selectors will always be at the end of the list
+    // Return sorted list of selectors that do not contain wildcards.
+    const sl = this.selectorList.slice();
+    // NOTE: Wildcard selectors will always be at the end of the list
     for(let i = sl.length - 1; i >= 0; i--) {
       if(sl[i].indexOf('*') >= 0 || sl[i].indexOf('?') >= 0) sl.pop();
     }
     return sl;
   }
   
+  get wildcardSelectors() {
+    // Return sorted list of selectors that DO contain wildcards.
+    const sl = this.selectorList;
+    // NOTE: Wildcard selectors will always be at the end of the list.
+    let i = sl.length - 1;
+    while(i >= 0 && (sl[i].indexOf('*') >= 0 || sl[i].indexOf('?') >= 0)) {
+      i--;
+    }
+    return sl.slice(i+1);
+  }
+  
   isWildcardSelector(s) {
     // Returns TRUE if `s` contains * or ?
     // NOTE: for equations, the wildcard must be ??
@@ -8913,7 +8925,16 @@ class ChartVariable {
     // by its scale factor unless it equals 1 (no scaling).
     const sf = (this.scale_factor === 1 ? '' :
         ` (x${VM.sig4Dig(this.scale_factor)})`);
-    // NOTE: Display name of equation is just the equations dataset modifier.
+    //Display name of equation is just the equations dataset selector. 
+    if(this.object instanceof DatasetModifier) {
+      let eqn = this.object.selector;
+      if(this.wildcard_index !== false) {
+        eqn = eqn.replace('??', this.wildcard_index);
+      }
+      return eqn + sf;
+    }
+    // NOTE: Same holds for "dummy variables" added for wildcard
+    // dataset selectors.
     if(this.object === MODEL.equations_dataset) {
       let eqn = this.attribute;
       if(this.wildcard_index !== false) {
@@ -9299,6 +9320,8 @@ class Chart {
         vlist.push(v);
       }
       return vlist;
+      // FALL-THROUGH: Equation name has no wildcard => use the equation
+      // object (= dataset modifier) as `obj`.
     }
     const v = new ChartVariable(this);
     v.setProperties(obj, a, false, this.nextAvailableDefaultColor, 1, 1);
@@ -10109,8 +10132,8 @@ class ActorSelector {
 class ExperimentRunResult {
   constructor(r, v, a='') {
     // NOTE: constructor can be called with `v` a chart variable, a dataset,
-    // or an XML node; if `v` is the equations dataset, then `a` indicates the
-    // attribute to be used
+    // or an XML node; if `v` is the equations dataset, then `a` is the
+    // identifier of the dataset modifier to be used. 
     this.run = r;
     if(v instanceof ChartVariable) {
       this.x_variable = true;
@@ -10182,7 +10205,7 @@ class ExperimentRunResult {
       this.exceptions = 0;
       const
           // NOTE: run result dataset selector will be plain (no wildcards)
-          x = v.attributeExpression(this.attribute),
+          x = v.modifiers[this.attribute].expression,
           t_end = MODEL.end_period - MODEL.start_period + 1;
       // N = # time steps
       this.N = t_end;
@@ -10558,7 +10581,7 @@ class ExperimentRun {
           new ExperimentRunResult(this, this.experiment.variables[vi]));
       this.step++;
       UI.setProgressNeedle(this.step / this.steps);
-      setTimeout(function(x) { x.addChartResults(vi + 1); }, 0, this);
+      setTimeout((x) => x.addChartResults(vi + 1), 0, this);
     } else {
       this.addOutcomeResults(0);
     }
@@ -10571,7 +10594,7 @@ class ExperimentRun {
       this.results.push(new ExperimentRunResult(this, MODEL.outcomes[oi]));
       this.step++;
       UI.setProgressNeedle(this.step / this.steps);
-      setTimeout(function(x) { x.addOutcomeResults(oi + 1); }, 0, this);
+      setTimeout((x) => x.addOutcomeResults(oi + 1), 0, this);
     } else {
       this.addEquationResults(0);
     }
@@ -10586,7 +10609,7 @@ class ExperimentRun {
           new ExperimentRunResult(this, MODEL.equations_dataset, k));      
       this.step++;
       UI.setProgressNeedle(this.step / this.steps);
-      setTimeout(function(x) { x.addEquationResults(ei + 1); }, 0, this);
+      setTimeout((x) => x.addEquationResults(ei + 1), 0, this);
     } else {
       // Register when this result was stored
       this.time_recorded = new Date().getTime();
@@ -10596,8 +10619,10 @@ class ExperimentRun {
       // Log the time it took to compute all results
       VM.logMessage(VM.block_count - 1,
           `Processing run results took ${VM.elapsedTime} seconds.`);
-      // NOTE: addResults is called by either the experiment manager or the
-      // sensitivity analysis  => proceed there
+      // Report results if applicable.
+      if(RECEIVER.solving || MODEL.report_results) RECEIVER.report();
+      // NOTE: addResults is called by either the experiment manager or
+      // the sensitivity analysis; hence proceed from there.
       if(SENSITIVITY_ANALYSIS.experiment) {
         SENSITIVITY_ANALYSIS.processRestOfRun();
       } else {

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

@@ -666,7 +666,7 @@ function customizeXML(str) {
   // First modify `str` -- by default, do nothing
   
 /*
-  if(str.indexOf('<author>XXX</author>') >= 0) {
+  if(str.indexOf('<version>1.4.') >= 0) {
     str = str.replace(/<url>NL\/(\w+)\.csv<\/url>/g, '<url></url>');
   }
 */

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

@@ -348,6 +348,8 @@ class Expression {
       v[t] = this.stack.pop();
     }
     this.trace('RESULT = ' + VM.sig4Dig(v[t]));
+    // Store wildcard result also in "normal" vector
+    this.vector[t] = v[t];
     // Pop the time step.
     this.step.pop();
     this.trace('--STOP: ' + this.variableName);
@@ -5268,10 +5270,13 @@ Solver status = ${json.status}`);
       UI.drawDiagram(MODEL);
       // Show the reset button (GUI only)
       UI.readyToReset();
-      // If receiver is active, report results
-      if(RECEIVER.solving || MODEL.report_results) RECEIVER.report();
-      // If experiment is active, signal the manager
-      if(MODEL.running_experiment) EXPERIMENT_MANAGER.processRun();
+      if(MODEL.running_experiment) {
+       // If experiment is active, signal the manager.
+        EXPERIMENT_MANAGER.processRun();
+      } else if(RECEIVER.solving || MODEL.report_results) {
+        // Otherwise report results now, if applicable.
+        RECEIVER.report();
+      }
       // Warn modeler if any issues occurred
       if(this.block_issues) {
         let msg = 'Issues occurred in ' +
@@ -5677,8 +5682,8 @@ function valueOfNumberSign(x) {
   // ending on digits, or tne number context of an entity. The latter typically
   // is the number its name or any of its prefixes ends on, but notes are
   // more "creative" and can return the number context of nearby entities.
-  let s = 'NO SELECTOR',
-      m = 'NO MATCH',
+  let s = '!NO SELECTOR',
+      m = '!NO MATCH',
       n = VM.UNDEFINED;
   // NOTE: Give wildcard selectors precedence over experiment selectors
   // because a wildcard selector is an immediate property of the dataset
@@ -5692,17 +5697,15 @@ function valueOfNumberSign(x) {
     // Check whether `x` is a dataset modifier expression.
     // NOTE: This includes equations.
     if(x.object instanceof Dataset) {
-      if(x.attribute) {
-        s = x.attribute;
-      } else {
-        // Selector may also be defined by a running experiment.
-        if(MODEL.running_experiment) {
-          // Let `m` be the primary selector for the current experiment run.
-          const sl = MODEL.running_experiment.activeCombination;
-          if(sl) {
-            m = sl[0];
-            s = 'experiment';
-          }
+      if(x.attribute) s = x.attribute;
+      // Selector may also be defined by a running experiment.
+      if(MODEL.running_experiment) {
+        const
+            ac = MODEL.running_experiment.activeCombination,
+            mn = matchingNumberInList(ac, s);
+        if(mn !== false) {
+          m = 'x-run';
+          n = mn;
         }
       }
     }
@@ -5715,10 +5718,6 @@ function valueOfNumberSign(x) {
         m = d;
         n = parseInt(d);
       }
-    } else if(m !== 'NO MATCH') {
-      // If matching `m` against `s` do not yield an integer string,
-      // use UNDEFINED
-      n = matchingNumber(m, s) || VM.UNDEFINED;
     }
   }
   // For datasets, set the parent anchor to be the context-sensitive number
@@ -5941,7 +5940,7 @@ function VMI_push_dataset_modifier(x, args) {
   // If `s` is not specified, the modifier to be used must be inferred from
   // the running experiment UNLESS the field `ud` ("use data") is defined
   // for the first argument, and evaluates as TRUE.
-  // NOTE: Ensure that number 0 is not interpreted as FALSE. 
+  // NOTE: Ensure that number 0 is not interpreted as FALSE.
   let wcnr = (args[0].s === undefined ? false : args[0].s);
   const
       ds = args[0].d,
@@ -5960,7 +5959,6 @@ function VMI_push_dataset_modifier(x, args) {
   let t = tot[0],
       // By default, use the vector of the dataset to compute the value.
       obj = ds.vector;
-      
   if(ds.array) {
     // For array-type datasets, do NOT adjust "index" t to model run period.
     // NOTE: Indices start at 1, but arrays are zero-based, so subtract 1.
@@ -5994,16 +5992,17 @@ function VMI_push_dataset_modifier(x, args) {
     if(wcnr === '?') {
       wcnr = x.wildcard_vector_index;
     }
-  } else if(!ud ) {
+  } else if(!ud) {
     // In no selector and not "use data", check whether a running experiment
     // defines the expression to use. If not, `obj` will be the dataset
     // vector (so same as when "use data" is set).
     obj = ds.activeModifierExpression;
-    if(wcnr === false && obj instanceof Expression && MODEL.running_experiment) {
+    if(wcnr === false && MODEL.running_experiment) {
       // If experiment run defines the modifier selector, the active
       // combination may provide a context for #.
-      wcnr = matchingNumberInList(MODEL.running_experiment.activeCombination,
-          obj.attribute);
+      const sel = (obj instanceof Expression ? obj.attribute : x.attribute);
+      wcnr = matchingNumberInList(
+          MODEL.running_experiment.activeCombination, sel);
     }
   }
   if(!obj) {
@@ -6040,7 +6039,9 @@ function VMI_push_dataset_modifier(x, args) {
     // `obj` is an expression.
     // NOTE: Readjust `t` when `obj` is an expression for an *array-type*
     // dataset modifier.
-    if(obj.object instanceof Dataset && obj.object.array) t++;
+    if(obj.object instanceof Dataset && obj.object.array) {
+      t++;
+    }
     v = obj.result(t, wcnr);
   }
   // Trace only now that time step t has been computed.