linny-r 2.1.2 → 2.1.3

package/package.json

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

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

@@ -175,11 +175,11 @@ class GUIDatasetManager extends DatasetManager {
       if(r) {
         const e = new Event('click');
         if(this.focal_table === this.dataset_table) {
-          // Emulate Alt-click in the table to open the time series dialog
+          // Emulate Alt-click in the table to open the time series dialog.
           e.altKey = true;
           r.dispatchEvent(e);
         } else if(this.focal_table === this.modifier_table) {
-          // Emulate a double-click on the second cell to edit the expression
+          // Emulate a double-click on the second cell to edit the expression.
           this.last_time_clicked = Date.now();
           r.cells[1].dispatchEvent(e);
         }
@@ -576,7 +576,9 @@ class GUIDatasetManager extends DatasetManager {
       this.editData();
       return;
     }
-    this.updateDialog();
+    // NOTE: Updating entire dialog may be very time-consuming
+    // when model contains numerous prefixed datasets.
+    this.updatePanes();
   }
   
   selectModifier(event, id, x=true) {
@@ -1196,7 +1198,7 @@ class GUIDatasetManager extends DatasetManager {
       }
     }
     for(let i = 0; i < dsn.length; i++) {
-      const n = unquoteCSV(dsn[i].trim());
+      const n = UI.cleanName(unquoteCSV(dsn[i].trim()));
       if(!UI.validName(n)) {
         UI.warn(`Invalid dataset name "${n}" in column ${i}`);
         return false;
@@ -1265,8 +1267,10 @@ class GUIDatasetManager extends DatasetManager {
           added++;
         }
         ds.computeStatistics();
-      } else {
+      } else if(ds && ds.type) {
         UI.warn(`Name conflict: ${ds.type} "${ds.displayName}" already exists`);
+      } else {
+        UI.alert(`No dataset "${n}" added`);
       }
     }
     // Notify modeler of changes (if any).

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

@@ -3395,13 +3395,22 @@ class LinnyRModel {
       }
     }
     sl.push('_____Datasets');
-    for(obj in this.datasets) {
-      if(this.datasets.hasOwnProperty(obj) && !obj.startsWith(UI.BLACK_BOX) &&
-          obj !== UI.EQUATIONS_DATASET_ID) {
-        sl.push(this.datasets[obj].displayName, this.datasets[obj].comments);
+    for(const k of Object.keys(this.datasets)) {
+      if(!k.startsWith(UI.BLACK_BOX) && k !== UI.EQUATIONS_DATASET_ID) {
+        const ds = this.datasets[k]; 
+        sl.push(ds.displayName, ds.comments);
+        const keys = Object.keys(ds.modifiers).sort(compareSelectors);
+        if(keys.length) {
+          for(const k of keys) {
+            const m = ds.modifiers[k];
+            // NOTE: The trailing arrow signals the Documentation manager that
+            // this (name, documentation) pair is a dataset modifier.
+            sl.push(`${m.selector} →` , m.expression.text);
+          }
+        }
       }
     }
-    const keys = Object.keys(this.equations_dataset.modifiers); 
+    const keys = Object.keys(this.equations_dataset.modifiers).sort(); 
     sl.push('_____Equations');
     for(const k of keys) {
       const m = this.equations_dataset.modifiers[k];
@@ -3486,6 +3495,7 @@ class LinnyRModel {
       this.cleanVector(p.level, p.initial_level.result(1));
       this.cleanVector(p.cost_price, VM.UNDEFINED);
       this.cleanVector(p.cash_flow, 0, 0);
+      this.cleanVector(p.marginal_cash_flow, 0, 0);
       this.cleanVector(p.cash_in, 0, 0);
       this.cleanVector(p.cash_out, 0, 0);
       // NOTE: `start_ups` is a list of time steps when start-up occurred.
@@ -4407,7 +4417,17 @@ class IOBinding {
       this.actual_name = '';
     }
   }
-  
+
+  get copy() {
+    // Return a copy of this binding.
+    const copy = new IOBinding(this.io_type, this.entity_type,
+        this.is_data, this.name_in_module);
+    copy.id = this.id;
+    copy.actual_name = this.actual_name;
+    copy.actual_id = this.actual_id;
+    return copy;
+  }
+
   bind(an) {
     // Establish a binding with actual name `an` if this entity is known to be
     // of the correct type (and for products also a matching data property)
@@ -4561,7 +4581,7 @@ class IOContext {
     // Return a deep copy of the bindings object.
     const copy = {};
     for(const k of Object.keys(this.bindings)) {
-      copy[k] = Object.assign({}, this.bindings[k]);
+      copy[k] = this.bindings[k].copy;
     }
     return copy;
   }
@@ -5458,7 +5478,7 @@ class Note extends ObjectWithXYWH {
               from_unit = '1';
             }
           }
-        } else if(attr === 'CI' || attr === 'CO' || attr === 'CF') {
+        } else if(['CI', 'CO', 'CF', 'MCF'].indexOf(attr) >= 0) {
           from_unit = MODEL.currency_unit;
         }
         // If still no value, `attr` may be an expression-type attribute.
@@ -5672,6 +5692,20 @@ class NodeBox extends ObjectWithXYWH {
     return this.name;
   }
   
+  get bindingsAsString() {
+    if(!this.module) return '';
+    const bk = Object.keys(this.module.bindings);
+    if(bk.length) {
+      const list = [pluralS(bk.length, 'binding') + ':'];
+      for(const k of bk) {
+        const b = this.module.bindings[k];
+        list.push(`‣ ${b.name_in_module} ↬ ${b.actual_name}`);
+      }
+      return list.join('\n');
+    }
+    return '(no bindings)';
+  }
+  
   get infoLineName() {
     // Return display name plus VM variable indices when debugging.
     let n = this.displayName;
@@ -5685,7 +5719,8 @@ class NodeBox extends ObjectWithXYWH {
         dl.push(pluralS(this.all_processes.length, 'process').toLowerCase());
         dl.push(pluralS(this.all_products.length, 'product').toLowerCase());
       }
-      if(this.module) dl.push(`included from <span class="mod-name">${this.module.name}</span>`);
+      if(this.module) dl.push('included from <span class="mod-name" title="' +
+          `${this.bindingsAsString}">${this.module.name}</span>`);
       if(dl.length) n += `<span class="node-details">${dl.join(', ')}</span>`;
     }
     if(!MODEL.solved) return n;
@@ -7842,8 +7877,9 @@ class Process extends Node {
     this.power_grid = null;
     this.length_in_km = 0;
     this.reactance = 0;
-    // Processes have 3 more result attributes: CP, CF, CI and CO
+    // Processes have 4 more result attributes: CF, MCF, CI and CO
     this.cash_flow = [];
+    this.marginal_cash_flow = [];
     this.cash_in = [];
     this.cash_out = [];
     // Production level changing from 0 to positive counts as "start up",
@@ -7898,6 +7934,7 @@ class Process extends Node {
       const t = MODEL.t;
       a.L = this.level[t];
       a.CF = this.cash_flow[t];
+      a.MCF = this.marginal_cash_flow[t];
       a.CI = this.cash_in[t];
       a.CO = this.cash_out[t];
       if(MODEL.infer_cost_prices) a.CP = this.cost_price[t];
@@ -8034,6 +8071,7 @@ class Process extends Node {
     // For processes, these are all vectors.
     if(a === 'L') return this.level;
     if(a === 'CF') return this.cash_flow;
+    if(a === 'MCF') return this.marginal_cash_flow;
     if(a === 'CI') return this.cash_in;
     if(a === 'CO') return this.cash_out;
     if(a === 'CP') return this.cost_price;

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

@@ -2359,6 +2359,7 @@ class VirtualMachine {
       'CP':  'cost price',
       'HCP': 'highest cost price',
       'CF':  'cash flow',
+      'MCF': 'marginal cash flow',
       'CI':  'cash in',
       'CO':  'cash out',
       'W':   'weight',
@@ -2371,7 +2372,7 @@ class VirtualMachine {
     // NOTE: Defaults are level (L), link flow (F), cluster cash flow (CF),
     // actor cash flow (CF); dataset value (no attribute).
     // NOTE: Exogenous properties first, then the computed properties.
-    this.process_attr = ['LB', 'UB', 'IL', 'LCF', 'L', 'CI', 'CO', 'CF', 'CP'];
+    this.process_attr = ['LB', 'UB', 'IL', 'LCF', 'L', 'CI', 'CO', 'CF', 'MCF', 'CP'];
     this.product_attr = ['LB', 'UB', 'IL', 'P', 'L', 'CP', 'HCP'];
     this.cluster_attr = ['CI', 'CO', 'CF'];
     this.link_attr = ['R', 'D', 'SOC', 'F'];
@@ -2397,7 +2398,7 @@ class VirtualMachine {
       for(const a of ac) this.entity_attribute_names[el].push(a);
     }
     // Level-based attributes are computed only AFTER optimization.
-    this.level_based_attr = ['L', 'CP',  'HCP', 'CF', 'CI', 'CO', 'F', 'A'];
+    this.level_based_attr = ['L', 'CP',  'HCP', 'CF', 'MCF', 'CI', 'CO', 'F', 'A'];
     this.object_types = ['Process', 'Product', 'Cluster', 'Link', 'Constraint',
         'Actor', 'Dataset', 'Equation'];
     this.type_attributes = [this.process_attr, this.product_attr,
@@ -5139,13 +5140,18 @@ class VirtualMachine {
         // Cash flows of process p are now known.
         p.cash_in[b] = ci;
         p.cash_out[b] = co;
-        p.cash_flow[b] = ci - co;
+        const
+            cf = ci - co,
+            apl = Math.abs(p.level[b]);
+        p.cash_flow[b] = cf;
+        // Marginal cash flow is considered 0 when process level = 0.
+        p.marginal_cash_flow[b] = (apl < VM.NEAR_ZERO ? 0 : cf / apl);
         // Also add these flows to all parent clusters of the process.
         let c = p.cluster;
         while(c) {
           c.cash_in[b] += ci;
           c.cash_out[b] += co;
-          c.cash_flow[b] += ci - co;
+          c.cash_flow[b] += cf;
           c = c.cluster;
         }
       }
@@ -7388,14 +7394,13 @@ function VMI_push_statistic(x, args) {
   // If so, trim the 'NZ'
   if(nz) stat = stat.slice(0, -2);
   // Now t1 ... t2 is the range of time steps to iterate over for each variable
-  let obj,
-      vlist = [];
+  const vlist = [];
   for(let t = t1; t <= t2; t++) {
     // Get the list of values.
     // NOTE: Variables may be vectors or expressions.
     for(const obj of list) {
       if(Array.isArray(obj)) {
-        // Object is a vector
+        // Object is a vector.
         if(t < obj.length) {
           v = obj[t];
         } else {