linny-r 1.4.1 → 1.4.3

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

@@ -2940,24 +2940,72 @@ class LinnyRModel {
   }
 
   get outputData() {
-    // Returns model results [data, statistics] in tab-separated format
-    // First create list of distinct variables used in charts
-    const vbls = [];
+    // Returns model results [data, statistics] in tab-separated format.
+    const
+        vbls = [],
+        names = [],
+        scale_re = /\s+\(x[0-9\.\,]+\)$/;
+    // First create list of distinct variables used in charts.
+    // NOTE: Also include those that are not "visible" in a chart.
     for(let i = 0; i < this.charts.length; i++) {
       const c = this.charts[i];
       for(let j = 0; j < c.variables.length; j++) {
-        addDistinct(c.variables[j], vbls);
+        let v = c.variables[j],
+            vn = v.displayName;
+        // If variable is scaled, do not include it as such, but include
+        // a new unscaled chart variable.
+        if(vn.match(scale_re)) {
+          vn = vn.replace(scale_re, '');
+          // Add only if (now unscaled) variable has not been added already.
+          if(names.indexOf(vn) < 0) {
+            // NOTE: Chart variable object is used ony as adummy, so NULL
+            // can be used as its "owner chart". 
+            const cv = new ChartVariable(null);
+            cv.setProperties(v.object, v.attribute, false, '#000000');
+            vbls.push(cv);
+            names.push(uvn);
+          }
+        } else if(names.indexOf(vn) < 0) {
+          // Keep track of the dataset and dataset modifier variables,
+          // so they will not be added in the next FOR loop.
+          vbls.push(v);
+          names.push(vn);
+        }
+      }
+    }
+    // Add new variables for each outcome dataset and each equation that
+    // is not a chart variable.
+    for(let id in this.datasets) if(this.datasets.hasOwnProperty(id)) {
+      const
+          ds = this.datasets[id],
+          eq = (ds === this.equations_dataset);
+      if(ds.outcome || eq) {
+        for(let ms in ds.modifiers) if(ds.modifiers.hasOwnProperty(ms)) {
+          const
+              dm = ds.modifiers[ms],
+              n = dm.displayName;
+          // Do not add if already in the list.
+          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');
+            vbls.push(cv);
+          }
+        }
       }
     }
-    // Create a new chart (without adding it to this model)
+    // Sort variables by their name.
+    vbls.sort((a, b) => UI.compareFullNames(a.displayName, b.displayName));
+    // Create a new chart as dummy, so without adding it to this model.
     const c = new Chart();
     for(let i = 0; i < vbls.length; i++) {
       const v = vbls[i];
       c.addVariable(v.object.displayName, v.attribute);
     }
-    c.draw();
+    // NOTE: Call `draw` with FALSE to prevent display in the chart manager.
+    c.draw(false);
+    // After drawing, all variables and their statistics have been computed.
     return [c.dataAsString, c.statisticsAsString];
-    // @@@TO DO: also add statistics on "outcome" datasets 
   }
     
   get listOfAllSelectors() {
@@ -5278,14 +5326,14 @@ class NodeBox extends ObjectWithXYWH {
     MODEL.replaceEntityInExpressions(old_name, this.displayName);
     MODEL.inferIgnoredEntities();
     // NOTE: Renaming may affect the node's display size.
-    if(this.resize()) this.drawWithLinks();
+    if(this.resize()) UI.drawSelection(MODEL);
     // NOTE: Only TRUE indicates a successful (cosmetic) name change.
     return true;
   }
   
   resize() {
-    // Resizes this node; returns TRUE iff size has changed
-    // So keep track of original width and height
+    // Resizes this node; returns TRUE iff size has changed.
+    // Therefore, keep track of original width and height.
     const
         ow = this.width,
         oh = this.height,
@@ -5341,12 +5389,13 @@ class NodeBox extends ObjectWithXYWH {
   }
   
   drawWithLinks() {
-    // TO DO: also draw relevant arrows when this is a cluster
+    // TO DO: Also draw relevant arrows when this is a cluster.
     UI.drawObject(this);
     if(this instanceof Cluster) return;
-    // draw ALL arrows associated with this node
+    // Draw ALL arrows associated with this node.
     const fc = this.cluster;
-    // make list of arrows that represent a link related to this node
+    fc.categorizeEntities();
+    // Make list of arrows that represent a link related to this node.
     let a,
         alist = [];
     for(let j = 0; j < fc.arrows.length; j++) {
@@ -5362,7 +5411,7 @@ class NodeBox extends ObjectWithXYWH {
         }
       }
     }
-    // draw all arrows in this list
+    // Draw all arrows in this list.
     for(let i = 0; i < alist.length; i++) UI.drawObject(alist[i]);
   }
   
@@ -7290,6 +7339,7 @@ class Process extends Node {
     a.LB = this.lower_bound.asAttribute;
     a.UB = (this.equal_bounds ? a.LB : this.upper_bound.asAttribute);
     a.IL = this.initial_level.asAttribute;
+    a.LCF = this.pace_expression.asAttribute;
     if(MODEL.solved) {
       const t = MODEL.t;
       a.L = this.level[t];
@@ -7323,7 +7373,7 @@ class Process extends Node {
       // without comments or their (X, Y) position
       n = MODEL.black_box_entities[id];
       // `n` is just the name, so remove the actor name if it was added
-      if(an) n = n.substr(0, n.lastIndexOf(an));
+      if(an) n = n.substring(0, n.lastIndexOf(an));
       col = true;
       cmnts = '';
       x = 0;
@@ -7551,6 +7601,8 @@ class Product extends Node {
       if(MODEL.infer_cost_prices) {
         a.CP = this.cost_price[t];
         a.HCP = this.highest_cost_price[t];
+        // Highest cost price may be undefined if product has no inflows. 
+        if(a.HCP === VM.MINUS_INFINITY) a.HCP = '';
       }
     }
     return a;
@@ -8829,10 +8881,11 @@ class ChartVariable {
     this.non_zero_tally = 0;
     this.exceptions = 0;
     this.bin_tallies = [];
+    this.wildcard_index = false;
   }
   
   setProperties(obj, attr, stck, clr, sf=1, lw=1, vis=true) {
-    // Sets the defining properties for this chart variable
+    // Sets the defining properties for this chart variable.
     this.object = obj;
     this.attribute = attr;
     this.stacked = stck;
@@ -8844,12 +8897,18 @@ class ChartVariable {
   
   get displayName() {
     // Returns the name of the Linny-R entity and its attribute, followed
-    // by its scale factor unless it equals 1 (no scaling)
+    // 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
-    if(this.object === MODEL.equations_dataset) return this.attribute + sf;
-    // NOTE: do not display vertical bar if no attribute is specified
+    // NOTE: Display name of equation is just the equations dataset modifier.
+    if(this.object === MODEL.equations_dataset) {
+      let eqn = this.attribute;
+      if(this.wildcard_index !== false) {
+        eqn = eqn.replace('??', this.wildcard_index);
+      }
+      return eqn + sf;
+    }
+    // NOTE: Do not display the vertical bar if no attribute is specified.
     if(!this.attribute) return this.object.displayName + sf;
     return this.object.displayName + UI.OA_SEPARATOR + this.attribute + sf;
   }
@@ -8919,7 +8978,7 @@ class ChartVariable {
   }
 
   computeVector() {
-    // Compute vector for this variable (using run results if specified)
+    // Compute vector for this variable (using run results if specified).
     let xrun = null,
         rr = null,
         ri = this.chart.run_index;
@@ -8934,10 +8993,10 @@ class ChartVariable {
         this.vector.length = 0;
       }
     }
-    // Compute vector and statistics only if vector is still empty
+    // Compute vector and statistics only if vector is still empty.
     if(this.vector.length > 0) return;
-    // NOTE: expression vectors start at t = 0 with initial values that should
-    // not be included in statistics
+    // NOTE: expression vectors start at t = 0 with initial values that
+    // should not be included in statistics.
     let v,
         av = null,
         t_end;
@@ -8948,22 +9007,23 @@ class ChartVariable {
     this.non_zero_tally = 0;
     this.exceptions = 0;
     if(rr) {
-      // Use run results (time scaled) as "actual vector" `av` for this variable
+      // Use run results (time scaled) as "actual vector" `av` for this
+      // variable.
       const tsteps = Math.ceil(this.chart.time_horizon / this.chart.time_scale);
       av = [];
-      // NOTE: scaleData expects "pure" data, so slice off v[0]
+      // NOTE: `scaleDataToVector` expects "pure" data, so slice off v[0].
       VM.scaleDataToVector(rr.vector.slice(1), av, xrun.time_step_duration,
           this.chart.time_scale, tsteps, 1);
       t_end = tsteps;
     } else {
       // Get the variable's own value (number, vector or expression)
-      // Special case: when an experiment is running, variables that depict a
-      // dataset with no explicit modifier must recompute the vector using the
-      // current experiment run combination
+      // Special case: when an experiment is running, variables that
+      // depict a dataset with no explicit modifier must recompute the
+      // vector using the current experiment run combination.
       if(MODEL.running_experiment &&
           this.object instanceof Dataset && !this.attribute) {
         // Check if dataset modifiers match the combination of selectors
-        // for the active run
+        // for the active run.
         const mm = this.object.matchingModifiers(
             MODEL.running_experiment.activeCombination);
         // If so, use the first (the list should contain at most 1 selector)
@@ -8982,21 +9042,24 @@ class ChartVariable {
       }
       t_end = MODEL.end_period - MODEL.start_period + 1;
     }
-    // NOTE: when a chart combines run results with dataset vectors, the latter
-    // may be longer than the # of time steps displayed in the chart
+    // NOTE: when a chart combines run results with dataset vectors, the
+    // latter may be longer than the # of time steps displayed in the chart.
     t_end = Math.min(t_end, this.chart.total_time_steps);
     this.N = t_end;
     for(let t = 0; t <= t_end; t++) {
-      // Get the result, store it, and incorporate it in statistics
+      // Get the result, store it, and incorporate it in statistics.
       if(!av) {
         // Undefined attribute => zero (no error)
         v = 0;
       } else if(Array.isArray(av)) {
-        // Attribute value is a vector -- may be shorter than t => then use 0
+        // Attribute value is a vector.
+        // NOTE: This vector may be shorter than t; then use 0.
         v = (t < av.length ? av[t] : 0);
       } else if(av instanceof Expression) {
-        // Attribute value is an expression
-        v = av.result(t);
+        // Attribute value is an expression. If this chart variable has
+        // its wildcard vector index set, evaluate the expression with
+        // this index as context number.
+        v = av.result(t, this.wildcard_index);
       } else {
         // Attribute value must be a number
         v = av;
@@ -9165,7 +9228,7 @@ class Chart {
   
   variableIndexByName(n) {
     for(let i = 0; i < this.variables.length; i++) {
-      if(this.variables[i].displayName == n) return i;
+      if(this.variables[i].displayName === n) return i;
     }
     return -1;
   }
@@ -9190,20 +9253,39 @@ class Chart {
     if(n === UI.EQUATIONS_DATASET_NAME) {
       // For equations only the attribute (modifier selector)
       dn = a;
+      n = a;
     } else if(!a) {
       // If no attribute specified (=> dataset) only the entity name
       dn = n;
     }
     let vi = this.variableIndexByName(dn);
     if(vi >= 0) return vi;
-    // check whether name refers to a Linny-R entity defined by the model
+    // Check whether name refers to a Linny-R entity defined by the model.
     let obj = MODEL.objectByName(n);
     if(obj === null) {
       UI.warn(`Unknown entity "${n}"`);
       return null;
-    } else {
-      // no attribute specified? then assume default
+    }
+    const eq = obj instanceof DatasetModifier;
+    if(!eq) {
+      // No equation and no attribute specified? Then assume default.
       if(a === '') a = obj.defaultAttribute;
+    } else if(n.indexOf('??') >= 0) {
+      // Special case: for wildcard equations, add dummy variables
+      // for each vector in the wildcard vector set of the equation
+      // expression.
+      const
+          vlist = [],
+          clr = this.nextAvailableDefaultColor,
+          indices = Object.keys(obj.expression.wildcard_vectors);
+      for(let i = 0; i < indices.length; i++) {
+        const v = new ChartVariable(this);
+        v.setProperties(MODEL.equations_dataset, dn, false, clr);
+        v.wildcard_index = parseInt(indices[i]);
+        this.variables.push(v);
+        vlist.push(v);
+      }
+      return vlist;
     }
     const v = new ChartVariable(this);
     v.setProperties(obj, a, false, this.nextAvailableDefaultColor, 1, 1);
@@ -9296,7 +9378,7 @@ class Chart {
     return VM.sig2Dig(s / 8760) + 'y';
   }
   
-  draw() {
+  draw(display=true) {
     // NOTE: The SVG drawing area is fixed to be 500 pixels high, so that
     // when saved as a file, it will (at 300 dpi) be about 2 inches high.
     // Its width will equal its hight times the W/H-ratio of the chart
@@ -9471,6 +9553,10 @@ class Chart {
       } 
     }
 
+    // Now all vectors have been computed. If `display` is FALSE, this
+    // indicates that data is used only to save model results.
+    if(!display) return;
+    
     // Define the bins when drawing as histogram
     if(this.histogram) {
       this.value_range = maxv - minv;

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

@@ -124,9 +124,9 @@ function msecToTime(msec) {
   const ts = new Date(msec).toISOString().slice(11, -1).split('.');
   let hms = ts[0], ms = ts[1];
   // Trim zero hours and minutes
-  while(hms.startsWith('00:')) hms = hms.substr(3);
+  while(hms.startsWith('00:')) hms = hms.substring(3);
   // Trim leading zero on first number
-  if(hms.startsWith('00')) hms = hms.substr(1);
+  if(hms.startsWith('00')) hms = hms.substring(1);
   // Trim msec when minutes > 0
   if(hms.indexOf(':') > 0) return hms;
   // If < 1 second, return as milliseconds
@@ -173,7 +173,7 @@ function uniformDecimals(data) {
       ss = v.split('e');
       x = ss[1];
       if(x.length < maxe) {
-        x = x[0] + '0' + x.substr(1);
+        x = x[0] + '0' + x.substring(1);
       }
       data[i] = ss[0] + 'e' + x;
     } else if(maxi > 3) {
@@ -186,9 +186,14 @@ function uniformDecimals(data) {
   }
 }
 
+function capitalized(s) {
+  // Returns string `s` with its first letter capitalized.
+  return s.charAt(0).toUpperCase() + s.slice(1);
+}
+
 function ellipsedText(text, n=50, m=10) {
-  // Returns `text` with ellipsis " ... " between its first `n` and last `m`
-  // characters 
+  // Returns `text` with ellipsis " ... " between its first `n` and
+  // last `m` characters. 
   if(text.length <= n + m + 3) return text;
   return text.slice(0, n) + ' \u2026 ' + text.slice(text.length - m);
 }
@@ -478,6 +483,21 @@ function matchingNumber(m, s) {
   return (n == m ? n : false);
 }
 
+function compareWithTailNumbers(s1, s2) {
+  // Returns 0 on equal, an integer < 0 if `s1` comes before `s2`, and
+  // an integer > 0 if `s2` comes before `s1`.
+  if(s1 === s2) return 0;
+  let tn1 = endsWithDigits(s1),
+      tn2 = endsWithDigits(s2);
+  if(tn1) s1 = s1.slice(0, -tn1.length);
+  if(tn2) s2 = s2.slice(0, -tn2.length);
+  let c = ciCompare(s1, s2);
+  if(c !== 0 || !(tn1 || tn2)) return c;
+  if(tn1 && tn2) return parseInt(tn1) - parseInt(tn2);
+  if(tn2) return -1;
+  return 1;
+}
+
 function compareSelectors(s1, s2) {
   // Dataset selectors comparison is case-insensitive, and puts wildcards
   // last, where * comes later than ?
@@ -492,7 +512,7 @@ function compareSelectors(s1, s2) {
       star2 = s2.indexOf('*');
   if(star1 >= 0) {
     if(star2 < 0) return 1;
-    return s1.localeCompare(s2);
+    return ciCompare(s1, s2);
   }
   if(star2 >= 0) return -1;  
   // Replace ? by | because | has a higher ASCII value than all other chars
@@ -525,7 +545,7 @@ function compareSelectors(s1, s2) {
   while(i >= 0 && s_1[i] === '-') i--;
   // If trailing minuses, replace by as many spaces and add an exclamation point
   if(i < n - 1) {
-    s_1 = s_1.substr(0, i);
+    s_1 = s_1.substring(0, i);
     while(s_1.length < n) s_1 += ' ';
     s_1 += '!';
   }
@@ -534,7 +554,7 @@ function compareSelectors(s1, s2) {
   i = n - 1;
   while(i >= 0 && s_2[i] === '-') i--;
   if(i < n - 1) {
-    s_2 = s_2.substr(0, i);
+    s_2 = s_2.substring(0, i);
     while(s_2.length < n) s_2 += ' ';
     s_2 += '!';
   }
@@ -814,8 +834,9 @@ function stringToFloatArray(s) {
       a = [];
   while(i <= s.length) {
     const
-        h = s.substr(i - 8, 8),
-        r = h.substr(6, 2) + h.substr(4, 2) + h.substr(2, 2) + h.substr(0, 2);
+        h = s.substring(i - 8, i),
+        r = h.substring(6, 2) + h.substring(4, 2) +
+            h.substring(2, 2) + h.substring(0, 2);
     a.push(hexToFloat(r));
     i += 8;
   }
@@ -830,7 +851,7 @@ function hexToBytes(hex) {
   // Converts a hex string to a Uint8Array
   const bytes = [];
   for(let i = 0; i < hex.length; i += 2) {
-    bytes.push(parseInt(hex.substr(i, 2), 16));
+    bytes.push(parseInt(hex.substring(i, i + 2), 16));
   }
   return new Uint8Array(bytes);
 }

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

@@ -713,14 +713,14 @@ class ExpressionParser {
         //  t (current time step, this is the default),
         if('#cfijklnprst'.includes(offs[0].charAt(0))) {
           anchor1 = offs[0].charAt(0);
-          offset1 = safeStrToInt(offs[0].substr(1)); 
+          offset1 = safeStrToInt(offs[0].substring(1)); 
         } else {
           offset1 = safeStrToInt(offs[0]); 
         }
         if(offs.length > 1) {
           if('#cfijklnprst'.includes(offs[1].charAt(0))) {
             anchor2 = offs[1].charAt(0);
-            offset2 = safeStrToInt(offs[1].substr(1));
+            offset2 = safeStrToInt(offs[1].substring(1));
           } else {
             offset2 = safeStrToInt(offs[1]); 
           }
@@ -757,7 +757,7 @@ class ExpressionParser {
           };
         // NOTE: name should then be in the experiment's variable list
         name = s[1].trim();
-        s = s[0].substr(1);
+        s = s[0].substring(1);
         // Check for scaling method
         // NOTE: simply ignore $ unless it indicates a valid method
         const msep = s.indexOf('$');
@@ -967,6 +967,10 @@ class ExpressionParser {
           return false;
         }
       }
+/*
+      // DEPRECATED -- Modeler can deal with this by smartly using AND
+      // clauses like "&x: &y:" to limit set to specific prefixes.
+      
       // Deal with "prefix inheritance" when pattern starts with a colon.
       if(pat.startsWith(':') && this.owner_prefix) {
         // Add a "must start with" AND condition to all OR clauses of the
@@ -979,6 +983,7 @@ class ExpressionParser {
         }
         pat = oc.join('|');
       }
+*/
       // NOTE: For patterns, assume that # *always* denotes the context-
       // sensitive number #, because if modelers wishes to include
       // ANY number, they can make their pattern less selective.
@@ -1449,7 +1454,7 @@ class ExpressionParser {
         this.los = 1;
         this.error = 'Missing closing bracket \']\'';
       } else {
-        v = this.expr.substr(this.pit + 1, i - 1 - this.pit);
+        v = this.expr.substring(this.pit + 1, i);
         this.pit = i + 1;
         // NOTE: Enclosing brackets are also part of this symbol
         this.los = v.length + 2;
@@ -1467,7 +1472,7 @@ class ExpressionParser {
         this.los = 1;
         this.error = 'Unmatched quote';
       } else {
-        v = this.expr.substr(this.pit + 1, i - 1 - this.pit);
+        v = this.expr.substring(this.pit + 1, i);
         this.pit = i + 1;
         // NOTE: Enclosing quotes are also part of this symbol
         this.los = v.length + 2;
@@ -1520,7 +1525,7 @@ class ExpressionParser {
         this.los++;
       }
       // ... but trim spaces from the symbol
-      v = this.expr.substr(this.pit, this.los).trim();
+      v = this.expr.substring(this.pit, this.pit + this.los).trim();
       // Ignore case
       l = v.toLowerCase();
       if(l === '#') {
@@ -2065,6 +2070,16 @@ class VirtualMachine {
       P: this.process_attr,
       Q: this.product_attr
     };
+    this.entity_attribute_names = {};
+    for(let i = 0; i < this.entity_letters.length; i++) {
+      const
+          el = this.entity_letters.charAt(i),
+          ac = this.attribute_codes[el];
+      this.entity_attribute_names[el] = [];
+      for(let j = 0; j < ac.length; j++) {
+        this.entity_attribute_names[el].push(ac[j]);
+      }
+    }
     // Level-based attributes are computed only AFTER optimization
     this.level_based_attr = ['L', 'CP',  'HCP', 'CF', 'CI', 'CO', 'F', 'A'];
     this.object_types = ['Process', 'Product', 'Cluster', 'Link', 'Constraint',
@@ -5929,7 +5944,9 @@ function VMI_push_dataset_modifier(x, args) {
       // NOTE: Use the "local" time step for expression x, i.e., the top
       // value of the expression's time step stack `x.step`.
       tot = twoOffsetTimeStep(x.step[x.step.length - 1],
-          args[1], args[2], args[3], args[4], 1, x);
+          args[1], args[2], args[3], args[4], 1, x),
+      // Record whether either anchor uses the context-sensitive number.
+      hashtag_index = (args[1] === '#' || args[3] === '#');
   // NOTE: Sanity check to facilitate debugging; if no dataset is provided,
   // the script will still break at the LET statement below.
   if(!ds) console.log('ERROR: VMI_push_dataset_modifier without dataset',
@@ -5947,7 +5964,7 @@ function VMI_push_dataset_modifier(x, args) {
       t = t % obj.length;
       if(t < 0) t += obj.length;
     }
-    if(args[1] === '#' || args[3] === '#') {
+    if(hashtag_index) {
       // NOTE: Add 1 because (parent) anchors are 1-based.
       ds.parent_anchor = t + 1;
       if(DEBUGGING) {
@@ -5991,12 +6008,21 @@ function VMI_push_dataset_modifier(x, args) {
     if(t >= 0 && t < obj.length) {
       v = obj[t];
     } else if(ds.array && t >= obj.length) {
-      // Set error value if array index is out of bounds.
-      v = VM.ARRAY_INDEX;
-      VM.out_of_bounds_array = ds.displayName;
-      VM.out_of_bounds_msg = `Index ${VM.sig2Dig(t + 1)} not in array dataset ` +
-          `${ds.displayName}, which has length ${obj.length}`;
-      console.log(VM.out_of_bounds_msg);
+      // Ensure that value of t is human-readable.
+      // NOTE: Add 1 to compensate for earlier t-- to make `t` zero-based.
+      const index = VM.sig2Dig(t + 1);
+      // Special case: index is undefined because # was undefined.
+      if(hashtag_index && index === '\u2047') {
+        // In such cases, return the default value of the dataset.
+        v = ds.default_value;
+      } else {
+        // Set error value to indicate that array index is out of bounds.
+        v = VM.ARRAY_INDEX;
+        VM.out_of_bounds_array = ds.displayName;
+        VM.out_of_bounds_msg = `Index ${index} not in array dataset ` +
+            `${ds.displayName}, which has length ${obj.length}`;
+        console.log(VM.out_of_bounds_msg);
+      }
     }
     // Fall through: no change to `v` => dataset default value is pushed.
   } else {